| blob | 581864f6f46f40f980a914fbb0d7ef24bef18747 |
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.)
239 "Non-nil means protect against I/O errors while saving files.
240 Some modes set this non-nil in particular buffers.
242 This feature works by writing the new contents into a temporary file
243 and then renaming the temporary file to replace the original.
244 In this way, any I/O error in writing leaves the original untouched,
245 and there is never any instant where the file is nonexistent.
247 Note that this feature forces backups to be made by copying.
248 Yet, at the same time, saving a precious file
249 breaks any hard links between it and other files."
254 "Control use of version numbers for backup files.
255 When t, make numeric backup versions unconditionally.
256 When nil, make them for files that have some already.
257 The value `never' means do not make them."
267 "When cleaning directory, number of versions to keep."
273 "If t, delete excess backup versions silently.
274 If nil, ask confirmation. Any other value prevents any trimming."
281 "Number of oldest versions to keep when a new numbered backup is made."
287 "Number of newest versions to keep when a new numbered backup is made.
288 Includes the new backup. Must be > 0"
294 "Whether to add a newline automatically at the end of the file.
296 A value of t means do this only when the file is about to be saved.
297 A value of `visit' means do this right after the file is visited.
298 A value of `visit-save' means do it at both of those times.
299 Any other non-nil value means ask user whether to add a newline, when saving.
300 A value of nil means don't add newlines.
302 Certain major modes set this locally to the value obtained
303 from `mode-require-final-newline'."
312 "Whether to add a newline at end of file, in certain major modes.
313 Those modes set `require-final-newline' to this value when you enable them.
314 They do so because they are often used for files that are supposed
315 to end in newlines, and the question is how to arrange that.
317 A value of t means do this only when the file is about to be saved.
318 A value of `visit' means do this right after the file is visited.
319 A value of `visit-save' means do it at both of those times.
320 Any other non-nil value means ask user whether to add a newline, when saving.
322 A value of nil means do not add newlines. That is a risky choice in this
323 variable since this value is used for modes for files that ought to have
324 final newlines. So if you set this to nil, you must explicitly check and
325 add a final newline, whenever you save a file that really needs one."
335 "Non-nil says by default do auto-saving of every file-visiting buffer."
340 "Non-nil says auto-save a buffer in the file it is visiting, when practical.
341 Normally auto-save files are written under other names."
347 ;; Don't put "\\2" inside expand-file-name, since it will be
348 ;; transformed to "/2" on DOS/Windows.
350 "Transforms to apply to buffer file name before making auto-save file name.
351 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
352 REGEXP is a regular expression to match against the file name.
353 If it matches, `replace-match' is used to replace the
354 matching part with REPLACEMENT.
355 If the optional element UNIQUIFY is non-nil, the auto-save file name is
356 constructed by taking the directory part of the replaced file-name,
357 concatenated with the buffer file name with all directory separators
358 changed to `!' to prevent clashes. This will not work
359 correctly if your filesystem truncates the resulting name.
361 All the transforms in the list are tried, in the order they are listed.
362 When one transform applies, its result is final;
363 no further transforms are tried.
365 The default value is set up to put the auto-save file into the
366 temporary directory (see the variable `temporary-file-directory') for
367 editing a remote file.
369 On MS-DOS filesystems without long names this variable is always
370 ignored."
377 "Non-nil means save word abbrevs too when files are saved.
378 If `silently', don't ask the user before saving."
383 "Non-nil means allow `find-file' to visit directories.
384 To visit the directory, `find-file' runs `find-directory-functions'."
389 "List of functions to try in sequence to visit a directory.
390 Each function is called with the directory name as the sole argument
391 and should return either a buffer or nil."
395 ;;;It is not useful to make this a local variable.
396 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
398 "List of functions to be called for `find-file' on nonexistent file.
399 These functions are called as soon as the error is detected.
400 Variable `buffer-file-name' is already set up.
405 ;;;It is not useful to make this a local variable.
406 ;;;(put 'find-file-hooks 'permanent-local t)
408 "List of functions to be called after a buffer is loaded from a file.
409 The buffer's local variables (if any) will have been processed before the
410 functions are called."
418 "List of functions to be called before writing out a buffer to a file.
419 If one of them returns non-nil, the file is considered already written
420 and the rest are not called.
421 These hooks are considered to pertain to the visited file.
422 So any buffer-local binding of this variable is discarded if you change
424 change the major mode.
426 This hook is not run if any of the functions in
427 `write-contents-functions' returns non-nil. Both hooks pertain
428 to how to save a buffer to file, for instance, choosing a suitable
429 coding system and setting mode bits. (See Info
430 node `(elisp)Saving Buffers'.) To perform various checks or
441 "List of functions to be called before writing out a buffer to a file.
442 If one of them returns non-nil, the file is considered already written
443 and the rest are not called and neither are the functions in
444 `write-file-functions'.
446 This variable is meant to be used for hooks that pertain to the
447 buffer's contents, not to the particular visited file; thus,
448 `set-visited-file-name' does not clear this variable; but changing the
449 major mode does clear it.
451 For hooks that _do_ pertain to the particular visited file, use
452 `write-file-functions'. Both this variable and
453 `write-file-functions' relate to how a buffer is saved to file.
454 To perform various checks or updates before the buffer is saved,
461 "Control use of local variables in files you visit.
462 The value can be t, nil, :safe, :all, or something else.
464 A value of t means file local variables specifications are obeyed
465 if all the specified variable values are safe; if any values are
466 not safe, Emacs queries you, once, whether to set them all.
467 \(When you say yes to certain values, they are remembered as safe.)
469 :safe means set the safe variables, and ignore the rest.
470 :all means set all variables, whether safe or not.
471 (Don't set it permanently to :all.)
472 A value of nil means always ignore the file local variables.
474 Any other value means always query you once whether to set them all.
475 \(When you say yes to certain values, they are remembered as safe, but
478 This variable also controls use of major modes specified in
479 a -*- line.
482 always obeys file local variable specifications and the -*- line,
483 and ignores this variable."
492 "Like `enable-local-variables' but meant for buffer-local bindings.
493 The meaningful values are nil and non-nil. The default is non-nil.
494 If a major mode sets this to nil, buffer-locally, then any local
495 variables list in the file will be ignored.
497 This variable does not affect the use of major modes
502 The value can be t, nil or something else.
503 A value of t means obey `eval' variables;
504 A value of nil means ignore them; anything else means query."
510 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
519 "Non-nil means buffers visiting files read-only do so in view mode.
520 In fact, this means that all read-only buffers normally have
521 View mode enabled, including buffers that are read-only because
522 you visit a file you cannot alter, and buffers you make read-only
529 \f
532 "Provides support for ange-ftp host name completion.
533 Runs the usual ange-ftp hook, but only for completion operations."
534 ;; Having this here avoids the need to load ange-ftp when it's not
535 ;; really in use.
541 inhibit-file-name-handlers)))
546 "Convert a standard file's name to something suitable for the OS.
547 This means to guarantee valid names and perhaps to canonicalize
548 certain patterns.
550 FILENAME should be an absolute file name since the conversion rules
551 sometimes vary depending on the position in the file name. E.g. c:/foo
552 is a valid DOS file name, but c:/bar/c:/foo is not.
554 This function's standard definition is trivial; it just returns
555 the argument. However, on Windows and DOS, replace invalid
556 characters. On DOS, make sure to obey the 8.3 limitations.
557 In the native Windows build, turn Cygwin names into native names,
558 and also turn slashes into backslashes if the shell requires it (see
559 `w32-shell-dos-semantics').
561 See Info node `(elisp)Standard File Names' for more details."
565 ;; Replace invalid filename characters with !
569 name)
570 filename))
573 "Read directory name, prompting with PROMPT and completing in directory DIR.
574 Value is not expanded---you must call `expand-file-name' yourself.
575 Default name to DEFAULT-DIRNAME if user exits with the same
576 non-empty string that was inserted by this function.
577 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
578 or just DIR if INITIAL is nil.)
579 If the user exits with an empty minibuffer, this function returns
580 an empty string. (This can only happen if the user erased the
581 pre-inserted contents or if `insert-default-directory' is nil.)
582 Fourth arg MUSTMATCH non-nil means require existing directory's name.
583 Non-nil and non-t means also require confirmation after completion.
584 Fifth arg INITIAL specifies text to start with.
585 DIR should be an absolute directory name. It defaults to
586 the value of `default-directory'."
591 dir))
592 mustmatch initial
595 \f
597 "Show the current default directory."
602 "Value of the CDPATH environment variable, as a list.
606 "Explode a search path into a list of directory names.
607 Directories are separated by occurrences of `path-separator'
608 \(which is colon in GNU and GNU-like systems)."
609 ;; We could use split-string here.
617 nil
622 cd-list)))
625 "Change current directory to given absolute file name DIR."
626 ;; Put the name into directory syntax now,
627 ;; because otherwise expand-file-name may give some bad results.
640 "Make DIR become the current buffer's default directory.
641 If your environment includes a `CDPATH' variable, try each one of
642 that list of directories (separated by occurrences of
643 `path-separator') when resolving a relative directory name.
644 The path separator is colon in GNU and GNU-like systems."
647 default-directory default-directory
663 cd-path)
664 nil))
668 "Load the Lisp file named FILE."
669 ;; This is a case where .elc makes a lot of sense.
676 "Search for FILENAME through PATH.
677 If found, return the absolute file name of FILENAME, with its suffixes;
678 otherwise return nil.
679 PATH should be a list of directories to look in, like the lists in
680 `exec-path' or `load-path'.
681 If SUFFIXES is non-nil, it should be a list of suffixes to append to
684 If non-nil, PREDICATE is used instead of `file-readable-p'.
685 PREDICATE can also be an integer to pass to the `access' system call,
686 in which case file-name handlers are ignored. This usage is deprecated.
688 For compatibility, PREDICATE can also be one of the symbols
689 `executable', `readable', `writable', or `exists', or a list of
690 one or more of those symbols."
701 "Do completion for file names passed to `locate-file'.
702 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
725 "Look up the directory hierarchy from FILE for a file matching REGEXP."
730 ;; Abbreviate, so as to stop when we cross ~/.
732 files)
733 ;; As a heuristic, we stop looking up the hierarchy of directories as
734 ;; soon as we find a directory belonging to another user. This should
735 ;; save us from looking in things like /net and /afs. This assumes
736 ;; that all the files inside a project belong to the same user.
744 nil)))
747 "Search for COMMAND in `exec-path' and return the absolute file name.
748 Return nil if COMMAND is not found anywhere in `exec-path'."
749 ;; Use 1 rather than file-executable-p to better match the behavior of
750 ;; call-process.
754 "Load the library named LIBRARY.
755 This is an interface to the function `load'."
758 'locate-file-completion
763 "Test whether FILE specifies a location on a remote system.
764 Return an identification of the system if the location is indeed
765 remote. The identification of the system may comprise a method
766 to access the system and its hostname, amongst other things.
771 IDENTIFICATION specifies which part of the identification shall
772 be returned as string. IDENTIFICATION can be the symbol
773 `method', `user' or `host'; any other value is handled like nil
774 and means to return the complete identification string.
776 If CONNECTED is non-nil, the function returns an identification only
777 if FILE is located on a remote system, and a connection is established
778 to that remote system.
780 `file-remote-p' will never open a connection on its own."
784 nil)))
787 "Copy the file FILE into a temporary file on this machine.
788 Returns the name of the local copy, or nil, if FILE is directly
789 accessible."
790 ;; This formerly had an optional BUFFER argument that wasn't used by
791 ;; anything.
795 nil)))
798 "Return the truename of FILENAME, which should be absolute.
799 The truename of a file name is found by chasing symbolic links
800 both at the level of the file and at the level of the directories
801 containing it, until no links are left at any level.
804 ;; COUNTER and PREV-DIRS are only used in recursive calls.
805 ;; COUNTER can be a cons cell whose car is the count of how many
806 ;; more links to chase before getting an error.
807 ;; PREV-DIRS can be a cons cell whose car is an alist
808 ;; of truenames we've just recently computed.
822 ;; For speed, remove the ange-ftp completion handler from the list.
823 ;; We know it's not needed here.
824 ;; For even more speed, do this only on the outermost call.
831 ;; andrewi@harlequin.co.uk - none of the following code (except for
832 ;; invoking the file-name handler) currently applies on Windows
833 ;; (ie. there are no native symlinks), but there is an issue with
834 ;; case differences being ignored by the OS, and short "8.3 DOS"
835 ;; name aliases existing for all files. (The short names are not
836 ;; reported by directory-files, but can be used to refer to files.)
837 ;; It seems appropriate for file-truename to resolve these issues in
838 ;; the most natural way, which on Windows is to call the function
839 ;; `w32-long-file-name' - this returns the exact name of a file as
840 ;; it is stored on disk (expanding short name aliases with the full
841 ;; name in the process).
844 ;; For file name that has a special handler, call handler.
845 ;; This is so that ange-ftp can save time by doing a no-op.
848 ;; If filename contains a wildcard, newname will be the old name.
850 ;; If filename exists, use the long name
854 ;; If this file directly leads to a link, process that iteratively
855 ;; so that we don't use lots of stack.
861 ;; For file name that has a special handler, call handler.
862 ;; This is so that ange-ftp can save time by doing a no-op.
865 done t)
867 target dirfile)
868 ;; Get the truename of the directory.
870 ;; If these are equal, we have the (or a) root directory.
872 ;; If this is the same dir we last got the truename for,
873 ;; save time--don't recalculate.
883 done t)
886 done t)
887 ;; Put it back on the file name.
889 ;; Is the file name the name of a link?
892 ;; Yes => chase that link, then start all over
893 ;; since the link may point to a directory name that uses links.
894 ;; We can't safely use expand-file-name here
895 ;; since target might look like foo/../bar where foo
896 ;; is itself a link. Instead, we handle . and .. above.
899 target
901 done nil)
902 ;; No, we are done!
904 filename))
907 "Chase links in FILENAME until a name that is not a link.
908 Unlike `file-truename', this does not check whether a parent
909 directory name is a symbolic link.
910 If the optional argument LIMIT is a number,
911 it means chase no more than that many links and then stop."
919 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
922 ;; Handle `..' by hand, since it needs to work in the
923 ;; target of any directory symlink.
924 ;; This code is not quite complete; it does not handle
925 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
929 ;; Chase links in the default dir of the symlink.
933 ;; Now find the parent of that dir.
937 newname))
940 "Create a temporary file.
941 The returned file name (created by appending some random characters at the end
942 of PREFIX, and expanding against `temporary-file-directory' if necessary),
943 is guaranteed to point to a newly created empty file.
944 You can then use `write-region' to write new data into the file.
946 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
948 If SUFFIX is non-nil, add that at the end of the file name."
950 file)
953 ;; Create temp files with strict access rights. It's easy to
954 ;; loosen them later, whereas it's impossible to close the
955 ;; time-window of loose permissions otherwise.
967 nil)
969 ;; the file was somehow created by someone else between
970 ;; `make-temp-name' and `write-region', let's try again.
971 nil)
972 file)
973 ;; Reset the umask.
977 "Change the encoding of FILE's name from CODING to NEW-CODING.
978 The value is a new name of FILE.
979 Signals a `file-already-exists' error if a file of the new name
980 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
981 is non-nil. A number as fourth arg means request confirmation if
982 the new name already exists. This is what happens in interactive
983 use with M-x."
986 default-file-name-coding-system))
988 from-coding to-coding)
990 ;; We provide the default coding only when it seems that
991 ;; the filename is correctly decoded by the default
992 ;; coding.
998 filename default-coding)
999 default-coding))
1003 ;; We provide the default coding only when a user is going to
1004 ;; change the encoding not from the default coding.
1008 filename from-coding)))
1011 filename from-coding default-coding)
1012 default-coding)))
1016 default-file-name-coding-system))
1017 ;; FILE should have been decoded by DEFAULT-CODING.
1021 ;; Suppress further encoding.
1026 newname))
1027 \f
1029 "Select buffer BUFFER in another window.
1030 If BUFFER does not identify an existing buffer, then this function
1031 creates a buffer with that name.
1033 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
1034 or nil. If BUFFER is nil, then this function chooses a buffer
1035 using `other-buffer'.
1036 Optional second arg NORECORD non-nil means
1037 do not put this buffer at the front of the list of recently selected ones.
1038 This function returns the buffer it switched to.
1040 This uses the function `display-buffer' as a subroutine; see its
1041 documentation for additional customization information."
1044 ;; Don't let these interfere.
1045 same-window-buffer-names same-window-regexps)
1049 "Switch to buffer BUFFER in another frame.
1050 Optional second arg NORECORD non-nil means
1051 do not put this buffer at the front of the list of recently selected ones.
1053 This uses the function `display-buffer' as a subroutine; see its
1054 documentation for additional customization information."
1057 same-window-buffer-names same-window-regexps)
1062 "Switch to buffer BUFFER in another frame.
1063 This uses the function `display-buffer' as a subroutine; see its
1064 documentation for additional customization information."
1067 same-window-buffer-names same-window-regexps
1069 new-window)
1079 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1080 BODY should use the minibuffer at most once.
1081 Recursive uses of the minibuffer will not be affected."
1087 ;; Clear out this hook so it does not interfere
1088 ;; with any recursive minibuffer usage.
1098 "If non-nil, `find-file' requires confirmation before visiting a new file."
1110 t))
1113 "Edit file FILENAME.
1114 Switch to a buffer visiting file FILENAME,
1115 creating one if none already exists.
1116 Interactively, the default if you just type RET is the current directory,
1117 but the visited file name is available through the minibuffer history:
1118 type M-n to pull it into the minibuffer.
1120 You can visit files on remote machines by specifying something
1121 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1122 also visit local files as a different user by specifying
1123 /sudo::FILE for the file name.
1124 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1125 manual, for more about this.
1127 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1128 expand wildcards (if any) and visit multiple files. You can
1129 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1131 To visit a file without any kind of conversion and without
1142 "Edit file FILENAME, in another window.
1145 an existing one. See the function `display-buffer'.
1147 Interactively, the default if you just type RET is the current directory,
1148 but the visited file name is available through the minibuffer history:
1149 type M-n to pull it into the minibuffer.
1151 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1152 expand wildcards (if any) and visit multiple files."
1165 "Edit file FILENAME, in another frame.
1168 an existing one. See the function `display-buffer'.
1170 Interactively, the default if you just type RET is the current directory,
1171 but the visited file name is available through the minibuffer history:
1172 type M-n to pull it into the minibuffer.
1174 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1175 expand wildcards (if any) and visit multiple files."
1188 "Edit the existing file FILENAME.
1190 file names with wildcards."
1198 "Edit file FILENAME but don't allow changes.
1212 value))
1215 "Edit file FILENAME in another window but don't allow changes.
1229 value))
1232 "Edit file FILENAME in another frame but don't allow changes.
1246 value))
1249 "Find file FILENAME as a replacement for the file in the next window.
1250 This command does not select that window.
1254 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1255 expand wildcards (if any) and replace the file with multiple files."
1267 t))))
1275 "Find file FILENAME, select its buffer, kill previous buffer.
1276 If the current buffer now contains an empty file that you just visited
1277 \(presumably by mistake), use this command to visit the file you really want.
1281 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1282 expand wildcards (if any) and replace the file with multiple files.
1284 If the current buffer is an indirect buffer, or the base buffer
1285 for one or more indirect buffers, the other buffer(s) are not
1286 killed."
1296 t)))
1317 ;; This prevents us from finding the same buffer
1318 ;; if we specified the same file again.
1322 ;; Likewise for dired buffers.
1326 ;; This executes if find-file gets an error
1327 ;; and does not really find anything.
1328 ;; We put things back as they were.
1329 ;; If find-file actually finds something, we kill obuf below.
1338 ;; We already asked; don't ask again.
1341 \f
1343 "Create a suitably named buffer for visiting FILENAME, and return it.
1344 FILENAME (sans directory) is used unchanged if that name is free;
1345 otherwise a string <2> or <3> or ... is appended to get an unused name.
1346 Spaces at the start of FILENAME (sans directory) are removed."
1355 "Create and return a buffer with a name based on NAME.
1356 Choose the buffer's name using `generate-new-buffer-name'."
1360 "Regexp to match the automounter prefix in a directory name."
1368 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1370 home directory is a root directory) and removes automounter prefixes
1371 \(see the variable `automount-dir-prefix')."
1372 ;; Get rid of the prefixes added by the automounter.
1380 ;; If any elt of directory-abbrev-alist matches this name,
1381 ;; abbreviate accordingly.
1387 ;; Compute and save the abbreviated homedir name.
1388 ;; We defer computing this until the first time it's needed, to
1389 ;; give time for directory-abbrev-alist to be set properly.
1390 ;; We include a slash at the end, to avoid spurious matches
1391 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1398 ;; If FILENAME starts with the abbreviated homedir,
1399 ;; make it start with `~' instead.
1401 ;; If the home dir is just /, don't change it.
1404 ;; MS-DOS root directories can come with a drive letter;
1405 ;; Novell Netware allows drive letters beyond `Z:'.
1415 filename)))
1418 "List of logical names for which visiting shouldn't save the true dirname.
1419 On VMS, when you visit a file using a logical name that searches a path,
1420 you may or may not want the visited file name to record the specific
1421 directory where the file was found. If you *do not* want that, add the logical
1422 name to this list as a string."
1427 "Return the buffer visiting file FILENAME (a string).
1428 This is like `get-file-buffer', except that it checks for any buffer
1429 visiting the same file, possibly under a different name.
1430 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1431 and others are ignored.
1432 If there is no such live buffer, return nil."
1446 found)
1456 ;; Verify this buffer's file number
1457 ;; still belongs to its file.
1460 attributes)
1464 found))))
1465 \f
1467 "Non-nil means file-visiting commands should handle wildcards.
1468 For example, if you specify `*.c', that would visit all the files
1469 whose names match the pattern."
1475 "Non-nil means suppress warning messages for symlinked files.
1476 When nil, Emacs prints a warning when visiting a file that is already
1477 visited, but with a different name. Setting this option to t
1478 suppresses this warning."
1484 "Maximum size of file above which a confirmation is requested.
1485 When nil, never request confirmation."
1492 "Read file FILENAME into a buffer and return the buffer.
1493 If a buffer exists visiting FILENAME, return that one, but
1494 verify that the file has not changed since visited or saved.
1495 The buffer is not selected, just returned to the caller.
1496 Optional second arg NOWARN non-nil means suppress any warning messages.
1497 Optional third arg RAWFILE non-nil means the file is read literally.
1498 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1499 and visit all the matching files. When wildcards are actually
1500 used and expanded, return a list of buffers that are visiting
1501 the various files."
1508 'find-directory-functions
1511 filename)))
1514 find-file-wildcards
1528 ;; Find any buffer for a file which has same truename.
1530 ;; Let user know if there is a buffer with the same truename.
1534 find-file-suppress-same-file-warnings
1538 ;; Optionally also find that buffer.
1541 ;; Check to see if the file looks uncommonly large.
1543 ;; Don't ask again if we already have the file or
1544 ;; if we're asked to be quiet.
1553 ;; We are using an existing buffer.
1560 ;; Certain files should be reverted automatically
1561 ;; if they have changed on disk and not in the buffer.
1569 found))
1579 "File %s changed on disk. Discard your edits? "
1584 "File %s changed on disk. Discard your edits in %s? "
1592 ;; Check if a formerly read-only file has become
1593 ;; writable and vice versa, but if the buffer agrees
1594 ;; with the new state of the file, that is ok too.
1602 buffer-file-name
1611 ;; It is confusing to ask whether to visit
1612 ;; non-literally if they have the file in
1613 ;; hexl-mode.
1619 "The file %s is already visited normally,
1620 and you have edited the buffer. Now you have asked to visit it literally,
1621 meaning no coding system handling, format conversion, or local variables.
1622 Emacs can only visit a file in one way at a time.
1624 Do you want to save the file, and visit it literally instead? "
1625 "The file %s is already visited literally,
1626 meaning no coding system handling, format conversion, or local variables.
1627 You have edited the buffer. Now you have asked to visit the file normally,
1628 but Emacs can only visit a file in one way at a time.
1635 rawfile truename number))
1639 "\
1640 Do you want to discard your changes, and visit the file literally now? "
1641 "\
1644 rawfile truename number)
1650 "The file %s is already visited normally.
1651 You have asked to visit it literally,
1652 meaning no coding system decoding, format conversion, or local variables.
1653 But Emacs can only visit a file in one way at a time.
1655 Do you want to revisit the file literally now? "
1656 "The file %s is already visited literally,
1657 meaning no coding system decoding, format conversion, or local variables.
1658 You have asked to visit it normally,
1659 but Emacs can only visit a file in one way at a time.
1664 rawfile truename number)
1667 ;; Return the buffer we are using.
1668 buf)
1669 ;; Create a new buffer.
1671 ;; find-file-noselect-1 may use a different buffer.
1673 rawfile truename number))))))
1679 ;; Needed in case we are re-visiting the file with a different
1680 ;; text representation.
1697 filename)))
1698 ;; Unconditionally set error
1708 filename)))
1709 ;; Run find-file-not-found-functions until one returns non-nil.
1711 ;; If they fail too, set error.
1713 ;; Record the file's truename, and maybe use that as visited name.
1719 ;; On VMS, we may want to remember which directory in a search list
1720 ;; the file was found in.
1730 ;; Set buffer's default directory to that of the file.
1732 ;; Turn off backup files for certain file names. Since
1733 ;; this is a permanent local, the major mode won't eliminate it.
1748 \f
1750 "Like `insert-file-contents', but only reads in the file literally.
1751 A buffer may be modified in several ways after reading into the buffer,
1752 to Emacs features such as format decoding, character code
1753 conversion, `find-file-hook', automatic uncompression, etc.
1755 This function ensures that none of these modifications will take place."
1763 nil))
1766 inhibit-file-name-handlers))
1779 filename)))
1789 "Insert contents of file FILENAME into buffer after point with no conversion.
1791 This function is meant for the user to run interactively.
1792 Don't call it from programs! Use `insert-file-contents-literally' instead.
1793 \(Its calling sequence is different; see its documentation)."
1798 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1803 "Visit file FILENAME with no conversion of any kind.
1804 Format conversion and character code conversion are both disabled,
1805 and multibyte characters are disabled in the resulting buffer.
1806 The major mode used is Fundamental mode regardless of the file name,
1807 and local variable specifications in the file are ignored.
1808 Automatic uncompression and adding a newline at the end of the
1809 file due to `require-final-newline' is also disabled.
1811 You cannot absolutely rely on this function to result in
1812 visiting the file literally. If Emacs already has a buffer
1813 which is visiting the file, you get the existing buffer,
1814 regardless of whether it was created literally or not.
1816 In a Lisp program, if you want to be sure of accessing a file's
1817 contents literally, you should create a temporary buffer and then read
1818 the file contents into it using `insert-file-contents-literally'."
1821 \f
1825 after-find-file-from-revert-buffer
1826 nomodes)
1827 "Called after finding a file and by the default revert function.
1828 Sets buffer mode, parses local variables.
1829 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1830 error in reading the file. WARN non-nil means warn if there
1831 exists an auto-save file more recent than the visited file.
1832 NOAUTO means don't mess with auto-save mode.
1833 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1834 means this call was from `revert-buffer'.
1835 Fifth arg NOMODES non-nil means don't alter the file's modes.
1836 Finishes by calling the functions in `find-file-hook'
1837 unless NOMODES is non-nil."
1840 nil
1850 ;; No need to warn if buffer is auto-saved
1851 ;; under the name of the visited file.
1853 auto-save-visited-file-name))
1856 buffer-file-name))
1876 ;; Make people do a little extra work (C-x C-q)
1877 ;; before altering a backup file.
1880 ;; When a file is marked read-only,
1881 ;; make the buffer read-only even if root is looking at it.
1889 ;; If requested, add a newline at the end of the file.
1899 view-read-only
1905 "Eval BODY and turn any error into a FORMAT message.
1906 FORMAT can have a %s escape which will be replaced with the actual error.
1907 If `debug-on-error' is set, errors are not caught, so that you can
1908 debug them.
1909 Avoid using a large BODY since it is duplicated."
1918 "Choose the major mode for this buffer automatically.
1919 Also sets up any specified local variables of the file.
1920 Uses the visited file name, the -*- line, and the local variables spec.
1922 This function is called automatically from `find-file'. In that case,
1923 we may set up the file-specified mode and local variables,
1924 depending on the value of `enable-local-variables'.
1925 In addition, if `local-enable-local-variables' is nil, we do
1926 not set local variables (though we do notice a mode specified with -*-.)
1928 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1929 or from Lisp without specifying the optional argument FIND-FILE;
1930 in that case, this function acts as if `enable-local-variables' were t."
1938 ;; Turn font lock off and on, to make sure it takes account of
1939 ;; whatever file local variables are relevant to it.
1941 ;; Font-lock-mode (now in font-core.el) can be ON when
1942 ;; font-lock.el still hasn't been loaded.
1952 "Non-nil means to try second pass through `auto-mode-alist'.
1953 This means that if the first case-sensitive search through the alist fails
1954 to find a matching major mode, a second case-insensitive search is made.
1955 On systems with case-insensitive file names, this variable is ignored,
1956 since only a single case-insensitive search through the alist is made."
1962 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1963 ;; c++-mode, java-mode and more) are added through autoload
1964 ;; directives in that file. That way is discouraged since it
1965 ;; spreads out the definition of the initial value.
1998 ;; Less common extensions come here
1999 ;; so more common ones above are found faster.
2038 ;; The list of archive file extensions should be in sync with
2039 ;; `auto-coding-alist' with `no-conversion' coding system.
2044 ;; Mailer puts message to be edited in
2045 ;; /tmp/Re.... or Message
2049 ;; some news reader is reported to use this
2059 ;; .emacs or .gnus or .viper following a directory delimiter in
2060 ;; Unix, MSDOG or VMS syntax.
2063 ;; _emacs following a directory delimiter
2064 ;; in MsDos syntax
2068 ;; Common Lisp ASDF package system.
2086 ;; Windows candidates may be opened case sensitively on Unix
2092 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2094 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2095 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2096 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2097 ;; this has lower priority to avoid matching changelog.sgml etc.
2099 ;; either user's dot-files or under /etc or some such
2101 ;; alas not all ~/.*rc files are like this
2102 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2107 ;; this contains everything twice, with space and with colon :-(
2109 ;; Get rid of any trailing .n.m and try again.
2110 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2111 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2112 ;; Using mode nil rather than `ignore' would let the search continue
2113 ;; through this list (with the shortened name) rather than start over.
2115 ;; The following should come after the ChangeLog pattern
2116 ;; for the sake of ChangeLog.1, etc.
2117 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2120 "Alist of filename patterns vs corresponding major mode functions.
2121 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2122 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2123 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2124 mode function to use. FUNCTION will be called, unless it is nil.
2126 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2127 calling FUNCTION (if it's not nil), we delete the suffix that matched
2128 REGEXP and search the list again for another match.
2130 If the file name matches `inhibit-first-line-modes-regexps',
2131 then `auto-mode-alist' is not processed.
2133 The extensions whose FUNCTION is `archive-mode' should also
2134 appear in `auto-coding-alist' with `no-conversion' coding system.
2136 See also `interpreter-mode-alist', which detects executable script modes
2137 based on the interpreters they specify to run,
2141 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2142 ;; and pike-mode) are added through autoload directives in that
2143 ;; file. That way is discouraged since it spreads out the
2144 ;; definition of the initial value.
2182 "Alist mapping interpreter names to major modes.
2183 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2184 Each element looks like (INTERPRETER . MODE).
2185 If INTERPRETER matches the name of the interpreter specified in the first line
2186 of a script, mode MODE is enabled.
2194 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2195 When checking `inhibit-first-line-modes-regexps', we first discard
2201 "Regexp matching interpreters, for file mode determination.
2202 This regular expression is matched against the first line of a file
2203 to determine the file's mode in `set-auto-mode'. If it matches, the file
2204 is assumed to be interpreted by the interpreter matched by the second group
2205 of the regular expression. The mode is then determined as the mode
2209 "Alist of buffer beginnings vs. corresponding major mode functions.
2210 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2211 After visiting a file, if REGEXP matches the text at the beginning of the
2212 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2213 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2214 major mode.
2216 If FUNCTION is nil, then it is not called. (That is a way of saying
2222 ;; The < comes before the groups (but the first) to reduce backtracking.
2223 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2224 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2228 comment-re "*"
2231 . html-mode)
2233 ;; These two must come after html, because they are more general:
2238 . sgml-mode)
2241 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2242 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2243 After visiting a file, if REGEXP matches the text at the beginning of the
2244 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2245 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2246 have not specified a mode for this file.
2252 "Upper limit on `magic-mode-alist' regexp matches.
2256 "Select major mode appropriate for current buffer.
2258 To find the right major mode, this function checks for a -*- mode tag,
2259 checks if it uses an interpreter listed in `interpreter-mode-alist',
2260 matches the buffer beginning against `magic-mode-alist',
2261 compares the filename against the entries in `auto-mode-alist',
2262 then matches the buffer beginning against `magic-fallback-mode-alist'.
2264 It does not check for the `mode:' local variable in the
2265 Local Variables section of the file; for that, use `hack-local-variables'.
2267 If `enable-local-variables' is nil, this function does not check for a
2268 -*- mode tag.
2270 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2271 set the major mode only if that would change it. In other words
2272 we don't actually set it to the same mode the buffer already has."
2273 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2275 ;; Find a -*- mode tag
2282 ;; Find all specifications for the `mode:' variable
2283 ;; and execute them left to right.
2295 modes)))
2296 ;; Simple -*-MODE-*- case.
2299 modes))))
2300 ;; If we found modes to use, invoke them now, outside the save-excursion.
2308 ;; continuing would call minor modes again, toggling them off
2310 ;; If we didn't, look for an interpreter specified in the first line.
2311 ;; As a special case, allow for things like "#!/bin/env perl", which
2312 ;; finds the interpreter anywhere in $PATH.
2319 ;; Map interpreter name to a mode, signalling we're done at the
2320 ;; same time.
2322 interpreter-mode-alist))
2323 ;; If we found an interpreter mode to use, invoke it now.
2326 ;; Next try matching the buffer beginning against magic-mode-alist.
2340 ;; Next compare the filename against the entries in auto-mode-alist.
2345 ;; Remove remote file name identification.
2349 ;; Remove backup-suffixes from file name.
2352 ;; Find first matching alist entry.
2355 ;; System is case-insensitive.
2359 ;; System is case-sensitive.
2361 ;; First match case-sensitively.
2365 ;; Fallback to case-insensitive match.
2379 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2394 ;; When `keep-mode-if-same' is set, we are working on behalf of
2395 ;; set-visited-file-name. In that case, if the major mode specified is the
2396 ;; same one we already have, don't actually reset it. We don't want to lose
2397 ;; minor modes such as Font Lock.
2399 "Apply MODE and return it.
2400 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2401 any aliases and compared to current major mode. If they are the
2402 same, do nothing and return nil."
2408 mode)))
2411 "Find the -*- spec in the buffer.
2412 Call with point at the place to start searching from.
2413 If one is found, set point to the beginning
2414 and return the position of the end.
2415 Otherwise, return nil; point may be changed."
2418 ;; Don't look for -*- if this file name matches any
2419 ;; of the regexps in inhibit-first-line-modes-regexps.
2427 sufs)
2435 ;; If the file begins with "#!"
2436 ;; (exec interpreter magic), look
2437 ;; for mode frobs in the first two
2438 ;; lines. You cannot necessarily
2439 ;; put them in the first line of
2440 ;; such a file without screwing up
2441 ;; the interpreter invocation.
2442 ;; The same holds for
2443 ;; '\"
2444 ;; in man pages (preprocessor
2445 ;; magic for the `man' program).
2456 end))))
2457 \f
2458 ;;; Handling file local variables
2465 "Normal hook run after processing a file's local variables specs.
2466 Major modes can use this to examine user-specified local variables
2470 "List variable-value pairs that are considered safe.
2471 Each element is a cons cell (VAR . VAL), where VAR is a variable
2472 symbol and VAL is a value that is considered safe."
2477 "Expressions that are considered safe in an `eval:' local variable.
2478 Add expressions to this list if you want Emacs to evaluate them, when
2479 they appear in an `eval' local variable specification, without first
2480 asking you for confirmation."
2485 ;; Risky local variables:
2488 auto-mode-alist
2489 buffer-auto-save-file-name
2490 buffer-file-name
2491 buffer-file-truename
2492 buffer-undo-list
2493 dabbrev-case-fold-search
2494 dabbrev-case-replace
2495 debugger
2496 default-text-properties
2497 display-time-string
2498 enable-local-eval
2499 enable-local-variables
2500 eval
2501 exec-directory
2502 exec-path
2503 file-name-handler-alist
2504 font-lock-defaults
2505 format-alist
2506 frame-title-format
2507 global-mode-string
2508 header-line-format
2509 icon-title-format
2510 ignored-local-variables
2511 imenu--index-alist
2512 imenu-generic-expression
2513 inhibit-quit
2514 input-method-alist
2515 load-path
2516 max-lisp-eval-depth
2517 max-specpdl-size
2518 minor-mode-alist
2519 minor-mode-map-alist
2520 minor-mode-overriding-map-alist
2521 mode-line-buffer-identification
2522 mode-line-format
2523 mode-line-client
2524 mode-line-modes
2525 mode-line-modified
2526 mode-line-mule-info
2527 mode-line-position
2528 mode-line-process
2529 mode-line-remote
2530 mode-name
2531 outline-level
2532 overriding-local-map
2533 overriding-terminal-local-map
2534 parse-time-rules
2535 process-environment
2536 rmail-output-file-alist
2537 safe-local-variable-values
2538 safe-local-eval-forms
2539 save-some-buffers-action-alist
2540 special-display-buffer-names
2541 standard-input
2542 standard-output
2543 unread-command-events
2544 vc-mode))
2546 ;; Safe local variables:
2547 ;;
2548 ;; For variables defined by major modes, the safety declarations can go into
2549 ;; the major mode's file, since that will be loaded before file variables are
2550 ;; processed.
2551 ;;
2552 ;; For variables defined by minor modes, put the safety declarations in the
2553 ;; file defining the minor mode after the defcustom/defvar using an autoload
2554 ;; cookie, e.g.:
2555 ;;
2556 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2557 ;;
2558 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2559 ;; minor mode file may not be loaded yet.
2560 ;;
2561 ;; For variables defined in the C source code the declaration should go here:
2577 "Get confirmation before setting up local variable values.
2578 ALL-VARS is the list of all variables to be set up.
2579 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2580 RISKY-VARS is the list of those that are marked as risky."
2582 nil
2587 prompt char)
2597 ", and variables that are risky (**)."
2604 y -- to apply the local variables list.
2608 ! -- to apply the local variables list, and permanently mark these
2620 ;; Make strings with embedded whitespace easier to read.
2628 ""
2635 done)
2644 ;; read-event returns -1 if we are in a kbd
2645 ;; macro and there are no more events in the
2646 ;; macro. In that case, attempt to get an
2647 ;; event interactively.
2655 ;; When this is called from desktop-restore-file-buffer,
2656 ;; coding-system-for-read may be non-nil. Reset it before
2657 ;; writing to .emacs.
2661 'safe-local-variable-values
2662 safe-local-variable-values))))
2669 "Return local variables specified in the -*- line.
2670 Ignore any specification for `mode:' and `coding:';
2671 `set-auto-mode' should already have handled `mode:',
2672 `set-auto-coding' should already have handled `coding:'.
2674 If MODE-ONLY is non-nil, all we do is check whether the major
2675 mode is specified, returning t if it is specified. Otherwise,
2676 return an alist of elements (VAR . VAL), where VAR is a variable
2677 and VAL is the specified value."
2681 result mode-specified)
2682 ;; Parse the -*- line into the RESULT alist.
2683 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2685 nil)
2687 ;; Simple form: "-*- MODENAME -*-". Already handled.
2689 nil)
2691 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2692 ;; (last ";" is optional).
2697 ;; There used to be a downcase here,
2698 ;; but the manual didn't say so,
2699 ;; and people want to set var names that aren't all lc.
2704 ;; It is traditional to ignore
2705 ;; case when checking for `mode' in set-auto-mode,
2706 ;; so we must do that here as well.
2707 ;; That is inconsistent, but we're stuck with it.
2708 ;; The same can be said for `coding' in set-auto-coding.
2714 'eval
2721 mode-specified
2722 result))))
2725 "Parse and put into effect this buffer's local variables spec.
2726 If MODE-ONLY is non-nil, all we do is check whether the major mode
2727 is specified, returning t if it is specified."
2730 result)
2733 ;; Look for "Local variables:" line in last page.
2741 ;; suffix is what comes after "local variables:" in its line.
2742 ;; prefix is what comes before "local variables:" in its line.
2752 beg)
2756 endpos
2762 nil t))
2772 ;; Discard the prefix.
2777 ;; Discard the suffix.
2785 ;; Find the variable name; strip whitespace.
2793 val)
2794 ;; Read the variable value.
2804 'eval
2810 ;; We've read all the local variables. Now, return whether the
2811 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2812 ;; variables (if MODE-ONLY is nil.)
2814 result
2821 ;; Find those variables that we may want to save to
2822 ;; `safe-local-variable-values'.
2837 ;; If caller wants only the safe variables,
2838 ;; install only them.
2843 ;; Query, except in the case where all are known safe
2844 ;; if the user wants no quuery in that case.
2850 result unsafe-vars risky-vars))
2856 "Non-nil if SYM is safe as a file-local variable with value VAL.
2857 It is safe if any of these conditions are met:
2859 * There is a matching entry (SYM . VAL) in the
2860 `safe-local-variable-values' user option.
2862 * The `safe-local-variable' property of SYM is a function that
2863 evaluates to a non-nil value with VAL as an argument."
2869 "Non-nil if SYM could be dangerous as a file-local variable.
2870 It is dangerous if either of these conditions are met:
2872 * Its `risky-local-variable' property is non-nil.
2878 ;; If this is an alias, check the base name.
2898 "Return t if it is safe to eval EXP when it is found in a file."
2900 ;; Detect certain `put' expressions.
2906 ;; Only allow safe values of lisp-indent-hook;
2907 ;; not functions.
2910 ;; Only allow indirect form specs.
2911 ;; During bootstrapping, edebug-basic-spec might not be
2912 ;; defined yet.
2916 ;; Allow expressions that the user requested.
2918 ;; Certain functions can be allowed with safe arguments
2919 ;; or can specify verification functions to try.
2927 ok))
2935 ok)))))))
2938 "Set local variable VAR with value VAL.
2939 If VAR is `mode', call `VAL-mode' as a function unless it's
2940 already the major mode."
2950 ;; Make sure the string has no text properties.
2951 ;; Some text properties can get evaluated in various ways,
2952 ;; so it is risky to put them on with a local variable list.
2957 \f
2960 However, the mode will not be changed if
2961 \(1) a local variables list or the `-*-' line specifies a major mode, or
2963 \ not suitable for ordinary files, or
2964 \(3) the new file name does not particularly specify any mode."
2969 "Change name of file visited in current buffer to FILENAME.
2970 This also renames the buffer to correspond to the new file.
2971 The next time the buffer is saved it will go in the newly specified file.
2972 FILENAME nil or an empty string means mark buffer as not visiting any file.
2973 Remember to delete the initial contents of the minibuffer
2974 if you wish to pass an empty string as the argument.
2976 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2977 confirmation in the case where another buffer is already visiting FILENAME.
2979 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2980 the old visited file has been renamed to the new name FILENAME."
2988 nil
3003 filename)))
3015 ;; If new-name == old-name, renaming would add a spurious <2>
3016 ;; and it's considered as a feature in rename-buffer.
3022 ;; Abbreviate the file names of the buffer.
3031 nil)))
3032 ;; write-file-functions is normally used for things like ftp-find-file
3033 ;; that visit things that are not local files as if they were files.
3034 ;; Changing to visit an ordinary local file instead should flush the hook.
3039 ;; If buffer was read-only because of version control,
3040 ;; that reason is gone now, so make it writable.
3044 ;; Turn off backup files for certain file names.
3045 ;; Since this is a permanent local, the major mode won't eliminate it.
3047 backup-enable-predicate
3053 ;; If auto-save was not already on, turn it on if appropriate.
3057 ;; If auto save is on, start using a new name.
3058 ;; We deliberately don't rename or delete the old auto save
3059 ;; for the old visited file name. This is because perhaps
3060 ;; the user wants to save the new state and then compare with the
3061 ;; previous state from the auto save file.
3064 ;; Rename the old auto save file if any.
3071 ;; Update the major mode, if the file name determines it.
3073 ;; Don't change the mode if it is special.
3076 ;; Don't change the mode if the local variable list specifies it.
3082 "Write current buffer into file FILENAME.
3083 This makes the buffer visit that file, and marks it as not modified.
3085 If you specify just a directory name as FILENAME, that means to use
3086 the default file name but in that directory. You can also yank
3087 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3089 If the buffer is not already visiting a file, the default file name
3090 for the output file is the buffer name.
3092 If optional second arg CONFIRM is non-nil, this function
3093 asks for confirmation before overwriting an existing file.
3094 Interactively, confirmation is required unless you supply a prefix argument."
3095 ;; (interactive "FWrite file: ")
3099 nil nil nil nil)
3103 default-directory)
3104 nil nil))
3108 ;; If arg is just a directory,
3109 ;; use the default file name, but in that directory.
3120 ;; Make buffer writable if file is writable.
3125 ;; It's likely that the VC status at the new location is different from
3126 ;; the one at the old location.
3128 \f
3130 "Make a backup of the disk file visited by the current buffer, if appropriate.
3131 This is normally done before saving the buffer the first time.
3133 A backup may be done by renaming or by copying; see documentation of
3134 variable `make-backup-files'. If it's done by renaming, then the file is
3135 no longer accessible under its old name.
3137 The value is non-nil after a backup was made by renaming.
3138 It has the form (MODES . BACKUPNAME).
3139 MODES is the result of `file-modes' on the original
3140 file; this means that the caller, after saving the buffer, should change
3141 the modes of the new file to agree with the old modes.
3142 BACKUPNAME is the backup file name, which is the old file renamed."
3149 backup-info backupname targets setmodes)
3150 ;; If specified name is a symbolic link, chase it to the target.
3151 ;; Thus we make the backups in the directory where the real file is.
3156 ;; (if (file-directory-p buffer-file-name)
3157 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3161 ;; If have old versions to maybe delete,
3162 ;; ask the user to confirm now, before doing anything.
3163 ;; But don't actually delete til later.
3168 real-file-name)))))
3170 ;; Actually write the back up file.
3173 ; (file-symlink-p buffer-file-name)
3174 backup-by-copying
3175 ;; Don't rename a suid or sgid file.
3190 ;; rename-file should delete old backup.
3194 ;; If trouble writing the backup, write it in ~.
3199 backupname)
3203 ;; Now delete the old versions, if desired.
3210 setmodes)
3217 ;; Create temp files with strict access rights. It's easy to
3218 ;; loosen them later, whereas it's impossible to close the
3219 ;; time-window of loose permissions otherwise.
3222 ;; Try to overwrite old backup first.
3230 nil)
3232 ;; The file was somehow created by someone else between
3233 ;; `delete-file' and `copy-file', so let's try again.
3234 ;; rms says "I think there is also a possible race
3235 ;; condition for making backup files" (emacs-devel 20070821).
3236 nil)))
3237 ;; Reset the umask.
3243 "Return file NAME sans backup versions or strings.
3244 This is a separate procedure so your site-init or startup file can
3245 redefine it.
3246 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3247 we do not remove backup version numbers, only true file version numbers."
3253 ;; VMS version number is (a) semicolon, optional
3254 ;; sign, zero or more digits or (b) period, option
3255 ;; sign, zero or more digits, provided this is the
3256 ;; second period encountered outside of the
3257 ;; device/directory part of the file name.
3260 name)
3270 "Return t if deleting FILE and rewriting it would preserve the owner."
3275 ;; Return t if the file doesn't exist, since it's true that no
3276 ;; information would be lost by an (attempted) delete and create.
3282 The extension, in a file name, is the part that follows the last `.',
3283 except that a leading `.', if any, doesn't count."
3286 directory)
3290 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3291 ;; we don't want to expand it.
3294 filename))))
3298 The extension, in a file name, is the part that follows the last `.',
3299 excluding version numbers and backup suffixes,
3300 except that a leading `.', if any, doesn't count.
3301 Return nil for extensionless file names such as `foo'.
3302 Return the empty string for file names such as `foo.'.
3304 If PERIOD is non-nil, then the returned value includes the period
3305 that delimits the extension, and if FILENAME has no extension,
3316 "A function to use instead of the default `make-backup-file-name'.
3317 A value of nil gives the default `make-backup-file-name' behavior.
3319 This could be buffer-local to do something special for specific
3320 files. If you define it, you may need to change `backup-file-name-p'
3321 and `file-name-sans-versions' too.
3323 See also `backup-directory-alist'."
3329 "Alist of filename patterns and backup directory names.
3330 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3331 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3332 relative or absolute. If it is absolute, so that all matching files
3333 are backed up into the same directory, the file names in this
3334 directory will be the full name of the file backed up with all
3335 directory separators changed to `!' to prevent clashes. This will not
3336 work correctly if your filesystem truncates the resulting name.
3338 For the common case of all backups going into one directory, the alist
3340 directory name.
3342 If this variable is nil, or it fails to match a filename, the backup
3343 is made in the original file's directory.
3345 On MS-DOS filesystems without long names this variable is always
3346 ignored."
3352 "Default `backup-enable-predicate' function.
3353 Checks for files in `temporary-file-directory',
3354 `small-temporary-file-directory', and /tmp."
3357 ;; Directory is under temporary-file-directory.
3362 ;; Directory is under /tmp.
3367 0 nil
3369 ;; Directory is under small-temporary-file-directory.
3374 "Create the non-numeric backup file name for FILE.
3375 Normally this will just be the file's name with `~' appended.
3376 Customization hooks are provided as follows.
3378 If the variable `make-backup-file-name-function' is non-nil, its value
3379 should be a function which will be called with FILE as its argument;
3380 the resulting name is used.
3382 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3383 the documentation of that variable. If the directory for the backup
3384 doesn't exist, it is created."
3398 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3400 elt backup-directory abs-backup-directory)
3405 alist nil)))
3406 ;; If backup-directory is relative, it should be relative to the
3407 ;; file's directory. By expanding explicitly here, we avoid
3408 ;; depending on default-directory.
3417 abs-backup-directory nil))))
3419 file
3423 ;; Normalize DOSish file names: downcase the drive
3424 ;; letter, if any, and replace the leading "x:" with
3425 ;; "/drive_x".
3428 ;; Replace any invalid file-name characters (for the
3429 ;; case of backing up remote files).
3433 "drive_"
3436 ""
3439 ;; Make the name unique by substituting directory
3440 ;; separators. It may not really be worth bothering about
3441 ;; doubling `!'s in the original name...
3446 backup-directory))
3451 "Return non-nil if FILE is a backup file name (numeric or not).
3452 This is a separate function so you can redefine it for customization.
3453 You may need to redefine `file-name-sans-versions' as well."
3458 ;; This is used in various files.
3459 ;; The usage of backup-extract-version-start is not very clean,
3460 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3462 "Given the name of a numeric backup file, FN, return the backup number.
3463 Uses the free variable `backup-extract-version-start', whose value should be
3464 the index in the name where the version number begins."
3470 ;; I believe there is no need to alter this behavior for VMS;
3471 ;; since backup files are not made on VMS, it should not get called.
3473 "Find a file name for a backup file FN, and suggestions for deletions.
3474 Value is a list whose car is the name for the backup file
3475 and whose cdr is a list of old versions to consider deleting now.
3476 If the value is nil, don't make a backup.
3477 Uses `backup-directory-alist' in the same way as does
3478 `make-backup-file-name'."
3480 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3484 ;; We don't support numbered backups on plain MS-DOS
3485 ;; when long file names are unavailable.
3495 possibilities deserve-versions-p versions)
3498 base-versions
3501 possibilities)
3502 #'<)
3507 kept-old-versions
3508 kept-new-versions
3515 ;; Delete nothing if there is overflow
3516 ;; in the number of versions to keep.
3522 v))))))))))
3525 "Return number of names file FILENAME has."
3528 ;; (defun file-relative-name (filename &optional directory)
3529 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3530 ;; This function returns a relative file name which is equivalent to FILENAME
3531 ;; when used with that default directory as the default.
3532 ;; If this is impossible (which can happen on MSDOS and Windows
3533 ;; when the file name and directory use different drive names)
3534 ;; then it returns FILENAME."
3535 ;; (save-match-data
3536 ;; (let ((fname (expand-file-name filename)))
3537 ;; (setq directory (file-name-as-directory
3538 ;; (expand-file-name (or directory default-directory))))
3539 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3540 ;; ;; drive names, they can't be relative, so return the absolute name.
3541 ;; (if (and (or (eq system-type 'ms-dos)
3542 ;; (eq system-type 'cygwin)
3543 ;; (eq system-type 'windows-nt))
3544 ;; (not (string-equal (substring fname 0 2)
3545 ;; (substring directory 0 2))))
3546 ;; filename
3547 ;; (let ((ancestor ".")
3548 ;; (fname-dir (file-name-as-directory fname)))
3549 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3550 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3551 ;; (setq directory (file-name-directory (substring directory 0 -1))
3552 ;; ancestor (if (equal ancestor ".")
3553 ;; ".."
3554 ;; (concat "../" ancestor))))
3555 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3556 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3557 ;; ;; We matched within FNAME's directory part.
3558 ;; ;; Add the rest of FNAME onto ANCESTOR.
3559 ;; (let ((rest (substring fname (match-end 0))))
3560 ;; (if (and (equal ancestor ".")
3561 ;; (not (equal rest "")))
3562 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3563 ;; rest
3564 ;; (concat (file-name-as-directory ancestor) rest)))
3565 ;; ;; We matched FNAME's directory equivalent.
3566 ;; ancestor))))))
3569 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3570 This function returns a relative file name which is equivalent to FILENAME
3571 when used with that default directory as the default.
3572 If FILENAME and DIRECTORY lie on different machines or on different drives
3573 on a DOS/Windows machine, it returns FILENAME in expanded form."
3577 default-directory))))
3583 ;; Test for different drives on DOS/Windows
3585 ;; Should `cygwin' really be included here? --stef
3588 ;; Test for different remote file system identification
3590 filename
3596 directory nil nil case-fold-search))
3598 directory nil nil case-fold-search))))
3601 ".."
3603 ;; Now ancestor is empty, or .., or ../.., etc.
3605 directory nil nil case-fold-search))
3606 ;; We matched within FILENAME's directory part.
3607 ;; Add the rest of FILENAME onto ANCESTOR.
3610 ;; But don't bother with ANCESTOR if it would give us `./'.
3611 rest
3613 ;; We matched FILENAME's directory equivalent.
3614 ancestor))))))
3615 \f
3617 "Save current buffer in visited file if modified.
3618 Variations are described below.
3620 By default, makes the previous version into a backup file
3621 if previously requested or if this is the first save.
3623 to become a backup when the next save is done.
3625 unconditionally makes the previous version into a backup file.
3627 to become a backup when the next save is done,
3628 and unconditionally makes the previous version into a backup file.
3630 With a numeric argument of 0, never make the previous version
3631 into a backup file.
3633 If a file's name is FOO, the names of its numbered backup versions are
3634 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3635 Numeric backups (rather than FOO~) will be made if value of
3636 `version-control' is not the atom `never' and either there are already
3637 numeric versions of the file being backed up, or `version-control' is
3638 non-nil.
3639 We don't want excessive versions piling up, so there are variables
3640 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3641 and `kept-new-versions', which tells how many newest versions to keep.
3642 Defaults are 2 old versions and 2 new.
3643 `dired-kept-versions' controls dired's clean-directory (.) command.
3644 If `delete-old-versions' is nil, system will query user
3645 before trimming versions. Otherwise it does it silently.
3647 If `vc-make-backup-files' is nil, which is the default,
3648 no backup files are made for files managed by version control.
3649 (This is because the version control system itself records previous versions.)
3651 See the subroutine `basic-save-buffer' for more information."
3664 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3665 Normally delete only if the file was written by this Emacs since
3666 the last real save, but optional arg FORCE non-nil means delete anyway."
3680 "Normal hook that is run before a buffer is saved to its file."
3686 "Normal hook that is run after a buffer is saved to its file."
3692 "If non-nil, use this coding system for saving the buffer.
3693 More precisely, use this coding system in place of the
3694 value of `buffer-file-coding-system', when saving the buffer.
3695 Calling `write-region' for any purpose other than saving the buffer
3696 will still use `buffer-file-coding-system'; this variable has no effect
3703 "Save the current buffer in its visited file, if it has been modified.
3704 The hooks `write-contents-functions' and `write-file-functions' get a chance
3705 to do the job of saving; if they do not, then the buffer is saved in
3706 the visited file in the usual way.
3707 Before and after saving the buffer, this function runs
3708 `before-save-hook' and `after-save-hook', respectively."
3711 ;; In an indirect buffer, save its base buffer instead.
3716 setmodes)
3717 ;; On VMS, rename file and buffer to get rid of version number.
3722 ;; Strip VMS version number before save.
3725 ;; Construct a (unique) buffer name to correspond.
3730 ;; If buffer has no file name, ask user for one.
3737 ;; Signal an error if the user specified the name of an
3738 ;; existing directory.
3741 filename))
3743 ;; Signal an error if the specified name refers to a
3744 ;; non-existing directory.
3774 ;; Support VC version backups.
3780 ;; If a hook returned t, file is already "written".
3781 ;; Otherwise, write it the usual way now.
3783 ;; Now we have saved the current buffer. Let's make sure
3784 ;; that buffer-file-coding-system is fixed to what
3785 ;; actually used for saving by binding it locally.
3795 ;; If the auto-save file was recent before this command,
3796 ;; delete it now.
3798 ;; Support VC `implicit' locking.
3803 ;; This does the "real job" of writing a buffer into its visited file
3804 ;; and making a backup file. This is what is normally done
3805 ;; but inhibited if one of write-file-functions returns non-nil.
3806 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3815 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3829 buffer-file-name)))
3837 ;; If file is precious, write temp name, then rename it.
3838 ;; This requires write access to the containing dir,
3839 ;; which is why we don't try it if we don't have that access.
3841 tempname succeed
3844 ;; Create temp files with strict access rights. It's easy to
3845 ;; loosen them later, whereas it's impossible to close the
3846 ;; time-window of loose permissions otherwise.
3851 ;; Try various temporary names.
3852 ;; This code follows the example of make-temp-file,
3853 ;; but it calls write-region in the appropriate way
3854 ;; for saving the buffer.
3861 tempname nil realname
3863 nil)
3865 ;; The file was somehow created by someone else between
3866 ;; `make-temp-name' and `write-region', let's try again.
3867 nil)
3869 ;; Reset the umask.
3871 ;; If we failed, restore the buffer's modtime.
3874 ;; Since we have created an entirely new file,
3875 ;; make sure it gets the right permission bits set.
3879 buffer-file-name)))
3880 ;; We succeeded in writing the temp file,
3881 ;; so rename it.
3883 ;; If file not writable, see if we can make it writable
3884 ;; temporarily while we write it.
3885 ;; But no need to do so if we have just backed it up
3886 ;; (setmodes is set) because that says we're superseding.
3888 ;; Change the mode back, after writing.
3895 buffer-file-name nil t buffer-file-truename)
3897 ;; If we get an error writing the new file, and we made
3898 ;; the backup by renaming, undo the backing-up.
3903 setmodes))
3906 "View the differences between BUFFER and its associated file.
3907 This requires the external program `diff' to be in your `exec-path'."
3922 ;; Display that message for 1 second so that user can read it
3923 ;; in the minibuffer.
3925 ;; return always nil, so that save-buffers-kill-emacs will not move
3926 ;; over to the next unsaved buffer when calling `d'.
3927 nil)
3930 '((?\C-r
3936 ;; Return nil to ask about BUF again.
3937 nil)
3945 nil)
3954 "Save some modified file-visiting buffers. Asks user about each one.
3955 You can answer `y' to save, `n' not to save, `C-r' to look at the
3956 buffer in question with `view-buffer' before deciding or `d' to
3957 view the differences using `diff-buffer-with-file'.
3959 Optional argument (the prefix) non-nil means save all with no questions.
3960 Optional second argument PRED determines which buffers are considered:
3961 If PRED is nil, all the file-visiting buffers are considered.
3962 If PRED is t, then certain non-file buffers will also be considered.
3963 If PRED is a zero-argument function, it indicates for each buffer whether
3964 to consider it or not when called with that buffer current.
3966 See `save-some-buffers-action-alist' if you want to
3967 change the additional actions you can take on files."
3971 files-done abbrevs-done)
3973 ;; First save any buffers that we're supposed to save unconditionally.
3974 ;; That way the following code won't ask about them.
3979 ;; Ask about those buffers that merit it,
3980 ;; and record the number thus saved.
3996 t
4009 save-some-buffers-action-alist))
4010 ;; Maybe to save abbrevs, and record whether
4011 ;; we either saved them or asked to.
4017 abbrev-file-name)))
4019 ;; Don't keep bothering user if he says no.
4024 "(Some special files were saved without asking)"
4026 \f
4028 "Mark current buffer as unmodified, not needing to be saved.
4031 It is not a good idea to use this function in Lisp programs, because it
4032 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4039 "Change whether this buffer is visiting its file read-only.
4040 With prefix argument ARG, make the buffer read-only if ARG is
4041 positive, otherwise make it writable. If visiting file read-only
4042 and `view-read-only' is non-nil, enter view mode."
4047 nil ; do nothing.
4048 ;; Toggle.
4055 ;; If view-mode is already active, `view-mode-enter' is a nop.
4067 "Insert contents of file FILENAME into buffer after point.
4068 Set mark after the inserted text.
4070 This function is meant for the user to run interactively.
4071 Don't call it from programs! Use `insert-file-contents' instead.
4072 \(Its calling sequence is different; see its documentation)."
4077 "Append the contents of the region to the end of file FILENAME.
4078 When called from a function, expects three arguments,
4079 START, END and FILENAME. START and END are buffer positions
4080 saying what text to write."
4085 "Return most recent backup file for FILENAME or nil if no backups exist."
4086 ;; `make-backup-file-name' will get us the right directory for
4087 ;; ordinary or numeric backups. It might create a directory for
4088 ;; backups as a side-effect, according to `backup-directory-alist'.
4095 tem)
4104 newest))
4107 "Rename current buffer to a similar name not already taken.
4108 This function is useful for creating multiple shell process buffers
4109 or multiple mail buffers, etc."
4117 ;; If the existing buffer name has a <NNN>,
4118 ;; which isn't part of the file name (if any),
4119 ;; then get rid of that.
4125 "Create the directory DIR and any nonexistent parent dirs.
4126 If DIR already exists as a directory, do nothing.
4128 Interactively, the default choice of directory to create
4129 is the current default directory for file names.
4130 That is useful when you have visited a file in a nonexistent directory.
4132 Noninteractively, the second (optional) argument PARENTS says whether
4133 to create parent directories if they don't exist. Interactively,
4134 this happens by default."
4137 nil nil)
4138 t))
4139 ;; If default-directory is a remote directory,
4140 ;; make sure we find its make-directory handler.
4148 create-list)
4155 \f
4158 "Function to use to revert this buffer, or nil to do the default.
4159 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4164 "Function to use to insert contents when reverting this buffer.
4165 Gets two args, first the nominal file name to use,
4166 and second, t if reading the auto-save file.
4171 "Function to check whether a non-file buffer needs reverting.
4172 This should be a function with one optional argument NOCONFIRM.
4173 Auto Revert Mode passes t for NOCONFIRM. The function should return
4174 non-nil if the buffer should be reverted. A return value of
4175 `fast' means that the need for reverting was not checked, but
4176 that reverting the buffer is fast. The buffer is current when
4177 this function is called.
4179 The idea behind the NOCONFIRM argument is that it should be
4180 non-nil if the buffer is going to be reverted without asking the
4181 user. In such situations, one has to be careful with potentially
4182 time consuming operations.
4184 For more information on how this variable is used by Auto Revert mode,
4188 "Normal hook for `revert-buffer' to run before reverting.
4189 If `revert-buffer-function' is used to override the normal revert
4193 "Normal hook for `revert-buffer' to run after reverting.
4194 Note that the hook value that it runs is the value that was in effect
4195 before reverting; that makes a difference if you have buffer-local
4196 hook functions.
4198 If `revert-buffer-function' is used to override the normal revert
4204 "Replace current buffer text with the text of the visited file on disk.
4205 This undoes all changes since the file was visited or saved.
4206 With a prefix argument, offer to revert from latest auto-save file, if
4207 that is more recent than the visited file.
4209 This command also implements an interface for special buffers
4210 that contain text which doesn't come from a file, but reflects
4211 some other data instead (e.g. Dired buffers, `buffer-list'
4212 buffers). This is done via the variable
4213 `revert-buffer-function'. In these cases, it should reconstruct
4214 the buffer contents from the appropriate data.
4216 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4217 to revert from the auto-save file when this is nil. Note that the
4218 sense of this argument is the reverse of the prefix argument, for the
4219 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4220 to nil.
4222 Optional second argument NOCONFIRM means don't ask for confirmation at
4223 all. \(The variable `revert-without-query' offers another way to
4224 revert buffers without querying for confirmation.)
4226 Optional third argument PRESERVE-MODES non-nil means don't alter
4227 the files modes. Normally we reinitialize them using `normal-mode'.
4229 If the value of `revert-buffer-function' is non-nil, it is called to
4230 do all the work for this command. Otherwise, the hooks
4231 `before-revert-hook' and `after-revert-hook' are run at the beginning
4232 and the end, and if `revert-buffer-insert-file-contents-function' is
4233 non-nil, it is called instead of rereading visited file contents."
4235 ;; I admit it's odd to reverse the sense of the prefix argument, but
4236 ;; there is a lot of code out there which assumes that the first
4237 ;; argument should be t to avoid consulting the auto-save file, and
4238 ;; there's no straightforward way to encourage authors to notice a
4239 ;; reversal of the argument sense. So I'm just changing the user
4240 ;; interface, but leaving the programmatic interface the same.
4248 buffer-auto-save-file-name
4253 buffer-auto-save-file-name
4254 buffer-file-name)))
4264 file-name)))
4266 ;; If file was backed up but has changed since,
4267 ;; we shd make another backup.
4271 ;; Effectively copy the after-revert-hook status,
4272 ;; since after-find-file will clobber it.
4275 after-revert-hook))
4280 ;; Get rid of all undo records for this buffer.
4282 ;; Don't make undo records for the reversion.
4285 file-name auto-save-p)))
4288 "File %s no longer exists!"
4290 file-name))
4293 "File %s no longer readable!"
4295 file-name))
4297 ;; Bind buffer-file-name to nil
4298 ;; so that we don't try to lock the file.
4304 ;; Auto-saved file should be read by Emacs'
4305 ;; internal coding.
4308 buffer-file-coding-system-explicit))))
4310 coding-system-for-read
4312 coding-system-for-read)
4314 ;; As a coding system suitable for multibyte
4315 ;; buffer is specified, make the current
4316 ;; buffer multibyte.
4319 ;; This force after-insert-file-set-coding
4320 ;; (called from insert-file-contents) to set
4321 ;; buffer-file-coding-system to a proper value.
4324 ;; Note that this preserves point in an intelligent way.
4328 nil nil t))
4330 nil nil t)))))
4331 ;; Recompute the truename in case changes in symlinks
4332 ;; have changed the truename.
4336 ;; Run after-revert-hook as it was before we reverted.
4340 local-hook)
4343 t))))))
4346 "Recover the visited file--get contents from its last auto-save file."
4351 "Visit file FILE, but get contents from its last auto-save file."
4352 ;; Actually putting the file name in the minibuffer should be used
4353 ;; only rarely.
4354 ;; Not just because users often use the default.
4374 ;; Use insert-directory-safely, not insert-directory,
4375 ;; because these files might not exist. In particular,
4376 ;; FILE might not exist if the auto-save file was for
4377 ;; a buffer that didn't visit a file, such as "*mail*".
4378 ;; The code in v20.x called `ls' directly, so we need
4379 ;; to emulate what `ls' did in that case.
4385 ;; Keep the current buffer-file-coding-system.
4387 ;; Auto-saved file should be read with special coding.
4396 "Recover auto save files from a previous Emacs session.
4397 This command first displays a Dired buffer showing you the
4398 previous sessions that you could recover from.
4399 To choose one, move point to the proper line and then type C-c C-c.
4400 Then you'll be asked about a number of files to recover."
4410 auto-save-list-file-prefix)))
4411 t)
4420 ;; Each line starts with a space
4421 ;; so that Font Lock mode won't highlight the first character.
4430 "Choose one saved session to recover auto-save files from.
4431 This command is used in the special Dired buffer created by
4434 ;; Get the name of the session file to recover from.
4436 files
4442 ;; Read in the auto-save-list file.
4446 ;; Loop thru the text of that file
4447 ;; and get out the names of the files to recover.
4451 ;; This is a pair of lines for a non-file-visiting buffer.
4452 ;; Get the auto-save file name and manufacture
4453 ;; a "visited file name" from that.
4456 ;; If there is no auto-save file name, the
4457 ;; auto-save-list file is probably corrupted.
4470 ;; This pair of lines is a file-visiting
4471 ;; buffer. Use the visited file name.
4481 ;; Ignore a file if its auto-save file does not exist now.
4485 ;; The file contains a pair of line for each auto-saved buffer.
4486 ;; The first line of the pair contains the visited file name
4487 ;; or is empty if the buffer was not visiting a file.
4488 ;; The second line is the auto-save file name.
4496 files
4502 "Kill buffer if confirmed."
4510 "Kill some buffers. Asks the user whether to kill each one of them.
4511 Non-interactively, if optional argument LIST is non-nil, it
4512 specifies the list of buffers to kill, asking for approval for each one."
4520 ; if we killed the base buffer.
4527 "Kill buffers whose name matches the specified regexp.
4528 The optional second argument indicates whether to kill internal buffers too."
4537 \f
4539 "Toggle auto-saving of contents of current buffer.
4540 With prefix argument ARG, turn auto-saving on if positive, else off."
4545 ;; If auto-save is off because buffer has shrunk,
4546 ;; then toggling should turn it on.
4551 buffer-file-name
4553 ;; If -1 was stored here, to temporarily turn off saving,
4554 ;; turn it back on.
4560 buffer-auto-save-file-name)
4563 "Adjust current buffer's auto save file name for current conditions.
4564 Also rename any existing auto save file, if it was made in this session."
4576 "Return file name to use for auto-saves of current buffer.
4577 Does not consider `auto-save-visited-file-name' as that variable is checked
4578 before calling this function. You can redefine this for customization.
4579 See also `auto-save-file-name-p'."
4587 result uniq)
4588 ;; Apply user-specified translations
4589 ;; to the file name.
4593 filename)
4603 filename))))
4608 ;; We truncate the file name to DOS 8+3 limits
4609 ;; before doing anything else, because the regexp
4610 ;; passed to string-match below cannot handle
4611 ;; extensions longer than 3 characters, multiple
4612 ;; dots, and other atrocities.
4617 fn)
4622 "#"
4625 ;; Make sure auto-save file names don't contain characters
4626 ;; invalid for the underlying filesystem.
4628 ;; Don't modify remote (ange-ftp) filenames
4631 result))))
4633 ;; Deal with buffers that don't have any associated files. (Mail
4634 ;; mode tends to create a good number of these.)
4638 file-name)
4639 ;; Eliminate all slashes and backslashes by
4640 ;; replacing them with sequences that start with %.
4641 ;; Quote % also, to keep distinct names distinct.
4650 ;; Generate the file name.
4656 ;; Try a few alternative directories, to get one we can
4657 ;; write it.
4663 ;; Don't modify remote (ange-ftp) filenames
4665 ;; The call to convert-standard-filename is in case
4666 ;; buffer-name includes characters not allowed by the
4667 ;; DOS/Windows filesystems. make-temp-file writes to the
4668 ;; file it creates, so we must fix the file name _before_
4669 ;; make-temp-file is called.
4671 fname))
4673 ;; make-temp-file creates the file,
4674 ;; but we don't want it to exist until we do an auto-save.
4678 file-name)))
4681 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4682 FILENAME should lack slashes. You can redefine this for customization."
4684 \f
4686 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4687 The generated regexp will match a filename only if the filename
4688 matches that wildcard according to shell rules. Only wildcards known
4689 by `sh' are supported."
4691 ;; Copy the initial run of non-special characters.
4694 ;; If no special characters, we're almost done.
4698 j)
4700 result
4721 ;; Found "[^". Insert a `\0' character
4722 ;; (which cannot happen in a filename)
4723 ;; into the character class, so that `^'
4724 ;; is not the first character after `[',
4725 ;; and thus non-special in a regexp.
4730 ;; I don't think `]' can appear in a
4731 ;; character class in a wildcard, but
4732 ;; let's be general here.
4739 i
4752 ;; Shell wildcards should match the entire filename,
4753 ;; not its part. Make the regexp say so.
4755 \f
4758 "Switches for `list-directory' to pass to `ls' for brief listing."
4764 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4766 "Switches for `list-directory' to pass to `ls' for verbose listing."
4771 "Expand wildcard pattern PATTERN.
4772 This returns a list of file names which match the pattern.
4774 If PATTERN is written as an absolute file name,
4775 the values are absolute also.
4777 If PATTERN is written as a relative file name, it is interpreted
4778 relative to the current default directory, `default-directory'.
4779 The file names returned are normally also relative to the current
4780 default directory. However, if FULL is non-nil, they are absolute."
4784 ;; A list of all dirs that DIRPART specifies.
4785 ;; This can be more than one dir
4786 ;; if DIRPART contains wildcards.
4791 contents)
4796 ;; Filter out "." and ".."
4801 name))
4808 this-dir-contents)
4809 this-dir-contents)
4810 contents))))
4812 contents)))
4815 "Display a list of files in or matching DIRNAME, a la `ls'.
4816 DIRNAME is globbed by the shell if necessary.
4817 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4818 Actions controlled by variables `list-directory-brief-switches'
4819 and `list-directory-verbose-switches'."
4823 nil default-directory nil)
4824 pfx)))
4826 list-directory-brief-switches))
4827 buffer)
4840 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4848 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4850 PATTERN is assumed to represent a file-name wildcard suitable for the
4851 underlying filesystem. For Unix and GNU/Linux, the characters from the
4853 the parts of the pattern which don't include wildcard characters are
4854 quoted with double quotes.
4855 Existing quote characters in PATTERN are left alone, so you can pass
4856 PATTERN that already quotes some of the special characters."
4860 ;; DOS/Windows don't allow `"' in file names. So if the
4861 ;; argument has quotes, we can safely assume it is already
4862 ;; quoted by the caller.
4864 ;; We quote [&()#$'] in case their shell is a port of a
4865 ;; Unixy shell. We quote [,=+] because stock DOS and
4866 ;; Windows shells require that in some cases, such as
4867 ;; passing arguments to batch files that use positional
4868 ;; arguments like %1.
4870 pattern
4873 end)
4890 pattern))))
4897 "Program to get the amount of free space on a file system.
4898 We assume the output has the format of `df'.
4899 The value of this variable must be just a command name or file name;
4900 if you want to specify options, use `directory-free-space-args'.
4902 A value of nil disables this feature.
4904 If the function `file-system-info' is defined, it is always used in
4905 preference to the program given by this variable."
4911 "Options to use when running `directory-free-space-program'."
4916 "Return the amount of free space on directory DIR's file system.
4917 The result is a string that gives the number of free 1KB blocks,
4918 or nil if the system call or the program which retrieve the information
4919 fail. It returns also nil when DIR is a remote directory.
4921 This function calls `file-system-info' if it is available, or invokes the
4922 program specified by `directory-free-space-program' if that is non-nil."
4924 ;; Try to find the number of free blocks. Non-Posix systems don't
4925 ;; always have df, but might have an equivalent system call.
4934 nil t nil
4935 directory-free-space-args
4936 dir)))
4937 ;; Usual format is a header line followed by a line of
4938 ;; numbers.
4943 ;; Move to the end of the "available blocks" number.
4946 ;; Copy it into AVAILABLE.
4951 ;; The following expression replaces `dired-move-to-filename-regexp'.
4955 ;; In some locales, month abbreviations are as short as 2 letters,
4956 ;; and they can be followed by ".".
4957 ;; In Breton, a month name can include a quote character.
4970 s "+"
4973 ;; Japanese MS-Windows ls-lisp has one-digit months, and
4974 ;; omits the Kanji characters after month and day-of-month.
4975 ;; On Mac OS X 10.3, the date format in East Asian locales is
4976 ;; day-of-month digits followed by month digits.
4982 ;; The "[0-9]" below requires the previous column to end in a digit.
4983 ;; This avoids recognizing `1 may 1997' as a date in the line:
4984 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
4986 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
4987 ;; The ".*" below finds the last match if there are multiple matches.
4988 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
4989 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
4991 ;; vc dired listings provide the state or blanks between file
4992 ;; permissions and date. The state is always surrounded by
4993 ;; parantheses:
4994 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
4995 ;; This is not supported yet.
4999 "Regular expression to match up to the file name in a directory listing.
5000 The default value is designed to recognize dates and times
5005 ;; insert-directory
5006 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5007 ;; FULL-DIRECTORY-P is nil.
5008 ;; The single line of output must display FILE's name as it was
5009 ;; given, namely, an absolute path name.
5010 ;; - must insert exactly one line for each file if WILDCARD or
5011 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5012 ;; before the file lines, plus optional text after the file lines.
5013 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5014 ;; allowed.
5015 ;; File lines should display the basename.
5016 ;; - must be consistent with
5017 ;; - functions dired-move-to-filename, (these two define what a file line is)
5018 ;; dired-move-to-end-of-filename,
5019 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5020 ;; dired-insert-headerline
5021 ;; dired-after-subdir-garbage (defines what a "total" line is)
5022 ;; - variable dired-subdir-regexp
5023 ;; - may be passed "--dired" as the first argument in SWITCHES.
5024 ;; Filename handlers might have to remove this switch if their
5025 ;; "ls" command does not support it.
5027 "Insert directory listing for FILE, formatted according to SWITCHES.
5028 Leaves point after the inserted text.
5029 SWITCHES may be a string of options, or a list of strings
5030 representing individual options.
5031 Optional third arg WILDCARD means treat FILE as shell wildcard.
5032 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5033 switches do not contain `d', so that a full listing is expected.
5035 This works by running a directory listing program
5036 whose name is in the variable `insert-directory-program'.
5037 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5039 When SWITCHES contains the long `--dired' option, this function
5040 treats it specially, for the sake of dired. However, the
5041 normally equivalent short `-D' option is just passed on to
5042 `insert-directory-program', as any other option."
5043 ;; We need the directory in order to find the right handler.
5048 wildcard full-directory-p)
5053 ;; Read the actual directory using `insert-directory-program'.
5054 ;; RESULT gets the status code.
5056 ;; putting text property `dired-filename, decode one
5057 ;; bunch by one to preserve that property.
5059 ;; This is to control encoding the arguments in call-process.
5063 default-file-name-coding-system))))
5066 ;; Run ls in the directory part of the file pattern
5067 ;; using the last component as argument.
5074 shell-file-name nil t nil
5075 "-c"
5077 ""
5079 insert-directory-program
5080 " -d "
5082 switches
5084 " -- "
5085 ;; Quote some characters that have
5086 ;; special meanings in shells; but
5087 ;; don't quote the wildcards--we want
5088 ;; them to be special. We also
5089 ;; currently don't quote the quoting
5090 ;; characters in case people want to
5091 ;; use them explicitly to quote
5092 ;; wildcard characters.
5094 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5095 ;; directory if FILE is a symbolic link.
5097 insert-directory-program nil t nil
5101 ;; Split the switches at any spaces so we can
5102 ;; pass separate options as separate args.
5104 ;; Avoid lossage if FILE starts with `-'.
5112 file))))))))
5114 ;; If we got "//DIRED//" in the output, it means we got a real
5115 ;; directory listing, even if `ls' returned nonzero.
5116 ;; So ignore any errors.
5129 ;; The first time ls returns an error,
5130 ;; find the version numbers of ls,
5131 ;; and set insert-directory-ls-version
5132 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5133 ;; is equal or if the info cannot be obtained.
5134 ;; (That can mean it isn't GNU ls.)
5144 comparison)
5160 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5164 ;; If `insert-directory-program' failed, signal an error.
5166 ;; Delete the error message it may have output.
5168 ;; On non-Posix systems, we cannot open a directory, so
5169 ;; don't even try, because that will always result in
5170 ;; the ubiquitous "Access denied". Instead, show the
5171 ;; command line so the user can try to guess what went wrong.
5176 insert-directory-program
5178 file result)
5179 ;; Unix. Access the file to get a suitable error.
5186 ;; The following overshoots by one line for an empty
5187 ;; directory listed with "--dired", but without "-a"
5188 ;; switch, where the ls output contains a
5189 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5190 ;; We take care of that case later.
5198 error-lines)
5199 ;; Find all the lines that are error messages,
5200 ;; and record the bounds of each one.
5207 ;; Now read the numeric positions of file names.
5214 error-lines))
5217 error-lines)))
5219 ;; End is followed by \n or by " -> ".
5221 ;; It seems that we can't trust ls's output as to
5222 ;; byte positions of filenames.
5228 ;; Take care of the case where the ls output contains a
5229 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5230 ;; and we went one line too far back (see above).
5235 ;; Now decode what read if necessary.
5237 file-name-coding-system
5238 default-file-name-coding-system
5240 coding-no-eol
5241 val pos)
5245 ;; If no coding system is specified or detection is
5246 ;; requested, detect the coding.
5260 ;; Force no eol conversion on a file name, so
5261 ;; that CR is preserved.
5269 ;; Try to insert the amount of free space.
5272 ;; First find the line to put it on.
5276 ;; Replace "total" with "used", to avoid confusion.
5282 "Convert `ls --dired' file name position value POS to a buffer position.
5283 File name position values returned in ls --dired output
5284 count only stdout; they don't count the error messages sent to stderr.
5285 So this function converts to them to real buffer positions.
5286 ERROR-LINES is a list of buffer positions of error message lines,
5287 of the form (START END)."
5291 pos)
5295 "Insert directory listing for FILE, formatted according to SWITCHES.
5297 Like `insert-directory', but if FILE does not exist, it inserts a
5298 message to that effect instead of signaling an error."
5301 ;; Simulate the message printed by `ls'.
5305 "Functions to call with no arguments to query about killing Emacs.
5306 If any of these functions returns nil, killing Emacs is cancelled.
5307 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5311 "How to ask for confirmation when leaving Emacs.
5312 If nil, the default, don't ask at all. If the value is non-nil, it should
5313 be a predicate function such as `yes-or-no-p'."
5321 "Offer to save each buffer, then kill this Emacs process.
5322 With prefix arg, silently save all file-visiting buffers, then kill."
5331 ;; process-list is not defined on VMS.
5333 active)
5342 ;; Query the user for other things, perhaps.
5349 "Offer to save each buffer, then kill the current connection.
5350 If the current frame has no client, kill Emacs itself.
5352 With prefix arg, silently save all file-visiting buffers, then kill.
5354 If emacsclient was started with a list of filenames to edit, then
5355 only these files will be asked to be saved."
5363 \f
5364 ;; We use /: as a prefix to "quote" a file name
5365 ;; so that magic file name handlers will not apply to it.
5369 file-name-handler-alist))
5371 ;; We depend on being the last handler on the list,
5372 ;; so that anything else which does need handling
5373 ;; has been handled already.
5374 ;; So it is safe for us to inhibit *all* magic file name handlers.
5383 default-directory))
5384 ;; Get a list of the indices of the args which are file names.
5387 ;; The first six are special because they
5388 ;; return a file name. We want to include the /:
5389 ;; in the return value.
5390 ;; So just avoid stripping it in the first place.
5397 ;; `identity' means just return the first arg
5398 ;; not stripped of its quoting.
5400 ;; `add' means add "/:" to the result.
5402 ;; `quote' means add "/:" to buffer-file-name.
5404 ;; `unquote-then-quote' means set buffer-file-name
5405 ;; temporarily to unquoted filename.
5407 ;; List the arguments which are filenames.
5415 ;; For all other operations, treat the first argument only
5416 ;; as the file name.
5418 method
5419 ;; Copy ARGUMENTS so we can replace elements in it.
5423 ;; Strip off the /: from the file names that have it.
5431 "/"
5447 res))
5450 \f
5451 ;; Symbolic modes and read-file-modes.
5454 "Convert CHAR to a who-mask from a symbolic mode notation.
5455 CHAR is in [ugoa] and represents the users on which rights are applied."
5463 "Convert CHAR to a right-mask from a symbolic mode notation.
5464 CHAR is in [rwxXstugo] and represents a right.
5465 If CHAR is in [Xugo], the value is extracted from FROM (or 0 if nil)."
5472 ;; Rights relative to the previous file modes.
5483 "Convert a right string to a right-mask from a symbolic modes notation.
5485 WHO-MASK is the mask number of the users on which the rights are to be applied.
5486 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5492 char-right)
5499 num-rights
5503 op char-right)))
5504 num-rights))
5507 "Convert symbolic file modes to numeric file modes.
5508 MODES is the string to convert, it should match
5511 notation.
5512 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5525 num-who num-modes)
5528 num-modes)))
5531 "Read file modes in octal or symbolic notation.
5532 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5533 ORIG-FILE is the original file of which modes will be change."
5542 \f
5567 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5568 ;;; files.el ends here