| blob | ff6d18475238755bd495181e7e2840178da31951 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 ;; 2006, 2007, 2008 Free Software Foundation, Inc.
7 ;; Maintainer: FSF
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; Defines most of Emacs's file- and directory-handling functions,
27 ;; including basic file visiting, backup generation, link handling,
28 ;; ITS-id version control, load- and write-hook handling, and the like.
30 ;;; Code:
35 "Backups of edited data files."
39 "Finding files."
44 "Non-nil means delete auto-save file when a buffer is saved or killed.
46 Note that the auto-save file will not be deleted if the buffer is killed
47 when it has unsaved changes."
52 nil
53 "Alist of abbreviations for file directories.
54 A list of elements of the form (FROM . TO), each meaning to replace
55 FROM with TO when it appears in a directory name. This replacement is
56 done when setting up the default directory of a newly visited file.
57 *Every* FROM string should start with `^'.
59 FROM and TO should be equivalent names, which refer to the
60 same directory. Do not use `~' in the TO strings;
61 they should be ordinary absolute directory names.
63 Use this feature when you have directories which you normally refer to
64 via absolute symbolic links. Make TO the name of the link, and FROM
65 the name it is linked to."
74 "Non-nil means make a backup of a file the first time it is saved.
75 This can be done by renaming the file or by copying.
77 Renaming means that Emacs renames the existing file so that it is a
78 backup file, then writes the buffer into a new file. Any other names
79 that the old file had will now refer to the backup file. The new file
80 is owned by you and its group is defaulted.
82 Copying means that Emacs copies the existing file into the backup
83 file, then writes the buffer on top of the existing file. Any other
84 names that the old file had will now refer to the new (edited) file.
85 The file's owner and group are unchanged.
87 The choice of renaming or copying is controlled by the variables
88 `backup-by-copying', `backup-by-copying-when-linked',
89 `backup-by-copying-when-mismatch' and
90 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
94 ;; Do this so that local variables based on the file name
95 ;; are not overridden by the major mode.
97 "Non-nil means don't make a backup, regardless of the other parameters.
98 This variable is intended for use by making it local to a buffer.
103 "Non-nil means always use copying to create backup files.
104 See documentation of variable `make-backup-files'."
109 "Non-nil means use copying to create backups for files with multiple names.
110 This causes the alternate names to refer to the latest version as edited.
111 This variable is relevant only if `backup-by-copying' is nil."
116 "Non-nil means create backups by copying if this preserves owner or group.
117 Renaming may still be used (subject to control of other variables)
118 when it would not result in changing the owner or group of the file;
119 that is, for files which are owned by you and whose group matches
120 the default for a new file created there by you.
121 This variable is relevant only if `backup-by-copying' is nil."
126 "Non-nil means create backups by copying to preserve a privileged owner.
127 Renaming may still be used (subject to control of other variables)
128 when it would not result in changing the owner of the file or if the owner
129 has a user id greater than the value of this variable. This is useful
130 when low-numbered uid's are used for special system users (such as root)
131 that must maintain ownership of certain files.
132 This variable is relevant only if `backup-by-copying' and
133 `backup-by-copying-when-mismatch' are nil."
138 "Predicate that looks at a file name and decides whether to make backups.
142 "Non-nil in a buffer means always offer to save buffer on exit.
143 Do so even if the buffer is not visiting a file.
144 Automatically local in all buffers."
150 "Non-nil means find a file under alternative names, in existing buffers.
151 This means if any existing buffer is visiting the file you want
152 under another name, you get the existing buffer instead of a new buffer."
157 "Non-nil means visit a file under its truename.
158 The truename of a file is found by chasing all links
159 both at the file level and at the levels of the containing directories."
165 "Specify which files should be reverted without query.
166 The value is a list of regular expressions.
167 If the file name matches one of these regular expressions,
168 then `revert-buffer' reverts the file without querying
169 if the file has changed on disk and you have not edited the buffer."
174 "The device number and file number of the file visited in the current buffer.
175 The value is a list of the form (FILENUM DEVNUM).
176 This pair of numbers uniquely identifies the file.
194 "The directory for writing temporary files."
200 "The directory for writing small temporary files.
201 If non-nil, this directory is used instead of `temporary-file-directory'
202 by programs that create small temporary files. This is for systems that
203 have fast storage with limited space, such as a RAM disk."
207 ;; The system null device. (Should reference NULL_DEVICE from C.)
232 "Non-nil means protect against I/O errors while saving files.
233 Some modes set this non-nil in particular buffers.
235 This feature works by writing the new contents into a temporary file
236 and then renaming the temporary file to replace the original.
237 In this way, any I/O error in writing leaves the original untouched,
238 and there is never any instant where the file is nonexistent.
240 Note that this feature forces backups to be made by copying.
241 Yet, at the same time, saving a precious file
242 breaks any hard links between it and other files."
247 "Control use of version numbers for backup files.
248 When t, make numeric backup versions unconditionally.
249 When nil, make them for files that have some already.
250 The value `never' means do not make them."
260 "When cleaning directory, number of versions to keep."
266 "If t, delete excess backup versions silently.
267 If nil, ask confirmation. Any other value prevents any trimming."
274 "Number of oldest versions to keep when a new numbered backup is made."
280 "Number of newest versions to keep when a new numbered backup is made.
281 Includes the new backup. Must be > 0"
287 "Whether to add a newline automatically at the end of the file.
289 A value of t means do this only when the file is about to be saved.
290 A value of `visit' means do this right after the file is visited.
291 A value of `visit-save' means do it at both of those times.
292 Any other non-nil value means ask user whether to add a newline, when saving.
293 A value of nil means don't add newlines.
295 Certain major modes set this locally to the value obtained
296 from `mode-require-final-newline'."
305 "Whether to add a newline at end of file, in certain major modes.
306 Those modes set `require-final-newline' to this value when you enable them.
307 They do so because they are often used for files that are supposed
308 to end in newlines, and the question is how to arrange that.
310 A value of t means do this only when the file is about to be saved.
311 A value of `visit' means do this right after the file is visited.
312 A value of `visit-save' means do it at both of those times.
313 Any other non-nil value means ask user whether to add a newline, when saving.
315 A value of nil means do not add newlines. That is a risky choice in this
316 variable since this value is used for modes for files that ought to have
317 final newlines. So if you set this to nil, you must explicitly check and
318 add a final newline, whenever you save a file that really needs one."
328 "Non-nil says by default do auto-saving of every file-visiting buffer."
334 ;; Don't put "\\2" inside expand-file-name, since it will be
335 ;; transformed to "/2" on DOS/Windows.
337 "Transforms to apply to buffer file name before making auto-save file name.
338 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
339 REGEXP is a regular expression to match against the file name.
340 If it matches, `replace-match' is used to replace the
341 matching part with REPLACEMENT.
342 If the optional element UNIQUIFY is non-nil, the auto-save file name is
343 constructed by taking the directory part of the replaced file-name,
344 concatenated with the buffer file name with all directory separators
345 changed to `!' to prevent clashes. This will not work
346 correctly if your filesystem truncates the resulting name.
348 All the transforms in the list are tried, in the order they are listed.
349 When one transform applies, its result is final;
350 no further transforms are tried.
352 The default value is set up to put the auto-save file into the
353 temporary directory (see the variable `temporary-file-directory') for
354 editing a remote file.
356 On MS-DOS filesystems without long names this variable is always
357 ignored."
364 "Non-nil means save word abbrevs too when files are saved.
365 If `silently', don't ask the user before saving."
370 "Non-nil means allow `find-file' to visit directories.
371 To visit the directory, `find-file' runs `find-directory-functions'."
376 "List of functions to try in sequence to visit a directory.
377 Each function is called with the directory name as the sole argument
378 and should return either a buffer or nil."
382 ;;;It is not useful to make this a local variable.
383 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
385 "List of functions to be called for `find-file' on nonexistent file.
386 These functions are called as soon as the error is detected.
387 Variable `buffer-file-name' is already set up.
392 ;;;It is not useful to make this a local variable.
393 ;;;(put 'find-file-hooks 'permanent-local t)
396 "List of functions to be called after a buffer is loaded from a file.
397 The buffer's local variables (if any) will have been processed before the
398 functions are called."
405 "List of functions to be called before writing out a buffer to a file.
406 If one of them returns non-nil, the file is considered already written
407 and the rest are not called.
408 These hooks are considered to pertain to the visited file.
409 So any buffer-local binding of this variable is discarded if you change
411 change the major mode.
413 This hook is not run if any of the functions in
414 `write-contents-functions' returns non-nil. Both hooks pertain
415 to how to save a buffer to file, for instance, choosing a suitable
416 coding system and setting mode bits. (See Info
417 node `(elisp)Saving Buffers'.) To perform various checks or
428 "List of functions to be called before writing out a buffer to a file.
429 If one of them returns non-nil, the file is considered already written
430 and the rest are not called and neither are the functions in
431 `write-file-functions'.
433 This variable is meant to be used for hooks that pertain to the
434 buffer's contents, not to the particular visited file; thus,
435 `set-visited-file-name' does not clear this variable; but changing the
436 major mode does clear it.
438 For hooks that _do_ pertain to the particular visited file, use
439 `write-file-functions'. Both this variable and
440 `write-file-functions' relate to how a buffer is saved to file.
441 To perform various checks or updates before the buffer is saved,
448 "Control use of local variables in files you visit.
449 The value can be t, nil, :safe, :all, or something else.
451 A value of t means file local variables specifications are obeyed
452 if all the specified variable values are safe; if any values are
453 not safe, Emacs queries you, once, whether to set them all.
454 \(When you say yes to certain values, they are remembered as safe.)
456 :safe means set the safe variables, and ignore the rest.
457 :all means set all variables, whether safe or not.
458 (Don't set it permanently to :all.)
459 A value of nil means always ignore the file local variables.
461 Any other value means always query you once whether to set them all.
462 \(When you say yes to certain values, they are remembered as safe, but
465 This variable also controls use of major modes specified in
466 a -*- line.
469 always obeys file local variable specifications and the -*- line,
470 and ignores this variable."
479 "Like `enable-local-variables' but meant for buffer-local bindings.
480 The meaningful values are nil and non-nil. The default is non-nil.
481 If a major mode sets this to nil, buffer-locally, then any local
482 variables list in the file will be ignored.
484 This variable does not affect the use of major modes
489 The value can be t, nil or something else.
490 A value of t means obey `eval' variables.
491 A value of nil means ignore them; anything else means query."
497 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
506 "Non-nil means buffers visiting files read-only do so in view mode.
507 In fact, this means that all read-only buffers normally have
508 View mode enabled, including buffers that are read-only because
509 you visit a file you cannot alter, and buffers you make read-only
515 "History list of file names entered in the minibuffer.
517 Maximum length of the history list is determined by the value
519 \f
522 "Provides support for ange-ftp host name completion.
523 Runs the usual ange-ftp hook, but only for completion operations."
524 ;; Having this here avoids the need to load ange-ftp when it's not
525 ;; really in use.
531 inhibit-file-name-handlers)))
536 "Convert a standard file's name to something suitable for the OS.
537 This means to guarantee valid names and perhaps to canonicalize
538 certain patterns.
540 FILENAME should be an absolute file name since the conversion rules
541 sometimes vary depending on the position in the file name. E.g. c:/foo
542 is a valid DOS file name, but c:/bar/c:/foo is not.
544 This function's standard definition is trivial; it just returns
545 the argument. However, on Windows and DOS, replace invalid
546 characters. On DOS, make sure to obey the 8.3 limitations.
547 In the native Windows build, turn Cygwin names into native names,
548 and also turn slashes into backslashes if the shell requires it (see
549 `w32-shell-dos-semantics').
551 See Info node `(elisp)Standard File Names' for more details."
555 ;; Replace invalid filename characters with !
559 name)
560 filename))
563 "Read directory name, prompting with PROMPT and completing in directory DIR.
564 Value is not expanded---you must call `expand-file-name' yourself.
565 Default name to DEFAULT-DIRNAME if user exits with the same
566 non-empty string that was inserted by this function.
567 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
568 or just DIR if INITIAL is nil.)
569 If the user exits with an empty minibuffer, this function returns
570 an empty string. (This can only happen if the user erased the
571 pre-inserted contents or if `insert-default-directory' is nil.)
572 Fourth arg MUSTMATCH non-nil means require existing directory's name.
573 Non-nil and non-t means also require confirmation after completion.
574 Fifth arg INITIAL specifies text to start with.
575 DIR should be an absolute directory name. It defaults to
576 the value of `default-directory'."
581 dir))
582 mustmatch initial
585 \f
587 "Show the current default directory."
592 "Value of the CDPATH environment variable, as a list.
596 "Explode a search path into a list of directory names.
597 Directories are separated by occurrences of `path-separator'
598 \(which is colon in GNU and GNU-like systems)."
599 ;; We could use split-string here.
607 nil
612 cd-list)))
615 "Change current directory to given absolute file name DIR."
616 ;; Put the name into directory syntax now,
617 ;; because otherwise expand-file-name may give some bad results.
630 "Make DIR become the current buffer's default directory.
631 If your environment includes a `CDPATH' variable, try each one of
632 that list of directories (separated by occurrences of
633 `path-separator') when resolving a relative directory name.
634 The path separator is colon in GNU and GNU-like systems."
637 default-directory default-directory
653 cd-path)
654 nil))
658 "Load the Lisp file named FILE."
659 ;; This is a case where .elc makes a lot of sense.
666 "Search for FILENAME through PATH.
667 If found, return the absolute file name of FILENAME, with its suffixes;
668 otherwise return nil.
669 PATH should be a list of directories to look in, like the lists in
670 `exec-path' or `load-path'.
671 If SUFFIXES is non-nil, it should be a list of suffixes to append to
674 If non-nil, PREDICATE is used instead of `file-readable-p'.
675 PREDICATE can also be an integer to pass to the `access' system call,
676 in which case file-name handlers are ignored. This usage is deprecated.
678 For compatibility, PREDICATE can also be one of the symbols
679 `executable', `readable', `writable', or `exists', or a list of
680 one or more of those symbols."
691 "Do completion for file names passed to `locate-file'."
712 "Do completion for file names passed to `locate-file'.
713 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
716 string nil action))
721 "Regexp of directory names which stop the search in `locate-dominating-file'.
722 Any directory whose name matches this regexp will be treated like
723 a kind of root directory by `locate-dominating-file' which will stop its search
724 when it bumps into it.
725 The default regexp prevents fruitless and time-consuming attempts to find
728 ;; (defun locate-dominating-files (file regexp)
729 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
730 ;; Stop at the first parent where a matching file is found and return the list
731 ;; of files that that match in this directory."
732 ;; (catch 'found
733 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
734 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
735 ;; (let ((user nil)
736 ;; ;; Abbreviate, so as to stop when we cross ~/.
737 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
738 ;; files)
739 ;; (while (and dir
740 ;; ;; As a heuristic, we stop looking up the hierarchy of
741 ;; ;; directories as soon as we find a directory belonging to
742 ;; ;; another user. This should save us from looking in
743 ;; ;; things like /net and /afs. This assumes that all the
744 ;; ;; files inside a project belong to the same user.
745 ;; (let ((prev-user user))
746 ;; (setq user (nth 2 (file-attributes dir)))
747 ;; (or (null prev-user) (equal user prev-user))))
748 ;; (if (setq files (condition-case nil
749 ;; (directory-files dir 'full regexp 'nosort)
750 ;; (error nil)))
751 ;; (throw 'found files)
752 ;; (if (equal dir
753 ;; (setq dir (file-name-directory
754 ;; (directory-file-name dir))))
755 ;; (setq dir nil))))
756 ;; nil)))
759 "Look up the directory hierarchy from FILE for a file named NAME.
760 Stop at the first parent directory containing a file NAME,
761 and return the directory. Return nil if not found."
762 ;; We used to use the above locate-dominating-files code, but the
763 ;; directory-files call is very costly, so we're much better off doing
764 ;; multiple calls using the code in here.
765 ;;
766 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
767 ;; `name' in /home or in /.
771 ;; `user' is not initialized outside the loop because
772 ;; `file' may not exist, so we may have to walk up part of the
773 ;; hierarchy before we find the "initial UID".
775 try)
778 ;; FIXME: Disabled this heuristic because it is sometimes
779 ;; inappropriate.
780 ;; As a heuristic, we stop looking up the hierarchy of
781 ;; directories as soon as we find a directory belonging
782 ;; to another user. This should save us from looking in
783 ;; things like /net and /afs. This assumes that all the
784 ;; files inside a project belong to the same user.
785 ;; (let ((prev-user user))
786 ;; (setq user (nth 2 (file-attributes file)))
787 ;; (and prev-user (not (equal user prev-user))))
795 root))
799 "Search for COMMAND in `exec-path' and return the absolute file name.
800 Return nil if COMMAND is not found anywhere in `exec-path'."
801 ;; Use 1 rather than file-executable-p to better match the behavior of
802 ;; call-process.
806 "Load the library named LIBRARY.
807 This is an interface to the function `load'."
811 load-path
816 "Test whether FILE specifies a location on a remote system.
817 Returns nil or a string identifying the remote connection (ideally
818 a prefix of FILE). For example, the remote identification for filename
821 less reliable than accessing local files.
822 Furthermore, relative file names do not work across remote connections.
824 IDENTIFICATION specifies which part of the identification shall
825 be returned as string. IDENTIFICATION can be the symbol
826 `method', `user', `host' or `localname'; any other value is
827 handled like nil and means to return the complete identification
828 string.
830 If CONNECTED is non-nil, the function returns an identification only
831 if FILE is located on a remote system, and a connection is established
832 to that remote system.
834 `file-remote-p' will never open a connection on its own."
838 nil)))
841 "Copy the file FILE into a temporary file on this machine.
842 Returns the name of the local copy, or nil, if FILE is directly
843 accessible."
844 ;; This formerly had an optional BUFFER argument that wasn't used by
845 ;; anything.
849 nil)))
852 "Return the truename of FILENAME, which should be absolute.
853 The truename of a file name is found by chasing symbolic links
854 both at the level of the file and at the level of the directories
855 containing it, until no links are left at any level.
858 ;; COUNTER and PREV-DIRS are only used in recursive calls.
859 ;; COUNTER can be a cons cell whose car is the count of how many
860 ;; more links to chase before getting an error.
861 ;; PREV-DIRS can be a cons cell whose car is an alist
862 ;; of truenames we've just recently computed.
876 ;; For speed, remove the ange-ftp completion handler from the list.
877 ;; We know it's not needed here.
878 ;; For even more speed, do this only on the outermost call.
885 ;; andrewi@harlequin.co.uk - none of the following code (except for
886 ;; invoking the file-name handler) currently applies on Windows
887 ;; (ie. there are no native symlinks), but there is an issue with
888 ;; case differences being ignored by the OS, and short "8.3 DOS"
889 ;; name aliases existing for all files. (The short names are not
890 ;; reported by directory-files, but can be used to refer to files.)
891 ;; It seems appropriate for file-truename to resolve these issues in
892 ;; the most natural way, which on Windows is to call the function
893 ;; `w32-long-file-name' - this returns the exact name of a file as
894 ;; it is stored on disk (expanding short name aliases with the full
895 ;; name in the process).
898 ;; For file name that has a special handler, call handler.
899 ;; This is so that ange-ftp can save time by doing a no-op.
902 ;; If filename contains a wildcard, newname will be the old name.
904 ;; If filename exists, use the long name. If it doesn't exist,
905 ;; drill down until we find a directory that exists, and use
906 ;; the long name of that, with the extra non-existent path
907 ;; components concatenated.
909 missing rest)
912 ;; Include the preceding directory separator in the missing
913 ;; part so subsequent recursion on the rest works.
918 ""
923 ;; If this file directly leads to a link, process that iteratively
924 ;; so that we don't use lots of stack.
930 ;; For file name that has a special handler, call handler.
931 ;; This is so that ange-ftp can save time by doing a no-op.
934 done t)
936 target dirfile)
937 ;; Get the truename of the directory.
939 ;; If these are equal, we have the (or a) root directory.
941 ;; If this is the same dir we last got the truename for,
942 ;; save time--don't recalculate.
952 done t)
955 done t)
956 ;; Put it back on the file name.
958 ;; Is the file name the name of a link?
961 ;; Yes => chase that link, then start all over
962 ;; since the link may point to a directory name that uses links.
963 ;; We can't safely use expand-file-name here
964 ;; since target might look like foo/../bar where foo
965 ;; is itself a link. Instead, we handle . and .. above.
968 target
970 done nil)
971 ;; No, we are done!
973 filename))
976 "Chase links in FILENAME until a name that is not a link.
977 Unlike `file-truename', this does not check whether a parent
978 directory name is a symbolic link.
979 If the optional argument LIMIT is a number,
980 it means chase no more than that many links and then stop."
988 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
991 ;; Handle `..' by hand, since it needs to work in the
992 ;; target of any directory symlink.
993 ;; This code is not quite complete; it does not handle
994 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
998 ;; Chase links in the default dir of the symlink.
1002 ;; Now find the parent of that dir.
1006 newname))
1009 "Create a temporary file.
1010 The returned file name (created by appending some random characters at the end
1011 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1012 is guaranteed to point to a newly created empty file.
1013 You can then use `write-region' to write new data into the file.
1015 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1017 If SUFFIX is non-nil, add that at the end of the file name."
1019 file)
1022 ;; Create temp files with strict access rights. It's easy to
1023 ;; loosen them later, whereas it's impossible to close the
1024 ;; time-window of loose permissions otherwise.
1032 temporary-file-directory)
1034 temporary-file-directory))))
1040 nil)
1042 ;; the file was somehow created by someone else between
1043 ;; `make-temp-name' and `write-region', let's try again.
1044 nil)
1045 file)
1046 ;; Reset the umask.
1050 "Change the encoding of FILE's name from CODING to NEW-CODING.
1051 The value is a new name of FILE.
1052 Signals a `file-already-exists' error if a file of the new name
1053 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1054 is non-nil. A number as fourth arg means request confirmation if
1055 the new name already exists. This is what happens in interactive
1056 use with M-x."
1059 default-file-name-coding-system))
1061 from-coding to-coding)
1063 ;; We provide the default coding only when it seems that
1064 ;; the filename is correctly decoded by the default
1065 ;; coding.
1071 filename default-coding)
1072 default-coding))
1076 ;; We provide the default coding only when a user is going to
1077 ;; change the encoding not from the default coding.
1081 filename from-coding)))
1084 filename from-coding default-coding)
1085 default-coding)))
1089 default-file-name-coding-system))
1090 ;; FILE should have been decoded by DEFAULT-CODING.
1094 ;; Suppress further encoding.
1099 newname))
1100 \f
1102 "Read the name of a buffer to switch to and return as a string.
1103 It is intended for `switch-to-buffer' family of commands since they
1104 need to omit the name of current buffer from the list of completions
1105 and default values."
1112 "Select buffer BUFFER in another window.
1113 If BUFFER does not identify an existing buffer, then this function
1114 creates a buffer with that name.
1116 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
1117 or nil. If BUFFER is nil, then this function chooses a buffer
1118 using `other-buffer'.
1119 Optional second arg NORECORD non-nil means do not put this
1120 buffer at the front of the list of recently selected ones.
1121 This function returns the buffer it switched to.
1123 This uses the function `display-buffer' as a subroutine; see its
1124 documentation for additional customization information."
1128 ;; Don't let these interfere.
1129 same-window-buffer-names same-window-regexps)
1133 "Switch to buffer BUFFER in another frame.
1134 Optional second arg NORECORD non-nil means do not put this
1135 buffer at the front of the list of recently selected ones.
1136 This function returns the buffer it switched to.
1138 This uses the function `display-buffer' as a subroutine; see
1139 its documentation for additional customization information."
1143 same-window-buffer-names same-window-regexps)
1147 "Display buffer BUFFER in another frame.
1148 This uses the function `display-buffer' as a subroutine; see
1149 its documentation for additional customization information."
1152 same-window-buffer-names same-window-regexps
1154 new-window)
1156 ;; This may have been here in order to prevent the new frame from hiding
1157 ;; the old frame. But it does more harm than good.
1158 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1159 ;;(lower-frame (window-frame new-window))
1161 ;; This may have been here in order to make sure the old-frame gets the
1162 ;; focus. But not only can it cause an annoying flicker, with some
1163 ;; window-managers it just makes the window invisible, with no easy
1164 ;; way to recover it. --Stef
1165 ;;(make-frame-invisible (window-frame old-window))
1166 ;;(make-frame-visible (window-frame old-window))
1167 ))
1173 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1174 BODY should use the minibuffer at most once.
1175 Recursive uses of the minibuffer will not be affected."
1181 ;; Clear out this hook so it does not interfere
1182 ;; with any recursive minibuffer usage.
1192 "If non-nil, `find-file' requires confirmation before visiting a new file."
1204 t))
1207 "Edit file FILENAME.
1208 Switch to a buffer visiting file FILENAME,
1209 creating one if none already exists.
1210 Interactively, the default if you just type RET is the current directory,
1211 but the visited file name is available through the minibuffer history:
1212 type M-n to pull it into the minibuffer.
1214 You can visit files on remote machines by specifying something
1215 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1216 also visit local files as a different user by specifying
1217 /sudo::FILE for the file name.
1218 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1219 manual, for more about this.
1221 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1222 expand wildcards (if any) and visit multiple files. You can
1223 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1225 To visit a file without any kind of conversion and without
1236 "Edit file FILENAME, in another window.
1239 an existing one. See the function `display-buffer'.
1241 Interactively, the default if you just type RET is the current directory,
1242 but the visited file name is available through the minibuffer history:
1243 type M-n to pull it into the minibuffer.
1245 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1246 expand wildcards (if any) and visit multiple files."
1259 "Edit file FILENAME, in another frame.
1262 an existing one. See the function `display-buffer'.
1264 Interactively, the default if you just type RET is the current directory,
1265 but the visited file name is available through the minibuffer history:
1266 type M-n to pull it into the minibuffer.
1268 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1269 expand wildcards (if any) and visit multiple files."
1282 "Edit the existing file FILENAME.
1284 file names with wildcards."
1292 "Edit file FILENAME but don't allow changes.
1306 value))
1309 "Edit file FILENAME in another window but don't allow changes.
1323 value))
1326 "Edit file FILENAME in another frame but don't allow changes.
1340 value))
1343 "Find file FILENAME as a replacement for the file in the next window.
1344 This command does not select that window.
1348 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1349 expand wildcards (if any) and replace the file with multiple files."
1361 t))))
1369 "Find file FILENAME, select its buffer, kill previous buffer.
1370 If the current buffer now contains an empty file that you just visited
1371 \(presumably by mistake), use this command to visit the file you really want.
1375 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1376 expand wildcards (if any) and replace the file with multiple files.
1378 If the current buffer is an indirect buffer, or the base buffer
1379 for one or more indirect buffers, the other buffer(s) are not
1380 killed."
1390 t)))
1411 ;; This prevents us from finding the same buffer
1412 ;; if we specified the same file again.
1416 ;; Likewise for dired buffers.
1420 ;; This executes if find-file gets an error
1421 ;; and does not really find anything.
1422 ;; We put things back as they were.
1423 ;; If find-file actually finds something, we kill obuf below.
1432 ;; We already asked; don't ask again.
1435 \f
1437 "Create a suitably named buffer for visiting FILENAME, and return it.
1438 FILENAME (sans directory) is used unchanged if that name is free;
1439 otherwise a string <2> or <3> or ... is appended to get an unused name.
1440 Spaces at the start of FILENAME (sans directory) are removed."
1449 "Create and return a buffer with a name based on NAME.
1450 Choose the buffer's name using `generate-new-buffer-name'."
1454 "Regexp to match the automounter prefix in a directory name."
1462 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1464 home directory is a root directory) and removes automounter prefixes
1465 \(see the variable `automount-dir-prefix')."
1466 ;; Get rid of the prefixes added by the automounter.
1473 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1474 ;; To fix this right, we need a `file-name-case-sensitive-p'
1475 ;; function, but we don't have that yet, so just guess.
1478 ;; If any elt of directory-abbrev-alist matches this name,
1479 ;; abbreviate accordingly.
1485 ;; Compute and save the abbreviated homedir name.
1486 ;; We defer computing this until the first time it's needed, to
1487 ;; give time for directory-abbrev-alist to be set properly.
1488 ;; We include a slash at the end, to avoid spurious matches
1489 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1496 ;; If FILENAME starts with the abbreviated homedir,
1497 ;; make it start with `~' instead.
1499 ;; If the home dir is just /, don't change it.
1502 ;; MS-DOS root directories can come with a drive letter;
1503 ;; Novell Netware allows drive letters beyond `Z:'.
1513 filename)))
1516 "List of logical names for which visiting shouldn't save the true dirname."
1521 "Return the buffer visiting file FILENAME (a string).
1522 This is like `get-file-buffer', except that it checks for any buffer
1523 visiting the same file, possibly under a different name.
1524 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1525 and others are ignored.
1526 If there is no such live buffer, return nil."
1540 found)
1550 ;; Verify this buffer's file number
1551 ;; still belongs to its file.
1554 attributes)
1558 found))))
1559 \f
1561 "Non-nil means file-visiting commands should handle wildcards.
1562 For example, if you specify `*.c', that would visit all the files
1563 whose names match the pattern."
1569 "Non-nil means suppress warning messages for symlinked files.
1570 When nil, Emacs prints a warning when visiting a file that is already
1571 visited, but with a different name. Setting this option to t
1572 suppresses this warning."
1578 "Maximum size of file above which a confirmation is requested.
1579 When nil, never request confirmation."
1586 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1587 OP-TYPE specifies the file operation being performed (for message to user)."
1597 "Read file FILENAME into a buffer and return the buffer.
1598 If a buffer exists visiting FILENAME, return that one, but
1599 verify that the file has not changed since visited or saved.
1600 The buffer is not selected, just returned to the caller.
1601 Optional second arg NOWARN non-nil means suppress any warning messages.
1602 Optional third arg RAWFILE non-nil means the file is read literally.
1603 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1604 and visit all the matching files. When wildcards are actually
1605 used and expanded, return a list of buffers that are visiting
1606 the various files."
1613 'find-directory-functions
1616 filename)))
1619 find-file-wildcards
1633 ;; Find any buffer for a file which has same truename.
1635 ;; Let user know if there is a buffer with the same truename.
1639 find-file-suppress-same-file-warnings
1643 ;; Optionally also find that buffer.
1646 ;; Check to see if the file looks uncommonly large.
1650 ;; We are using an existing buffer.
1657 ;; Certain files should be reverted automatically
1658 ;; if they have changed on disk and not in the buffer.
1666 found))
1676 "File %s changed on disk. Discard your edits? "
1681 "File %s changed on disk. Discard your edits in %s? "
1689 ;; Check if a formerly read-only file has become
1690 ;; writable and vice versa, but if the buffer agrees
1691 ;; with the new state of the file, that is ok too.
1699 buffer-file-name
1708 ;; It is confusing to ask whether to visit
1709 ;; non-literally if they have the file in
1710 ;; hexl-mode.
1716 "The file %s is already visited normally,
1717 and you have edited the buffer. Now you have asked to visit it literally,
1718 meaning no coding system handling, format conversion, or local variables.
1719 Emacs can only visit a file in one way at a time.
1721 Do you want to save the file, and visit it literally instead? "
1722 "The file %s is already visited literally,
1723 meaning no coding system handling, format conversion, or local variables.
1724 You have edited the buffer. Now you have asked to visit the file normally,
1725 but Emacs can only visit a file in one way at a time.
1732 rawfile truename number))
1736 "\
1737 Do you want to discard your changes, and visit the file literally now? "
1738 "\
1741 rawfile truename number)
1747 "The file %s is already visited normally.
1748 You have asked to visit it literally,
1749 meaning no coding system decoding, format conversion, or local variables.
1750 But Emacs can only visit a file in one way at a time.
1752 Do you want to revisit the file literally now? "
1753 "The file %s is already visited literally,
1754 meaning no coding system decoding, format conversion, or local variables.
1755 You have asked to visit it normally,
1756 but Emacs can only visit a file in one way at a time.
1761 rawfile truename number)
1764 ;; Return the buffer we are using.
1765 buf)
1766 ;; Create a new buffer.
1768 ;; find-file-noselect-1 may use a different buffer.
1770 rawfile truename number))))))
1776 ;; Needed in case we are re-visiting the file with a different
1777 ;; text representation.
1794 filename)))
1795 ;; Unconditionally set error
1805 filename)))
1806 ;; Run find-file-not-found-functions until one returns non-nil.
1808 ;; If they fail too, set error.
1810 ;; Record the file's truename, and maybe use that as visited name.
1818 ;; Set buffer's default directory to that of the file.
1820 ;; Turn off backup files for certain file names. Since
1821 ;; this is a permanent local, the major mode won't eliminate it.
1836 \f
1838 "Like `insert-file-contents', but only reads in the file literally.
1839 A buffer may be modified in several ways after reading into the buffer,
1840 to Emacs features such as format decoding, character code
1841 conversion, `find-file-hook', automatic uncompression, etc.
1843 This function ensures that none of these modifications will take place."
1851 nil))
1854 inhibit-file-name-handlers))
1867 filename)))
1868 ;; Check whether the file is uncommonly large
1879 "Insert contents of file FILENAME into buffer after point with no conversion.
1881 This function is meant for the user to run interactively.
1882 Don't call it from programs! Use `insert-file-contents-literally' instead.
1883 \(Its calling sequence is different; see its documentation)."
1888 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1893 "Visit file FILENAME with no conversion of any kind.
1894 Format conversion and character code conversion are both disabled,
1895 and multibyte characters are disabled in the resulting buffer.
1896 The major mode used is Fundamental mode regardless of the file name,
1897 and local variable specifications in the file are ignored.
1898 Automatic uncompression and adding a newline at the end of the
1899 file due to `require-final-newline' is also disabled.
1901 You cannot absolutely rely on this function to result in
1902 visiting the file literally. If Emacs already has a buffer
1903 which is visiting the file, you get the existing buffer,
1904 regardless of whether it was created literally or not.
1906 In a Lisp program, if you want to be sure of accessing a file's
1907 contents literally, you should create a temporary buffer and then read
1908 the file contents into it using `insert-file-contents-literally'."
1911 \f
1915 after-find-file-from-revert-buffer
1916 nomodes)
1917 "Called after finding a file and by the default revert function.
1918 Sets buffer mode, parses local variables.
1919 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1920 error in reading the file. WARN non-nil means warn if there
1921 exists an auto-save file more recent than the visited file.
1922 NOAUTO means don't mess with auto-save mode.
1923 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1924 means this call was from `revert-buffer'.
1925 Fifth arg NOMODES non-nil means don't alter the file's modes.
1926 Finishes by calling the functions in `find-file-hook'
1927 unless NOMODES is non-nil."
1930 nil
1940 ;; No need to warn if buffer is auto-saved
1941 ;; under the name of the visited file.
1943 auto-save-visited-file-name))
1946 buffer-file-name))
1966 ;; Make people do a little extra work (C-x C-q)
1967 ;; before altering a backup file.
1970 ;; When a file is marked read-only,
1971 ;; make the buffer read-only even if root is looking at it.
1979 ;; If requested, add a newline at the end of the file.
1989 view-read-only
1995 "Eval BODY and turn any error into a FORMAT message.
1996 FORMAT can have a %s escape which will be replaced with the actual error.
1997 If `debug-on-error' is set, errors are not caught, so that you can
1998 debug them.
1999 Avoid using a large BODY since it is duplicated."
2008 "Choose the major mode for this buffer automatically.
2009 Also sets up any specified local variables of the file.
2010 Uses the visited file name, the -*- line, and the local variables spec.
2012 This function is called automatically from `find-file'. In that case,
2013 we may set up the file-specified mode and local variables,
2014 depending on the value of `enable-local-variables'.
2015 In addition, if `local-enable-local-variables' is nil, we do
2016 not set local variables (though we do notice a mode specified with -*-.)
2018 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2019 or from Lisp without specifying the optional argument FIND-FILE;
2020 in that case, this function acts as if `enable-local-variables' were t."
2028 ;; Turn font lock off and on, to make sure it takes account of
2029 ;; whatever file local variables are relevant to it.
2031 ;; Font-lock-mode (now in font-core.el) can be ON when
2032 ;; font-lock.el still hasn't been loaded.
2042 "Non-nil means to try second pass through `auto-mode-alist'.
2043 This means that if the first case-sensitive search through the alist fails
2044 to find a matching major mode, a second case-insensitive search is made.
2045 On systems with case-insensitive file names, this variable is ignored,
2046 since only a single case-insensitive search through the alist is made."
2052 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2053 ;; c++-mode, java-mode and more) are added through autoload
2054 ;; directives in that file. That way is discouraged since it
2055 ;; spreads out the definition of the initial value.
2088 ;; Less common extensions come here
2089 ;; so more common ones above are found faster.
2128 ;; The list of archive file extensions should be in sync with
2129 ;; `auto-coding-alist' with `no-conversion' coding system.
2135 ;; Mailer puts message to be edited in
2136 ;; /tmp/Re.... or Message
2140 ;; some news reader is reported to use this
2149 ;; .emacs or .gnus or .viper following a directory delimiter in
2150 ;; Unix, MSDOG or VMS syntax.
2153 ;; _emacs following a directory delimiter
2154 ;; in MsDos syntax
2158 ;; Common Lisp ASDF package system.
2177 ;; Windows candidates may be opened case sensitively on Unix
2183 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2185 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2186 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2187 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2188 ;; this has lower priority to avoid matching changelog.sgml etc.
2190 ;; either user's dot-files or under /etc or some such
2192 ;; alas not all ~/.*rc files are like this
2193 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2198 ;; this contains everything twice, with space and with colon :-(
2200 ;; Get rid of any trailing .n.m and try again.
2201 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2202 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2203 ;; Using mode nil rather than `ignore' would let the search continue
2204 ;; through this list (with the shortened name) rather than start over.
2206 ;; The following should come after the ChangeLog pattern
2207 ;; for the sake of ChangeLog.1, etc.
2208 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2211 "Alist of filename patterns vs corresponding major mode functions.
2212 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2213 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2214 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2215 mode function to use. FUNCTION will be called, unless it is nil.
2217 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2218 calling FUNCTION (if it's not nil), we delete the suffix that matched
2219 REGEXP and search the list again for another match.
2221 If the file name matches `inhibit-first-line-modes-regexps',
2222 then `auto-mode-alist' is not processed.
2224 The extensions whose FUNCTION is `archive-mode' should also
2225 appear in `auto-coding-alist' with `no-conversion' coding system.
2227 See also `interpreter-mode-alist', which detects executable script modes
2228 based on the interpreters they specify to run,
2232 "Select Conf mode or XML mode according to start of file."
2242 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2243 ;; and pike-mode) are added through autoload directives in that
2244 ;; file. That way is discouraged since it spreads out the
2245 ;; definition of the initial value.
2283 "Alist mapping interpreter names to major modes.
2284 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2285 Each element looks like (INTERPRETER . MODE).
2286 If INTERPRETER matches the name of the interpreter specified in the first line
2287 of a script, mode MODE is enabled.
2295 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2296 When checking `inhibit-first-line-modes-regexps', we first discard
2302 "Regexp matching interpreters, for file mode determination.
2303 This regular expression is matched against the first line of a file
2304 to determine the file's mode in `set-auto-mode'. If it matches, the file
2305 is assumed to be interpreted by the interpreter matched by the second group
2306 of the regular expression. The mode is then determined as the mode
2310 "Alist of buffer beginnings vs. corresponding major mode functions.
2311 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2312 After visiting a file, if REGEXP matches the text at the beginning of the
2313 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2314 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2315 major mode.
2317 If FUNCTION is nil, then it is not called. (That is a way of saying
2323 ;; The < comes before the groups (but the first) to reduce backtracking.
2324 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2325 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2329 comment-re "*"
2332 . html-mode)
2334 ;; These two must come after html, because they are more general:
2339 . sgml-mode)
2342 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2343 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2344 After visiting a file, if REGEXP matches the text at the beginning of the
2345 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2346 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2347 have not specified a mode for this file.
2353 "Upper limit on `magic-mode-alist' regexp matches.
2357 "Select major mode appropriate for current buffer.
2359 To find the right major mode, this function checks for a -*- mode tag,
2360 checks if it uses an interpreter listed in `interpreter-mode-alist',
2361 matches the buffer beginning against `magic-mode-alist',
2362 compares the filename against the entries in `auto-mode-alist',
2363 then matches the buffer beginning against `magic-fallback-mode-alist'.
2365 It does not check for the `mode:' local variable in the
2366 Local Variables section of the file; for that, use `hack-local-variables'.
2368 If `enable-local-variables' is nil, this function does not check for a
2369 -*- mode tag.
2371 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2372 set the major mode only if that would change it. In other words
2373 we don't actually set it to the same mode the buffer already has."
2374 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2376 ;; Find a -*- mode tag
2383 ;; Find all specifications for the `mode:' variable
2384 ;; and execute them left to right.
2396 modes)))
2397 ;; Simple -*-MODE-*- case.
2400 modes))))
2401 ;; If we found modes to use, invoke them now, outside the save-excursion.
2409 ;; continuing would call minor modes again, toggling them off
2411 ;; If we didn't, look for an interpreter specified in the first line.
2412 ;; As a special case, allow for things like "#!/bin/env perl", which
2413 ;; finds the interpreter anywhere in $PATH.
2420 ;; Map interpreter name to a mode, signalling we're done at the
2421 ;; same time.
2423 interpreter-mode-alist))
2424 ;; If we found an interpreter mode to use, invoke it now.
2427 ;; Next try matching the buffer beginning against magic-mode-alist.
2441 ;; Next compare the filename against the entries in auto-mode-alist.
2446 ;; Remove remote file name identification.
2450 ;; Remove backup-suffixes from file name.
2453 ;; Find first matching alist entry.
2456 ;; System is case-insensitive.
2460 ;; System is case-sensitive.
2462 ;; First match case-sensitively.
2466 ;; Fallback to case-insensitive match.
2480 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2495 ;; When `keep-mode-if-same' is set, we are working on behalf of
2496 ;; set-visited-file-name. In that case, if the major mode specified is the
2497 ;; same one we already have, don't actually reset it. We don't want to lose
2498 ;; minor modes such as Font Lock.
2500 "Apply MODE and return it.
2501 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2502 any aliases and compared to current major mode. If they are the
2503 same, do nothing and return nil."
2509 mode)))
2512 "Find the -*- spec in the buffer.
2513 Call with point at the place to start searching from.
2514 If one is found, set point to the beginning
2515 and return the position of the end.
2516 Otherwise, return nil; point may be changed."
2519 ;; Don't look for -*- if this file name matches any
2520 ;; of the regexps in inhibit-first-line-modes-regexps.
2528 sufs)
2536 ;; If the file begins with "#!"
2537 ;; (exec interpreter magic), look
2538 ;; for mode frobs in the first two
2539 ;; lines. You cannot necessarily
2540 ;; put them in the first line of
2541 ;; such a file without screwing up
2542 ;; the interpreter invocation.
2543 ;; The same holds for
2544 ;; '\"
2545 ;; in man pages (preprocessor
2546 ;; magic for the `man' program).
2557 end))))
2558 \f
2559 ;;; Handling file local variables
2563 file-local-variables-alist)
2567 "Normal hook run after processing a file's local variables specs.
2568 Major modes can use this to examine user-specified local variables
2572 "List variable-value pairs that are considered safe.
2573 Each element is a cons cell (VAR . VAL), where VAR is a variable
2574 symbol and VAL is a value that is considered safe."
2579 "Expressions that are considered safe in an `eval:' local variable.
2580 Add expressions to this list if you want Emacs to evaluate them, when
2581 they appear in an `eval' local variable specification, without first
2582 asking you for confirmation."
2587 ;; Risky local variables:
2590 auto-mode-alist
2591 buffer-auto-save-file-name
2592 buffer-file-name
2593 buffer-file-truename
2594 buffer-undo-list
2595 dabbrev-case-fold-search
2596 dabbrev-case-replace
2597 debugger
2598 default-text-properties
2599 display-time-string
2600 enable-local-eval
2601 enable-local-variables
2602 eval
2603 exec-directory
2604 exec-path
2605 file-name-handler-alist
2606 font-lock-defaults
2607 format-alist
2608 frame-title-format
2609 global-mode-string
2610 header-line-format
2611 icon-title-format
2612 ignored-local-variables
2613 imenu--index-alist
2614 imenu-generic-expression
2615 inhibit-quit
2616 input-method-alist
2617 load-path
2618 max-lisp-eval-depth
2619 max-specpdl-size
2620 minor-mode-alist
2621 minor-mode-map-alist
2622 minor-mode-overriding-map-alist
2623 mode-line-buffer-identification
2624 mode-line-format
2625 mode-line-client
2626 mode-line-modes
2627 mode-line-modified
2628 mode-line-mule-info
2629 mode-line-position
2630 mode-line-process
2631 mode-line-remote
2632 mode-name
2633 outline-level
2634 overriding-local-map
2635 overriding-terminal-local-map
2636 parse-time-rules
2637 process-environment
2638 rmail-output-file-alist
2639 safe-local-variable-values
2640 safe-local-eval-forms
2641 save-some-buffers-action-alist
2642 special-display-buffer-names
2643 standard-input
2644 standard-output
2645 unread-command-events
2646 vc-mode))
2648 ;; Safe local variables:
2649 ;;
2650 ;; For variables defined by major modes, the safety declarations can go into
2651 ;; the major mode's file, since that will be loaded before file variables are
2652 ;; processed.
2653 ;;
2654 ;; For variables defined by minor modes, put the safety declarations in the
2655 ;; file defining the minor mode after the defcustom/defvar using an autoload
2656 ;; cookie, e.g.:
2657 ;;
2658 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2659 ;;
2660 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2661 ;; minor mode file may not be loaded yet.
2662 ;;
2663 ;; For variables defined in the C source code the declaration should go here:
2679 "Alist of file-local variable settings in the current buffer.
2680 Each element in this list has the form (VAR . VALUE), where VAR
2681 is a file-local variable (a symbol) and VALUE is the value
2682 specified. The actual value in the buffer may differ from VALUE,
2687 "Normal hook run before setting file-local variables.
2688 It is called after checking for unsafe/risky variables and
2689 setting `file-local-variables-alist', and before applying the
2690 variables stored in `file-local-variables-alist'. A hook
2691 function is allowed to change the contents of this alist.
2693 This hook is called only if there is at least one file-local
2697 "Get confirmation before setting up local variable values.
2698 ALL-VARS is the list of all variables to be set up.
2699 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2700 RISKY-VARS is the list of those that are marked as risky.
2701 PROJECT is a directory name if these settings come from directory-local
2702 settings, or nil otherwise."
2704 nil
2709 prompt char)
2719 ", and variables that are risky (**)."
2727 y -- to apply the local variables list.
2731 ! -- to apply the local variables list, and permanently mark these
2743 ;; Make strings with embedded whitespace easier to read.
2751 ""
2758 done)
2767 ;; read-event returns -1 if we are in a kbd
2768 ;; macro and there are no more events in the
2769 ;; macro. In that case, attempt to get an
2770 ;; event interactively.
2778 ;; When this is called from desktop-restore-file-buffer,
2779 ;; coding-system-for-read may be non-nil. Reset it before
2780 ;; writing to .emacs.
2784 'safe-local-variable-values
2785 safe-local-variable-values))))
2792 "Return local variables specified in the -*- line.
2793 Ignore any specification for `mode:' and `coding:';
2794 `set-auto-mode' should already have handled `mode:',
2795 `set-auto-coding' should already have handled `coding:'.
2797 If MODE-ONLY is non-nil, all we do is check whether the major
2798 mode is specified, returning t if it is specified. Otherwise,
2799 return an alist of elements (VAR . VAL), where VAR is a variable
2800 and VAL is the specified value."
2804 result mode-specified)
2805 ;; Parse the -*- line into the RESULT alist.
2806 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2808 nil)
2810 ;; Simple form: "-*- MODENAME -*-". Already handled.
2812 nil)
2814 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2815 ;; (last ";" is optional).
2820 ;; There used to be a downcase here,
2821 ;; but the manual didn't say so,
2822 ;; and people want to set var names that aren't all lc.
2827 ;; It is traditional to ignore
2828 ;; case when checking for `mode' in set-auto-mode,
2829 ;; so we must do that here as well.
2830 ;; That is inconsistent, but we're stuck with it.
2831 ;; The same can be said for `coding' in set-auto-coding.
2837 'eval
2844 mode-specified
2845 result))))
2848 "Filter local variable settings, querying the user if necessary.
2849 VARIABLES is the alist of variable-value settings. This alist is
2850 filtered based on the values of `ignored-local-variables',
2851 `enable-local-eval', `enable-local-variables', and (if necessary)
2852 user interaction. The results are added to
2853 `file-local-variables-alist', without applying them.
2854 PROJECT is a directory name if these settings come from
2855 directory-local settings, or nil otherwise."
2856 ;; Strip any variables that are in `ignored-local-variables'.
2859 ;; If `enable-local-eval' is nil, strip eval "variables".
2864 ;; Find those variables that we may want to save to
2865 ;; `safe-local-variable-values'.
2870 ;; Don't query about the fake variables.
2881 ;; If caller wants only safe variables, store only these.
2886 ;; Query, unless all are known safe or the user wants no
2887 ;; querying.
2893 variables unsafe-vars risky-vars project))
2898 "Parse and put into effect this buffer's local variables spec.
2899 If MODE-ONLY is non-nil, all we do is check whether the major mode
2900 is specified, returning t if it is specified."
2903 result)
2910 ;; Look for "Local variables:" line in last page.
2918 ;; suffix is what comes after "local variables:" in its line.
2919 ;; prefix is what comes before "local variables:" in its line.
2929 beg)
2933 endpos
2939 nil t))
2940 ;; This used to be an error, but really all it means is
2941 ;; that this may simply not be a local-variables section,
2942 ;; so just ignore it.
2952 ;; Discard the prefix.
2957 ;; Discard the suffix.
2965 ;; Find the variable name; strip whitespace.
2973 val)
2974 ;; Read the variable value.
2984 'eval
2989 ;; Now we've read all the local variables.
2990 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
2992 ;; Otherwise, set the variables.
3004 "Non-nil if SYM is safe as a file-local variable with value VAL.
3005 It is safe if any of these conditions are met:
3007 * There is a matching entry (SYM . VAL) in the
3008 `safe-local-variable-values' user option.
3010 * The `safe-local-variable' property of SYM is a function that
3011 evaluates to a non-nil value with VAL as an argument."
3017 "Non-nil if SYM could be dangerous as a file-local variable.
3018 It is dangerous if either of these conditions are met:
3020 * Its `risky-local-variable' property is non-nil.
3026 ;; If this is an alias, check the base name.
3046 "Return t if it is safe to eval EXP when it is found in a file."
3048 ;; Detect certain `put' expressions.
3055 lisp-indent-function
3056 scheme-indent-function))
3057 ;; Only allow safe values (not functions).
3062 ;; Only allow indirect form specs.
3063 ;; During bootstrapping, edebug-basic-spec might not be
3064 ;; defined yet.
3068 ;; Allow expressions that the user requested.
3070 ;; Certain functions can be allowed with safe arguments
3071 ;; or can specify verification functions to try.
3079 ok))
3087 ok)))))))
3090 "Set local variable VAR with value VAL.
3091 If VAR is `mode', call `VAL-mode' as a function unless it's
3092 already the major mode."
3102 ;; Make sure the string has no text properties.
3103 ;; Some text properties can get evaluated in various ways,
3104 ;; so it is risky to put them on with a local variable list.
3108 \f
3109 ;;; Handling directory local variables, aka project settings.
3118 "Return the project variable list for project CLASS."
3122 "Collect local variable settings from MODE-ALIST.
3123 SETTINGS is the initial list of bindings.
3124 Returns the new list."
3131 ;; Need a new cons in case we setcdr later.
3135 "Collect entries from BINDING-LIST into SETTINGS.
3136 ROOT is the root directory of the project.
3137 Return the new settings list."
3145 ;; Don't include this in the previous condition, because we
3146 ;; want to filter all strings before the next condition.
3151 root settings))))
3155 settings))))))))
3158 "Declare that the project rooted at DIRECTORY is an instance of CLASS.
3159 DIRECTORY is the name of a directory, a string.
3160 CLASS is the name of a project class, a symbol.
3162 When a file beneath DIRECTORY is visited, the mode-specific
3163 settings from CLASS will be applied to the buffer. The settings
3164 for a class are defined using `define-project-bindings'."
3171 "Map the project type CLASS to a list of variable settings.
3172 CLASS is the project class, a symbol.
3173 SETTINGS is a list that declares variable settings for the class.
3174 An element in SETTINGS is either of the form:
3175 (MAJOR-MODE . ALIST)
3176 or
3177 (DIRECTORY . LIST)
3179 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3180 whose elements are of the form (VARIABLE . VALUE).
3182 In the second form, DIRECTORY is a directory name (a string), and
3183 LIST is a list of the form accepted by the function.
3185 When a file is visited, the file's class is found. A directory
3186 may be assigned a class using `set-directory-project'. Then
3187 variables are set in the file's buffer according to the class'
3188 LIST. The list is processed in order.
3190 * If the element is of the form (MAJOR-MODE . ALIST), and the
3191 buffer's major mode is derived from MAJOR-MODE (as determined
3192 by `derived-mode-p'), then all the settings in ALIST are
3193 applied. A MAJOR-MODE of nil may be used to match any buffer.
3194 `make-local-variable' is called for each variable before it is
3195 set.
3197 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3198 is an initial substring of the file's directory, then LIST is
3199 applied by recursively following these rules."
3206 "Settings file for per-project settings.
3207 Set this to nil if you don't want to load project-specific settings."
3214 "Find the settings file for FILE.
3215 This searches upward in the directory tree.
3216 If a settings file is found, the file name is returned.
3217 If the file is in a registered project, a cons from
3218 `project-directory-alist' is returned.
3219 Otherwise this returns nil."
3224 ;; `locate-dominating-file' may have abbreviated the name.
3235 settings pda)
3239 "Load a settings file and register a new project class and instance.
3240 SETTINGS-FILE is the name of the file holding the settings to apply.
3241 The new class name is the same as the directory in which SETTINGS-FILE
3242 is found. Returns the new class name."
3244 ;; We should probably store the modtime of SETTINGS-FILE and then
3245 ;; reload it whenever it changes.
3252 class-name)))
3257 "Read local variables for the current buffer based on project settings.
3258 Store the project variables in `file-local-variables-alist',
3259 without applying them."
3263 ;; Find the settings file.
3277 root-dir nil)))
3281 \f
3284 However, the mode will not be changed if
3285 \(1) a local variables list or the `-*-' line specifies a major mode, or
3287 \ not suitable for ordinary files, or
3288 \(3) the new file name does not particularly specify any mode."
3293 "Change name of file visited in current buffer to FILENAME.
3294 This also renames the buffer to correspond to the new file.
3295 The next time the buffer is saved it will go in the newly specified file.
3296 FILENAME nil or an empty string means mark buffer as not visiting any file.
3297 Remember to delete the initial contents of the minibuffer
3298 if you wish to pass an empty string as the argument.
3300 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3301 confirmation in the case where another buffer is already visiting FILENAME.
3303 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3304 the old visited file has been renamed to the new name FILENAME."
3312 nil
3327 filename)))
3337 ;; If new-name == old-name, renaming would add a spurious <2>
3338 ;; and it's considered as a feature in rename-buffer.
3344 ;; Abbreviate the file names of the buffer.
3353 nil)))
3354 ;; write-file-functions is normally used for things like ftp-find-file
3355 ;; that visit things that are not local files as if they were files.
3356 ;; Changing to visit an ordinary local file instead should flush the hook.
3361 ;; If buffer was read-only because of version control,
3362 ;; that reason is gone now, so make it writable.
3366 ;; Turn off backup files for certain file names.
3367 ;; Since this is a permanent local, the major mode won't eliminate it.
3369 backup-enable-predicate
3375 ;; If auto-save was not already on, turn it on if appropriate.
3379 ;; If auto save is on, start using a new name.
3380 ;; We deliberately don't rename or delete the old auto save
3381 ;; for the old visited file name. This is because perhaps
3382 ;; the user wants to save the new state and then compare with the
3383 ;; previous state from the auto save file.
3386 ;; Rename the old auto save file if any.
3393 ;; Update the major mode, if the file name determines it.
3395 ;; Don't change the mode if it is special.
3398 ;; Don't change the mode if the local variable list specifies it.
3404 "Write current buffer into file FILENAME.
3405 This makes the buffer visit that file, and marks it as not modified.
3407 If you specify just a directory name as FILENAME, that means to use
3408 the default file name but in that directory. You can also yank
3409 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3411 If the buffer is not already visiting a file, the default file name
3412 for the output file is the buffer name.
3414 If optional second arg CONFIRM is non-nil, this function
3415 asks for confirmation before overwriting an existing file.
3416 Interactively, confirmation is required unless you supply a prefix argument."
3417 ;; (interactive "FWrite file: ")
3421 nil nil nil nil)
3425 default-directory)
3426 nil nil))
3430 ;; If arg is just a directory,
3431 ;; use the default file name, but in that directory.
3442 ;; Make buffer writable if file is writable.
3447 ;; It's likely that the VC status at the new location is different from
3448 ;; the one at the old location.
3450 \f
3452 "Make a backup of the disk file visited by the current buffer, if appropriate.
3453 This is normally done before saving the buffer the first time.
3455 A backup may be done by renaming or by copying; see documentation of
3456 variable `make-backup-files'. If it's done by renaming, then the file is
3457 no longer accessible under its old name.
3459 The value is non-nil after a backup was made by renaming.
3460 It has the form (MODES . BACKUPNAME).
3461 MODES is the result of `file-modes' on the original
3462 file; this means that the caller, after saving the buffer, should change
3463 the modes of the new file to agree with the old modes.
3464 BACKUPNAME is the backup file name, which is the old file renamed."
3471 backup-info backupname targets setmodes)
3472 ;; If specified name is a symbolic link, chase it to the target.
3473 ;; Thus we make the backups in the directory where the real file is.
3478 ;; (if (file-directory-p buffer-file-name)
3479 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3483 ;; If have old versions to maybe delete,
3484 ;; ask the user to confirm now, before doing anything.
3485 ;; But don't actually delete til later.
3490 real-file-name)))))
3492 ;; Actually write the back up file.
3495 ; (file-symlink-p buffer-file-name)
3496 backup-by-copying
3497 ;; Don't rename a suid or sgid file.
3512 ;; rename-file should delete old backup.
3516 ;; If trouble writing the backup, write it in ~.
3521 backupname)
3525 ;; Now delete the old versions, if desired.
3532 setmodes)
3539 ;; Create temp files with strict access rights. It's easy to
3540 ;; loosen them later, whereas it's impossible to close the
3541 ;; time-window of loose permissions otherwise.
3544 ;; Try to overwrite old backup first.
3552 nil)
3554 ;; The file was somehow created by someone else between
3555 ;; `delete-file' and `copy-file', so let's try again.
3556 ;; rms says "I think there is also a possible race
3557 ;; condition for making backup files" (emacs-devel 20070821).
3558 nil)))
3559 ;; Reset the umask.
3565 "Return file NAME sans backup versions or strings.
3566 This is a separate procedure so your site-init or startup file can
3567 redefine it.
3568 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3569 we do not remove backup version numbers, only true file version numbers."
3581 "Return t if deleting FILE and rewriting it would preserve the owner."
3586 ;; Return t if the file doesn't exist, since it's true that no
3587 ;; information would be lost by an (attempted) delete and create.
3593 The extension, in a file name, is the part that follows the last `.',
3594 except that a leading `.', if any, doesn't count."
3597 directory)
3601 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3602 ;; we don't want to expand it.
3605 filename))))
3609 The extension, in a file name, is the part that follows the last `.',
3610 excluding version numbers and backup suffixes,
3611 except that a leading `.', if any, doesn't count.
3612 Return nil for extensionless file names such as `foo'.
3613 Return the empty string for file names such as `foo.'.
3615 If PERIOD is non-nil, then the returned value includes the period
3616 that delimits the extension, and if FILENAME has no extension,
3627 "A function to use instead of the default `make-backup-file-name'.
3628 A value of nil gives the default `make-backup-file-name' behavior.
3630 This could be buffer-local to do something special for specific
3631 files. If you define it, you may need to change `backup-file-name-p'
3632 and `file-name-sans-versions' too.
3634 See also `backup-directory-alist'."
3640 "Alist of filename patterns and backup directory names.
3641 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3642 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3643 relative or absolute. If it is absolute, so that all matching files
3644 are backed up into the same directory, the file names in this
3645 directory will be the full name of the file backed up with all
3646 directory separators changed to `!' to prevent clashes. This will not
3647 work correctly if your filesystem truncates the resulting name.
3649 For the common case of all backups going into one directory, the alist
3651 directory name.
3653 If this variable is nil, or it fails to match a filename, the backup
3654 is made in the original file's directory.
3656 On MS-DOS filesystems without long names this variable is always
3657 ignored."
3663 "Default `backup-enable-predicate' function.
3664 Checks for files in `temporary-file-directory',
3665 `small-temporary-file-directory', and /tmp."
3668 ;; Directory is under temporary-file-directory.
3673 ;; Directory is under /tmp.
3678 0 nil
3680 ;; Directory is under small-temporary-file-directory.
3685 "Create the non-numeric backup file name for FILE.
3686 Normally this will just be the file's name with `~' appended.
3687 Customization hooks are provided as follows.
3689 If the variable `make-backup-file-name-function' is non-nil, its value
3690 should be a function which will be called with FILE as its argument;
3691 the resulting name is used.
3693 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3694 the documentation of that variable. If the directory for the backup
3695 doesn't exist, it is created."
3709 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3711 elt backup-directory abs-backup-directory)
3716 alist nil)))
3717 ;; If backup-directory is relative, it should be relative to the
3718 ;; file's directory. By expanding explicitly here, we avoid
3719 ;; depending on default-directory.
3728 abs-backup-directory nil))))
3730 file
3734 ;; Normalize DOSish file names: downcase the drive
3735 ;; letter, if any, and replace the leading "x:" with
3736 ;; "/drive_x".
3739 ;; Replace any invalid file-name characters (for the
3740 ;; case of backing up remote files).
3744 "drive_"
3747 ""
3750 ;; Make the name unique by substituting directory
3751 ;; separators. It may not really be worth bothering about
3752 ;; doubling `!'s in the original name...
3757 backup-directory))
3762 "Return non-nil if FILE is a backup file name (numeric or not).
3763 This is a separate function so you can redefine it for customization.
3764 You may need to redefine `file-name-sans-versions' as well."
3769 ;; This is used in various files.
3770 ;; The usage of backup-extract-version-start is not very clean,
3771 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3773 "Given the name of a numeric backup file, FN, return the backup number.
3774 Uses the free variable `backup-extract-version-start', whose value should be
3775 the index in the name where the version number begins."
3782 "Find a file name for a backup file FN, and suggestions for deletions.
3783 Value is a list whose car is the name for the backup file
3784 and whose cdr is a list of old versions to consider deleting now.
3785 If the value is nil, don't make a backup.
3786 Uses `backup-directory-alist' in the same way as does
3787 `make-backup-file-name'."
3789 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3793 ;; We don't support numbered backups on plain MS-DOS
3794 ;; when long file names are unavailable.
3804 possibilities deserve-versions-p versions)
3807 base-versions
3810 possibilities)
3811 #'<)
3816 kept-old-versions
3817 kept-new-versions
3824 ;; Delete nothing if there is overflow
3825 ;; in the number of versions to keep.
3831 v))))))))))
3834 "Return number of names file FILENAME has."
3837 ;; (defun file-relative-name (filename &optional directory)
3838 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3839 ;; This function returns a relative file name which is equivalent to FILENAME
3840 ;; when used with that default directory as the default.
3841 ;; If this is impossible (which can happen on MSDOS and Windows
3842 ;; when the file name and directory use different drive names)
3843 ;; then it returns FILENAME."
3844 ;; (save-match-data
3845 ;; (let ((fname (expand-file-name filename)))
3846 ;; (setq directory (file-name-as-directory
3847 ;; (expand-file-name (or directory default-directory))))
3848 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3849 ;; ;; drive names, they can't be relative, so return the absolute name.
3850 ;; (if (and (or (eq system-type 'ms-dos)
3851 ;; (eq system-type 'cygwin)
3852 ;; (eq system-type 'windows-nt))
3853 ;; (not (string-equal (substring fname 0 2)
3854 ;; (substring directory 0 2))))
3855 ;; filename
3856 ;; (let ((ancestor ".")
3857 ;; (fname-dir (file-name-as-directory fname)))
3858 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3859 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3860 ;; (setq directory (file-name-directory (substring directory 0 -1))
3861 ;; ancestor (if (equal ancestor ".")
3862 ;; ".."
3863 ;; (concat "../" ancestor))))
3864 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3865 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3866 ;; ;; We matched within FNAME's directory part.
3867 ;; ;; Add the rest of FNAME onto ANCESTOR.
3868 ;; (let ((rest (substring fname (match-end 0))))
3869 ;; (if (and (equal ancestor ".")
3870 ;; (not (equal rest "")))
3871 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3872 ;; rest
3873 ;; (concat (file-name-as-directory ancestor) rest)))
3874 ;; ;; We matched FNAME's directory equivalent.
3875 ;; ancestor))))))
3878 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3879 This function returns a relative file name which is equivalent to FILENAME
3880 when used with that default directory as the default.
3881 If FILENAME and DIRECTORY lie on different machines or on different drives
3882 on a DOS/Windows machine, it returns FILENAME in expanded form."
3886 default-directory))))
3892 ;; Test for different drives on DOS/Windows
3894 ;; Should `cygwin' really be included here? --stef
3897 ;; Test for different remote file system identification
3899 filename
3905 directory nil nil case-fold-search))
3907 directory nil nil case-fold-search))))
3910 ".."
3912 ;; Now ancestor is empty, or .., or ../.., etc.
3914 directory nil nil case-fold-search))
3915 ;; We matched within FILENAME's directory part.
3916 ;; Add the rest of FILENAME onto ANCESTOR.
3919 ;; But don't bother with ANCESTOR if it would give us `./'.
3920 rest
3922 ;; We matched FILENAME's directory equivalent.
3923 ancestor))))))
3924 \f
3926 "Save current buffer in visited file if modified.
3927 Variations are described below.
3929 By default, makes the previous version into a backup file
3930 if previously requested or if this is the first save.
3932 to become a backup when the next save is done.
3934 unconditionally makes the previous version into a backup file.
3936 to become a backup when the next save is done,
3937 and unconditionally makes the previous version into a backup file.
3939 With a numeric argument of 0, never make the previous version
3940 into a backup file.
3942 If a file's name is FOO, the names of its numbered backup versions are
3943 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3944 Numeric backups (rather than FOO~) will be made if value of
3945 `version-control' is not the atom `never' and either there are already
3946 numeric versions of the file being backed up, or `version-control' is
3947 non-nil.
3948 We don't want excessive versions piling up, so there are variables
3949 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3950 and `kept-new-versions', which tells how many newest versions to keep.
3951 Defaults are 2 old versions and 2 new.
3952 `dired-kept-versions' controls dired's clean-directory (.) command.
3953 If `delete-old-versions' is nil, system will query user
3954 before trimming versions. Otherwise it does it silently.
3956 If `vc-make-backup-files' is nil, which is the default,
3957 no backup files are made for files managed by version control.
3958 (This is because the version control system itself records previous versions.)
3960 See the subroutine `basic-save-buffer' for more information."
3973 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3974 Normally delete only if the file was written by this Emacs since
3975 the last real save, but optional arg FORCE non-nil means delete anyway."
3989 "Normal hook that is run before a buffer is saved to its file."
3995 "Normal hook that is run after a buffer is saved to its file."
4001 "If non-nil, use this coding system for saving the buffer.
4002 More precisely, use this coding system in place of the
4003 value of `buffer-file-coding-system', when saving the buffer.
4004 Calling `write-region' for any purpose other than saving the buffer
4005 will still use `buffer-file-coding-system'; this variable has no effect
4012 "Save the current buffer in its visited file, if it has been modified.
4013 The hooks `write-contents-functions' and `write-file-functions' get a chance
4014 to do the job of saving; if they do not, then the buffer is saved in
4015 the visited file in the usual way.
4016 Before and after saving the buffer, this function runs
4017 `before-save-hook' and `after-save-hook', respectively."
4020 ;; In an indirect buffer, save its base buffer instead.
4025 setmodes)
4026 ;; If buffer has no file name, ask user for one.
4033 ;; Signal an error if the user specified the name of an
4034 ;; existing directory.
4037 filename))
4039 ;; Signal an error if the specified name refers to a
4040 ;; non-existing directory.
4070 ;; Support VC version backups.
4076 ;; If a hook returned t, file is already "written".
4077 ;; Otherwise, write it the usual way now.
4079 ;; Now we have saved the current buffer. Let's make sure
4080 ;; that buffer-file-coding-system is fixed to what
4081 ;; actually used for saving by binding it locally.
4091 ;; If the auto-save file was recent before this command,
4092 ;; delete it now.
4094 ;; Support VC `implicit' locking.
4099 ;; This does the "real job" of writing a buffer into its visited file
4100 ;; and making a backup file. This is what is normally done
4101 ;; but inhibited if one of write-file-functions returns non-nil.
4102 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4111 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4125 buffer-file-name)))
4133 ;; If file is precious, write temp name, then rename it.
4134 ;; This requires write access to the containing dir,
4135 ;; which is why we don't try it if we don't have that access.
4137 tempname succeed
4140 ;; Create temp files with strict access rights. It's easy to
4141 ;; loosen them later, whereas it's impossible to close the
4142 ;; time-window of loose permissions otherwise.
4147 ;; Try various temporary names.
4148 ;; This code follows the example of make-temp-file,
4149 ;; but it calls write-region in the appropriate way
4150 ;; for saving the buffer.
4156 ;; Pass in nil&nil rather than point-min&max
4157 ;; cause we're saving the whole buffer.
4158 ;; write-region-annotate-functions may use it.
4160 tempname nil realname
4162 nil)
4164 ;; The file was somehow created by someone else between
4165 ;; `make-temp-name' and `write-region', let's try again.
4166 nil)
4168 ;; Reset the umask.
4170 ;; If we failed, restore the buffer's modtime.
4173 ;; Since we have created an entirely new file,
4174 ;; make sure it gets the right permission bits set.
4178 buffer-file-name)))
4179 ;; We succeeded in writing the temp file,
4180 ;; so rename it.
4182 ;; If file not writable, see if we can make it writable
4183 ;; temporarily while we write it.
4184 ;; But no need to do so if we have just backed it up
4185 ;; (setmodes is set) because that says we're superseding.
4187 ;; Change the mode back, after writing.
4193 ;; Pass in nil&nil rather than point-min&max to indicate
4194 ;; we're saving the buffer rather than just a region.
4195 ;; write-region-annotate-functions may make us of it.
4197 buffer-file-name nil t buffer-file-truename)
4199 ;; If we get an error writing the new file, and we made
4200 ;; the backup by renaming, undo the backing-up.
4205 setmodes))
4208 "View the differences between BUFFER and its associated file.
4209 This requires the external program `diff' to be in your `exec-path'."
4223 ;; Display that message for 1 second so that user can read it
4224 ;; in the minibuffer.
4226 ;; return always nil, so that save-buffers-kill-emacs will not move
4227 ;; over to the next unsaved buffer when calling `d'.
4228 nil)
4231 `((?\C-r
4238 ;; Return nil to ask about BUF again.
4239 nil)
4251 ;; Return nil to ask about BUF again.
4252 nil)
4261 "Save some modified file-visiting buffers. Asks user about each one.
4262 You can answer `y' to save, `n' not to save, `C-r' to look at the
4263 buffer in question with `view-buffer' before deciding or `d' to
4264 view the differences using `diff-buffer-with-file'.
4266 Optional argument (the prefix) non-nil means save all with no questions.
4267 Optional second argument PRED determines which buffers are considered:
4268 If PRED is nil, all the file-visiting buffers are considered.
4269 If PRED is t, then certain non-file buffers will also be considered.
4270 If PRED is a zero-argument function, it indicates for each buffer whether
4271 to consider it or not when called with that buffer current.
4273 See `save-some-buffers-action-alist' if you want to
4274 change the additional actions you can take on files."
4278 files-done abbrevs-done)
4280 ;; First save any buffers that we're supposed to save unconditionally.
4281 ;; That way the following code won't ask about them.
4286 ;; Ask about those buffers that merit it,
4287 ;; and record the number thus saved.
4302 t
4314 save-some-buffers-action-alist))
4315 ;; Maybe to save abbrevs, and record whether
4316 ;; we either saved them or asked to.
4322 abbrev-file-name)))
4324 ;; Don't keep bothering user if he says no.
4329 "(Some special files were saved without asking)"
4331 \f
4333 "Mark current buffer as unmodified, not needing to be saved.
4336 It is not a good idea to use this function in Lisp programs, because it
4337 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4344 "Change whether this buffer is visiting its file read-only.
4345 With prefix argument ARG, make the buffer read-only if ARG is
4346 positive, otherwise make it writable. If visiting file read-only
4347 and `view-read-only' is non-nil, enter view mode."
4352 nil ; do nothing.
4353 ;; Toggle.
4360 ;; If view-mode is already active, `view-mode-enter' is a nop.
4372 "Insert contents of file FILENAME into buffer after point.
4373 Set mark after the inserted text.
4375 This function is meant for the user to run interactively.
4376 Don't call it from programs! Use `insert-file-contents' instead.
4377 \(Its calling sequence is different; see its documentation)."
4382 "Append the contents of the region to the end of file FILENAME.
4383 When called from a function, expects three arguments,
4384 START, END and FILENAME. START and END are buffer positions
4385 saying what text to write."
4390 "Return most recent backup file for FILENAME or nil if no backups exist."
4391 ;; `make-backup-file-name' will get us the right directory for
4392 ;; ordinary or numeric backups. It might create a directory for
4393 ;; backups as a side-effect, according to `backup-directory-alist'.
4400 tem)
4409 newest))
4412 "Rename current buffer to a similar name not already taken.
4413 This function is useful for creating multiple shell process buffers
4414 or multiple mail buffers, etc."
4422 ;; If the existing buffer name has a <NNN>,
4423 ;; which isn't part of the file name (if any),
4424 ;; then get rid of that.
4430 "Create the directory DIR and any nonexistent parent dirs.
4431 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4433 Interactively, the default choice of directory to create
4434 is the current default directory for file names.
4435 That is useful when you have visited a file in a nonexistent directory.
4437 Noninteractively, the second (optional) argument PARENTS says whether
4438 to create parent directories if they don't exist. Interactively,
4439 this happens by default."
4442 nil nil)
4443 t))
4444 ;; If default-directory is a remote directory,
4445 ;; make sure we find its make-directory handler.
4453 create-list)
4460 \f
4463 "Function to use to revert this buffer, or nil to do the default.
4464 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4469 "Function to use to insert contents when reverting this buffer.
4470 Gets two args, first the nominal file name to use,
4471 and second, t if reading the auto-save file.
4476 "Function to check whether a non-file buffer needs reverting.
4477 This should be a function with one optional argument NOCONFIRM.
4478 Auto Revert Mode passes t for NOCONFIRM. The function should return
4479 non-nil if the buffer should be reverted. A return value of
4480 `fast' means that the need for reverting was not checked, but
4481 that reverting the buffer is fast. The buffer is current when
4482 this function is called.
4484 The idea behind the NOCONFIRM argument is that it should be
4485 non-nil if the buffer is going to be reverted without asking the
4486 user. In such situations, one has to be careful with potentially
4487 time consuming operations.
4489 For more information on how this variable is used by Auto Revert mode,
4493 "Normal hook for `revert-buffer' to run before reverting.
4494 If `revert-buffer-function' is used to override the normal revert
4498 "Normal hook for `revert-buffer' to run after reverting.
4499 Note that the hook value that it runs is the value that was in effect
4500 before reverting; that makes a difference if you have buffer-local
4501 hook functions.
4503 If `revert-buffer-function' is used to override the normal revert
4509 "Replace current buffer text with the text of the visited file on disk.
4510 This undoes all changes since the file was visited or saved.
4511 With a prefix argument, offer to revert from latest auto-save file, if
4512 that is more recent than the visited file.
4514 This command also implements an interface for special buffers
4515 that contain text which doesn't come from a file, but reflects
4516 some other data instead (e.g. Dired buffers, `buffer-list'
4517 buffers). This is done via the variable `revert-buffer-function'.
4518 In these cases, it should reconstruct the buffer contents from the
4519 appropriate data.
4521 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4522 to revert from the auto-save file when this is nil. Note that the
4523 sense of this argument is the reverse of the prefix argument, for the
4524 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4525 to nil.
4527 Optional second argument NOCONFIRM means don't ask for confirmation
4528 at all. \(The variable `revert-without-query' offers another way to
4529 revert buffers without querying for confirmation.)
4531 Optional third argument PRESERVE-MODES non-nil means don't alter
4532 the files modes. Normally we reinitialize them using `normal-mode'.
4534 If the value of `revert-buffer-function' is non-nil, it is called to
4535 do all the work for this command. Otherwise, the hooks
4536 `before-revert-hook' and `after-revert-hook' are run at the beginning
4537 and the end, and if `revert-buffer-insert-file-contents-function' is
4538 non-nil, it is called instead of rereading visited file contents."
4540 ;; I admit it's odd to reverse the sense of the prefix argument, but
4541 ;; there is a lot of code out there which assumes that the first
4542 ;; argument should be t to avoid consulting the auto-save file, and
4543 ;; there's no straightforward way to encourage authors to notice a
4544 ;; reversal of the argument sense. So I'm just changing the user
4545 ;; interface, but leaving the programmatic interface the same.
4553 buffer-auto-save-file-name
4558 buffer-auto-save-file-name
4559 buffer-file-name)))
4569 file-name)))
4571 ;; If file was backed up but has changed since,
4572 ;; we shd make another backup.
4576 ;; Effectively copy the after-revert-hook status,
4577 ;; since after-find-file will clobber it.
4580 after-revert-hook))
4585 ;; Get rid of all undo records for this buffer.
4587 ;; Don't make undo records for the reversion.
4590 file-name auto-save-p)))
4593 "File %s no longer exists!"
4595 file-name))
4598 "File %s no longer readable!"
4600 file-name))
4602 ;; Bind buffer-file-name to nil
4603 ;; so that we don't try to lock the file.
4609 ;; Auto-saved file should be read by Emacs'
4610 ;; internal coding.
4613 buffer-file-coding-system-explicit))))
4615 coding-system-for-read
4617 coding-system-for-read)
4619 ;; As a coding system suitable for multibyte
4620 ;; buffer is specified, make the current
4621 ;; buffer multibyte.
4624 ;; This force after-insert-file-set-coding
4625 ;; (called from insert-file-contents) to set
4626 ;; buffer-file-coding-system to a proper value.
4629 ;; Note that this preserves point in an intelligent way.
4633 nil nil t))
4635 nil nil t)))))
4636 ;; Recompute the truename in case changes in symlinks
4637 ;; have changed the truename.
4641 ;; Run after-revert-hook as it was before we reverted.
4645 local-hook)
4648 t))))))
4651 "Recover the visited file--get contents from its last auto-save file."
4656 "Visit file FILE, but get contents from its last auto-save file."
4657 ;; Actually putting the file name in the minibuffer should be used
4658 ;; only rarely.
4659 ;; Not just because users often use the default.
4679 ;; Use insert-directory-safely, not insert-directory,
4680 ;; because these files might not exist. In particular,
4681 ;; FILE might not exist if the auto-save file was for
4682 ;; a buffer that didn't visit a file, such as "*mail*".
4683 ;; The code in v20.x called `ls' directly, so we need
4684 ;; to emulate what `ls' did in that case.
4690 ;; Keep the current buffer-file-coding-system.
4692 ;; Auto-saved file should be read with special coding.
4701 "Recover auto save files from a previous Emacs session.
4702 This command first displays a Dired buffer showing you the
4703 previous sessions that you could recover from.
4704 To choose one, move point to the proper line and then type C-c C-c.
4705 Then you'll be asked about a number of files to recover."
4715 auto-save-list-file-prefix)))
4716 t)
4725 ;; Each line starts with a space
4726 ;; so that Font Lock mode won't highlight the first character.
4735 "Choose one saved session to recover auto-save files from.
4736 This command is used in the special Dired buffer created by
4739 ;; Get the name of the session file to recover from.
4741 files
4747 ;; Read in the auto-save-list file.
4751 ;; Loop thru the text of that file
4752 ;; and get out the names of the files to recover.
4756 ;; This is a pair of lines for a non-file-visiting buffer.
4757 ;; Get the auto-save file name and manufacture
4758 ;; a "visited file name" from that.
4761 ;; If there is no auto-save file name, the
4762 ;; auto-save-list file is probably corrupted.
4775 ;; This pair of lines is a file-visiting
4776 ;; buffer. Use the visited file name.
4786 ;; Ignore a file if its auto-save file does not exist now.
4790 ;; The file contains a pair of line for each auto-saved buffer.
4791 ;; The first line of the pair contains the visited file name
4792 ;; or is empty if the buffer was not visiting a file.
4793 ;; The second line is the auto-save file name.
4801 files
4807 "Kill BUFFER if confirmed."
4815 "Kill some buffers. Asks the user whether to kill each one of them.
4816 Non-interactively, if optional argument LIST is non-nil, it
4817 specifies the list of buffers to kill, asking for approval for each one."
4825 ; if we killed the base buffer.
4832 "Kill buffers whose name matches the specified REGEXP.
4833 The optional second argument indicates whether to kill internal buffers too."
4842 \f
4844 "Toggle auto-saving of contents of current buffer.
4845 With prefix argument ARG, turn auto-saving on if positive, else off."
4850 ;; If auto-save is off because buffer has shrunk,
4851 ;; then toggling should turn it on.
4856 buffer-file-name
4858 ;; If -1 was stored here, to temporarily turn off saving,
4859 ;; turn it back on.
4865 buffer-auto-save-file-name)
4868 "Adjust current buffer's auto save file name for current conditions.
4869 Also rename any existing auto save file, if it was made in this session."
4881 "Return file name to use for auto-saves of current buffer.
4882 Does not consider `auto-save-visited-file-name' as that variable is checked
4883 before calling this function. You can redefine this for customization.
4884 See also `auto-save-file-name-p'."
4892 result uniq)
4893 ;; Apply user-specified translations
4894 ;; to the file name.
4898 filename)
4908 filename))))
4913 ;; We truncate the file name to DOS 8+3 limits
4914 ;; before doing anything else, because the regexp
4915 ;; passed to string-match below cannot handle
4916 ;; extensions longer than 3 characters, multiple
4917 ;; dots, and other atrocities.
4922 fn)
4927 "#"
4930 ;; Make sure auto-save file names don't contain characters
4931 ;; invalid for the underlying filesystem.
4933 ;; Don't modify remote (ange-ftp) filenames
4936 result))))
4938 ;; Deal with buffers that don't have any associated files. (Mail
4939 ;; mode tends to create a good number of these.)
4943 file-name)
4944 ;; Restrict the characters used in the file name to those which
4945 ;; are known to be safe on all filesystems, url-encoding the
4946 ;; rest.
4947 ;; We do this on all platforms, because even if we are not
4948 ;; running on DOS/Windows, the current directory may be on a
4949 ;; mounted VFAT filesystem, such as a USB memory stick.
4953 ;; For multibyte characters, this will produce more than
4954 ;; 2 hex digits, so is not true URL encoding.
4958 ;; Generate the file name.
4964 ;; Try a few alternative directories, to get one we can
4965 ;; write it.
4971 ;; Don't modify remote (ange-ftp) filenames
4973 ;; The call to convert-standard-filename is in case
4974 ;; buffer-name includes characters not allowed by the
4975 ;; DOS/Windows filesystems. make-temp-file writes to the
4976 ;; file it creates, so we must fix the file name _before_
4977 ;; make-temp-file is called.
4979 fname))
4981 ;; make-temp-file creates the file,
4982 ;; but we don't want it to exist until we do an auto-save.
4986 file-name)))
4989 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4990 FILENAME should lack slashes. You can redefine this for customization."
4992 \f
4994 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4995 The generated regexp will match a filename only if the filename
4996 matches that wildcard according to shell rules. Only wildcards known
4997 by `sh' are supported."
4999 ;; Copy the initial run of non-special characters.
5002 ;; If no special characters, we're almost done.
5006 j)
5008 result
5029 ;; Found "[^". Insert a `\0' character
5030 ;; (which cannot happen in a filename)
5031 ;; into the character class, so that `^'
5032 ;; is not the first character after `[',
5033 ;; and thus non-special in a regexp.
5038 ;; I don't think `]' can appear in a
5039 ;; character class in a wildcard, but
5040 ;; let's be general here.
5047 i
5060 ;; Shell wildcards should match the entire filename,
5061 ;; not its part. Make the regexp say so.
5063 \f
5065 "-CF"
5066 "Switches for `list-directory' to pass to `ls' for brief listing."
5071 "-l"
5072 "Switches for `list-directory' to pass to `ls' for verbose listing."
5077 "Expand wildcard pattern PATTERN.
5078 This returns a list of file names which match the pattern.
5080 If PATTERN is written as an absolute file name,
5081 the values are absolute also.
5083 If PATTERN is written as a relative file name, it is interpreted
5084 relative to the current default directory, `default-directory'.
5085 The file names returned are normally also relative to the current
5086 default directory. However, if FULL is non-nil, they are absolute."
5090 ;; A list of all dirs that DIRPART specifies.
5091 ;; This can be more than one dir
5092 ;; if DIRPART contains wildcards.
5097 contents)
5102 ;; Filter out "." and ".."
5107 name))
5114 this-dir-contents)
5115 this-dir-contents)
5116 contents))))
5118 contents)))
5121 "Display a list of files in or matching DIRNAME, a la `ls'.
5122 DIRNAME is globbed by the shell if necessary.
5123 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5124 Actions controlled by variables `list-directory-brief-switches'
5125 and `list-directory-verbose-switches'."
5129 nil default-directory nil)
5130 pfx)))
5132 list-directory-brief-switches))
5133 buffer)
5146 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5154 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5156 PATTERN is assumed to represent a file-name wildcard suitable for the
5157 underlying filesystem. For Unix and GNU/Linux, the characters from the
5159 the parts of the pattern which don't include wildcard characters are
5160 quoted with double quotes.
5161 Existing quote characters in PATTERN are left alone, so you can pass
5162 PATTERN that already quotes some of the special characters."
5166 ;; DOS/Windows don't allow `"' in file names. So if the
5167 ;; argument has quotes, we can safely assume it is already
5168 ;; quoted by the caller.
5170 ;; We quote [&()#$'] in case their shell is a port of a
5171 ;; Unixy shell. We quote [,=+] because stock DOS and
5172 ;; Windows shells require that in some cases, such as
5173 ;; passing arguments to batch files that use positional
5174 ;; arguments like %1.
5176 pattern
5179 end)
5196 pattern))))
5203 "Program to get the amount of free space on a file system.
5204 We assume the output has the format of `df'.
5205 The value of this variable must be just a command name or file name;
5206 if you want to specify options, use `directory-free-space-args'.
5208 A value of nil disables this feature.
5210 If the function `file-system-info' is defined, it is always used in
5211 preference to the program given by this variable."
5217 "Options to use when running `directory-free-space-program'."
5222 "Return the amount of free space on directory DIR's file system.
5223 The result is a string that gives the number of free 1KB blocks,
5224 or nil if the system call or the program which retrieve the information
5225 fail. It returns also nil when DIR is a remote directory.
5227 This function calls `file-system-info' if it is available, or invokes the
5228 program specified by `directory-free-space-program' if that is non-nil."
5230 ;; Try to find the number of free blocks. Non-Posix systems don't
5231 ;; always have df, but might have an equivalent system call.
5240 nil t nil
5241 directory-free-space-args
5242 dir)))
5243 ;; Usual format is a header line followed by a line of
5244 ;; numbers.
5249 ;; Move to the end of the "available blocks" number.
5252 ;; Copy it into AVAILABLE.
5257 ;; The following expression replaces `dired-move-to-filename-regexp'.
5261 ;; In some locales, month abbreviations are as short as 2 letters,
5262 ;; and they can be followed by ".".
5263 ;; In Breton, a month name can include a quote character.
5276 s "+"
5279 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5280 ;; omits the Kanji characters after month and day-of-month.
5281 ;; On Mac OS X 10.3, the date format in East Asian locales is
5282 ;; day-of-month digits followed by month digits.
5288 ;; The "[0-9]" below requires the previous column to end in a digit.
5289 ;; This avoids recognizing `1 may 1997' as a date in the line:
5290 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5292 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5293 ;; The ".*" below finds the last match if there are multiple matches.
5294 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5295 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5297 ;; vc dired listings provide the state or blanks between file
5298 ;; permissions and date. The state is always surrounded by
5299 ;; parantheses:
5300 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5301 ;; This is not supported yet.
5305 "Regular expression to match up to the file name in a directory listing.
5306 The default value is designed to recognize dates and times
5311 ;; insert-directory
5312 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5313 ;; FULL-DIRECTORY-P is nil.
5314 ;; The single line of output must display FILE's name as it was
5315 ;; given, namely, an absolute path name.
5316 ;; - must insert exactly one line for each file if WILDCARD or
5317 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5318 ;; before the file lines, plus optional text after the file lines.
5319 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5320 ;; allowed.
5321 ;; File lines should display the basename.
5322 ;; - must be consistent with
5323 ;; - functions dired-move-to-filename, (these two define what a file line is)
5324 ;; dired-move-to-end-of-filename,
5325 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5326 ;; dired-insert-headerline
5327 ;; dired-after-subdir-garbage (defines what a "total" line is)
5328 ;; - variable dired-subdir-regexp
5329 ;; - may be passed "--dired" as the first argument in SWITCHES.
5330 ;; Filename handlers might have to remove this switch if their
5331 ;; "ls" command does not support it.
5333 "Insert directory listing for FILE, formatted according to SWITCHES.
5334 Leaves point after the inserted text.
5335 SWITCHES may be a string of options, or a list of strings
5336 representing individual options.
5337 Optional third arg WILDCARD means treat FILE as shell wildcard.
5338 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5339 switches do not contain `d', so that a full listing is expected.
5341 This works by running a directory listing program
5342 whose name is in the variable `insert-directory-program'.
5343 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5345 When SWITCHES contains the long `--dired' option, this function
5346 treats it specially, for the sake of dired. However, the
5347 normally equivalent short `-D' option is just passed on to
5348 `insert-directory-program', as any other option."
5349 ;; We need the directory in order to find the right handler.
5354 wildcard full-directory-p)
5357 ;; Read the actual directory using `insert-directory-program'.
5358 ;; RESULT gets the status code.
5360 ;; putting text property `dired-filename, decode one
5361 ;; bunch by one to preserve that property.
5363 ;; This is to control encoding the arguments in call-process.
5367 default-file-name-coding-system))))
5370 ;; Run ls in the directory part of the file pattern
5371 ;; using the last component as argument.
5378 shell-file-name nil t nil
5379 "-c"
5381 ""
5383 insert-directory-program
5384 " -d "
5386 switches
5388 " -- "
5389 ;; Quote some characters that have
5390 ;; special meanings in shells; but
5391 ;; don't quote the wildcards--we want
5392 ;; them to be special. We also
5393 ;; currently don't quote the quoting
5394 ;; characters in case people want to
5395 ;; use them explicitly to quote
5396 ;; wildcard characters.
5398 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5399 ;; directory if FILE is a symbolic link.
5401 insert-directory-program nil t nil
5405 ;; Split the switches at any spaces so we can
5406 ;; pass separate options as separate args.
5408 ;; Avoid lossage if FILE starts with `-'.
5416 file))))))))
5418 ;; If we got "//DIRED//" in the output, it means we got a real
5419 ;; directory listing, even if `ls' returned nonzero.
5420 ;; So ignore any errors.
5433 ;; The first time ls returns an error,
5434 ;; find the version numbers of ls,
5435 ;; and set insert-directory-ls-version
5436 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5437 ;; is equal or if the info cannot be obtained.
5438 ;; (That can mean it isn't GNU ls.)
5448 comparison)
5464 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5468 ;; If `insert-directory-program' failed, signal an error.
5470 ;; Delete the error message it may have output.
5472 ;; On non-Posix systems, we cannot open a directory, so
5473 ;; don't even try, because that will always result in
5474 ;; the ubiquitous "Access denied". Instead, show the
5475 ;; command line so the user can try to guess what went wrong.
5480 insert-directory-program
5482 file result)
5483 ;; Unix. Access the file to get a suitable error.
5490 ;; The following overshoots by one line for an empty
5491 ;; directory listed with "--dired", but without "-a"
5492 ;; switch, where the ls output contains a
5493 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5494 ;; We take care of that case later.
5502 error-lines)
5503 ;; Find all the lines that are error messages,
5504 ;; and record the bounds of each one.
5511 ;; Now read the numeric positions of file names.
5518 error-lines))
5521 error-lines)))
5523 ;; End is followed by \n or by " -> ".
5525 ;; It seems that we can't trust ls's output as to
5526 ;; byte positions of filenames.
5532 ;; Take care of the case where the ls output contains a
5533 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5534 ;; and we went one line too far back (see above).
5539 ;; Now decode what read if necessary.
5541 file-name-coding-system
5542 default-file-name-coding-system
5544 coding-no-eol
5545 val pos)
5549 ;; If no coding system is specified or detection is
5550 ;; requested, detect the coding.
5564 ;; Force no eol conversion on a file name, so
5565 ;; that CR is preserved.
5573 ;; Try to insert the amount of free space.
5576 ;; First find the line to put it on.
5580 ;; Replace "total" with "used", to avoid confusion.
5586 "Convert `ls --dired' file name position value POS to a buffer position.
5587 File name position values returned in ls --dired output
5588 count only stdout; they don't count the error messages sent to stderr.
5589 So this function converts to them to real buffer positions.
5590 ERROR-LINES is a list of buffer positions of error message lines,
5591 of the form (START END)."
5595 pos)
5599 "Insert directory listing for FILE, formatted according to SWITCHES.
5601 Like `insert-directory', but if FILE does not exist, it inserts a
5602 message to that effect instead of signaling an error."
5605 ;; Simulate the message printed by `ls'.
5609 "Functions to call with no arguments to query about killing Emacs.
5610 If any of these functions returns nil, killing Emacs is cancelled.
5611 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5615 "How to ask for confirmation when leaving Emacs.
5616 If nil, the default, don't ask at all. If the value is non-nil, it should
5617 be a predicate function such as `yes-or-no-p'."
5625 "Offer to save each buffer, then kill this Emacs process.
5626 With prefix ARG, silently save all file-visiting buffers, then kill."
5635 ;; process-list is not defined on MSDOS.
5637 active)
5646 ;; Query the user for other things, perhaps.
5653 "Offer to save each buffer, then kill the current connection.
5654 If the current frame has no client, kill Emacs itself.
5656 With prefix ARG, silently save all file-visiting buffers, then kill.
5658 If emacsclient was started with a list of filenames to edit, then
5659 only these files will be asked to be saved."
5667 \f
5668 ;; We use /: as a prefix to "quote" a file name
5669 ;; so that magic file name handlers will not apply to it.
5673 file-name-handler-alist))
5675 ;; We depend on being the last handler on the list,
5676 ;; so that anything else which does need handling
5677 ;; has been handled already.
5678 ;; So it is safe for us to inhibit *all* magic file name handlers.
5687 default-directory))
5688 ;; Get a list of the indices of the args which are file names.
5691 ;; The first six are special because they
5692 ;; return a file name. We want to include the /:
5693 ;; in the return value.
5694 ;; So just avoid stripping it in the first place.
5701 ;; `identity' means just return the first arg
5702 ;; not stripped of its quoting.
5704 ;; `add' means add "/:" to the result.
5706 ;; `quote' means add "/:" to buffer-file-name.
5708 ;; `unquote-then-quote' means set buffer-file-name
5709 ;; temporarily to unquoted filename.
5711 ;; List the arguments which are filenames.
5719 ;; For all other operations, treat the first argument only
5720 ;; as the file name.
5722 method
5723 ;; Copy ARGUMENTS so we can replace elements in it.
5727 ;; Strip off the /: from the file names that have it.
5735 "/"
5751 res))
5754 \f
5755 ;; Symbolic modes and read-file-modes.
5758 "Convert CHAR to a numeric bit-mask for extracting mode bits.
5759 CHAR is in [ugoa] and represents the category of users (Owner, Group,
5760 Others, or All) for whom to produce the mask.
5761 The bit-mask that is returned extracts from mode bits the access rights
5762 for the specified category of users."
5770 "Convert CHAR to a numeric value of mode bits.
5771 CHAR is in [rwxXstugo] and represents symbolic access permissions.
5772 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
5779 ;; Rights relative to the previous file modes.
5790 "Convert a symbolic mode string specification to an equivalent number.
5792 WHO-MASK is the bit-mask specifying the category of users to which to
5793 apply the access permissions. See `file-modes-char-to-who'.
5794 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5795 RIGHTS request to add, remove, or set permissions based on existing ones,
5802 char-right)
5809 num-rights
5813 op char-right)))
5814 num-rights))
5817 "Convert symbolic file modes to numeric file modes.
5818 MODES is the string to convert, it should match
5821 notation.
5822 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5823 MODES request to add, remove, or set permissions based on existing ones,
5837 num-who num-modes)
5840 num-modes)))
5843 "Read file modes in octal or symbolic notation and return its numeric value.
5844 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5845 ORIG-FILE is the name of a file on whose mode bits to base returned
5846 permissions if what user types requests to add, remove, or set permissions
5862 nil nil default)))
5868 \f
5869 ;; Trashcan handling.
5871 "Directory for `move-file-to-trash' to move files and directories to.
5872 This directory is only used when the function `system-move-file-to-trash' is
5873 not defined. Relative paths are interpreted relative to `default-directory'.
5874 See also `delete-by-moving-to-trash'."
5882 "Move file (or directory) name FILENAME to the trash.
5883 This function is called by `delete-file' and `delete-directory' when
5884 `delete-by-moving-to-trash' is non-nil. On platforms that define
5885 `system-move-file-to-trash', that function is used to move FILENAME to the
5886 system trash, otherwise FILENAME is moved to `trash-directory'.
5887 Returns nil on success."
5900 ;; make new-fn unique.
5901 ;; example: "~/.Trash/abc.txt" -> "~/.Trash/abc.txt.~1~"
5904 ;; stop processing if fn is same or parent directory of trash-dir.
5907 filename))
5911 \f
5936 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5937 ;;; files.el ends here