| blob | b36b0af8322cc62ba5e7b9f88b930b3ae7a19bd8 |
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.
244 This feature is advisory: for example, if the directory in which the
245 file is being saved is not writeable, Emacs may ignore a non-nil value
246 of `file-precious-flag' and write directly into the file."
251 "Control use of version numbers for backup files.
252 When t, make numeric backup versions unconditionally.
253 When nil, make them for files that have some already.
254 The value `never' means do not make them."
264 "When cleaning directory, number of versions to keep."
270 "If t, delete excess backup versions silently.
271 If nil, ask confirmation. Any other value prevents any trimming."
278 "Number of oldest versions to keep when a new numbered backup is made."
284 "Number of newest versions to keep when a new numbered backup is made.
285 Includes the new backup. Must be > 0"
291 "Whether to add a newline automatically at the end of the file.
293 A value of t means do this only when the file is about to be saved.
294 A value of `visit' means do this right after the file is visited.
295 A value of `visit-save' means do it at both of those times.
296 Any other non-nil value means ask user whether to add a newline, when saving.
297 A value of nil means don't add newlines.
299 Certain major modes set this locally to the value obtained
300 from `mode-require-final-newline'."
309 "Whether to add a newline at end of file, in certain major modes.
310 Those modes set `require-final-newline' to this value when you enable them.
311 They do so because they are often used for files that are supposed
312 to end in newlines, and the question is how to arrange that.
314 A value of t means do this only when the file is about to be saved.
315 A value of `visit' means do this right after the file is visited.
316 A value of `visit-save' means do it at both of those times.
317 Any other non-nil value means ask user whether to add a newline, when saving.
319 A value of nil means do not add newlines. That is a risky choice in this
320 variable since this value is used for modes for files that ought to have
321 final newlines. So if you set this to nil, you must explicitly check and
322 add a final newline, whenever you save a file that really needs one."
332 "Non-nil says by default do auto-saving of every file-visiting buffer."
338 ;; Don't put "\\2" inside expand-file-name, since it will be
339 ;; transformed to "/2" on DOS/Windows.
341 "Transforms to apply to buffer file name before making auto-save file name.
342 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
343 REGEXP is a regular expression to match against the file name.
344 If it matches, `replace-match' is used to replace the
345 matching part with REPLACEMENT.
346 If the optional element UNIQUIFY is non-nil, the auto-save file name is
347 constructed by taking the directory part of the replaced file-name,
348 concatenated with the buffer file name with all directory separators
349 changed to `!' to prevent clashes. This will not work
350 correctly if your filesystem truncates the resulting name.
352 All the transforms in the list are tried, in the order they are listed.
353 When one transform applies, its result is final;
354 no further transforms are tried.
356 The default value is set up to put the auto-save file into the
357 temporary directory (see the variable `temporary-file-directory') for
358 editing a remote file.
360 On MS-DOS filesystems without long names this variable is always
361 ignored."
368 "Non-nil means save word abbrevs too when files are saved.
369 If `silently', don't ask the user before saving."
374 "Non-nil means allow `find-file' to visit directories.
375 To visit the directory, `find-file' runs `find-directory-functions'."
380 "List of functions to try in sequence to visit a directory.
381 Each function is called with the directory name as the sole argument
382 and should return either a buffer or nil."
386 ;;;It is not useful to make this a local variable.
387 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
389 "List of functions to be called for `find-file' on nonexistent file.
390 These functions are called as soon as the error is detected.
391 Variable `buffer-file-name' is already set up.
396 ;;;It is not useful to make this a local variable.
397 ;;;(put 'find-file-hooks 'permanent-local t)
400 "List of functions to be called after a buffer is loaded from a file.
401 The buffer's local variables (if any) will have been processed before the
402 functions are called."
409 "List of functions to be called before writing out a buffer to a file.
410 If one of them returns non-nil, the file is considered already written
411 and the rest are not called.
412 These hooks are considered to pertain to the visited file.
413 So any buffer-local binding of this variable is discarded if you change
415 change the major mode.
417 This hook is not run if any of the functions in
418 `write-contents-functions' returns non-nil. Both hooks pertain
419 to how to save a buffer to file, for instance, choosing a suitable
420 coding system and setting mode bits. (See Info
421 node `(elisp)Saving Buffers'.) To perform various checks or
432 "List of functions to be called before writing out a buffer to a file.
433 If one of them returns non-nil, the file is considered already written
434 and the rest are not called and neither are the functions in
435 `write-file-functions'.
437 This variable is meant to be used for hooks that pertain to the
438 buffer's contents, not to the particular visited file; thus,
439 `set-visited-file-name' does not clear this variable; but changing the
440 major mode does clear it.
442 For hooks that _do_ pertain to the particular visited file, use
443 `write-file-functions'. Both this variable and
444 `write-file-functions' relate to how a buffer is saved to file.
445 To perform various checks or updates before the buffer is saved,
452 "Control use of local variables in files you visit.
453 The value can be t, nil, :safe, :all, or something else.
455 A value of t means file local variables specifications are obeyed
456 if all the specified variable values are safe; if any values are
457 not safe, Emacs queries you, once, whether to set them all.
458 \(When you say yes to certain values, they are remembered as safe.)
460 :safe means set the safe variables, and ignore the rest.
461 :all means set all variables, whether safe or not.
462 (Don't set it permanently to :all.)
463 A value of nil means always ignore the file local variables.
465 Any other value means always query you once whether to set them all.
466 \(When you say yes to certain values, they are remembered as safe, but
469 This variable also controls use of major modes specified in
470 a -*- line.
473 always obeys file local variable specifications and the -*- line,
474 and ignores this variable."
483 "Like `enable-local-variables' but meant for buffer-local bindings.
484 The meaningful values are nil and non-nil. The default is non-nil.
485 If a major mode sets this to nil, buffer-locally, then any local
486 variables list in the file will be ignored.
488 This variable does not affect the use of major modes
493 The value can be t, nil or something else.
494 A value of t means obey `eval' variables.
495 A value of nil means ignore them; anything else means query."
501 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
510 "Non-nil means buffers visiting files read-only do so in view mode.
511 In fact, this means that all read-only buffers normally have
512 View mode enabled, including buffers that are read-only because
513 you visit a file you cannot alter, and buffers you make read-only
519 "History list of file names entered in the minibuffer.
521 Maximum length of the history list is determined by the value
523 \f
526 "Provides support for ange-ftp host name completion.
527 Runs the usual ange-ftp hook, but only for completion operations."
528 ;; Having this here avoids the need to load ange-ftp when it's not
529 ;; really in use.
535 inhibit-file-name-handlers)))
540 "Convert a standard file's name to something suitable for the OS.
541 This means to guarantee valid names and perhaps to canonicalize
542 certain patterns.
544 FILENAME should be an absolute file name since the conversion rules
545 sometimes vary depending on the position in the file name. E.g. c:/foo
546 is a valid DOS file name, but c:/bar/c:/foo is not.
548 This function's standard definition is trivial; it just returns
549 the argument. However, on Windows and DOS, replace invalid
550 characters. On DOS, make sure to obey the 8.3 limitations.
551 In the native Windows build, turn Cygwin names into native names,
552 and also turn slashes into backslashes if the shell requires it (see
553 `w32-shell-dos-semantics').
555 See Info node `(elisp)Standard File Names' for more details."
559 ;; Replace invalid filename characters with !
563 name)
564 filename))
567 "Read directory name, prompting with PROMPT and completing in directory DIR.
568 Value is not expanded---you must call `expand-file-name' yourself.
569 Default name to DEFAULT-DIRNAME if user exits with the same
570 non-empty string that was inserted by this function.
571 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
572 or just DIR if INITIAL is nil.)
573 If the user exits with an empty minibuffer, this function returns
574 an empty string. (This can only happen if the user erased the
575 pre-inserted contents or if `insert-default-directory' is nil.)
576 Fourth arg MUSTMATCH non-nil means require existing directory's name.
577 Non-nil and non-t means also require confirmation after completion.
578 Fifth arg INITIAL specifies text to start with.
579 DIR should be an absolute directory name. It defaults to
580 the value of `default-directory'."
585 dir))
586 mustmatch initial
589 \f
591 "Show the current default directory."
596 "Value of the CDPATH environment variable, as a list.
600 "Explode a search path into a list of directory names.
601 Directories are separated by occurrences of `path-separator'
602 \(which is colon in GNU and GNU-like systems)."
603 ;; We could use split-string here.
611 nil
616 cd-list)))
619 "Change current directory to given absolute file name DIR."
620 ;; Put the name into directory syntax now,
621 ;; because otherwise expand-file-name may give some bad results.
634 "Make DIR become the current buffer's default directory.
635 If your environment includes a `CDPATH' variable, try each one of
636 that list of directories (separated by occurrences of
637 `path-separator') when resolving a relative directory name.
638 The path separator is colon in GNU and GNU-like systems."
641 default-directory default-directory
657 cd-path)
658 nil))
662 "Load the Lisp file named FILE."
663 ;; This is a case where .elc makes a lot of sense.
670 "Search for FILENAME through PATH.
671 If found, return the absolute file name of FILENAME, with its suffixes;
672 otherwise return nil.
673 PATH should be a list of directories to look in, like the lists in
674 `exec-path' or `load-path'.
675 If SUFFIXES is non-nil, it should be a list of suffixes to append to
678 If non-nil, PREDICATE is used instead of `file-readable-p'.
679 PREDICATE can also be an integer to pass to the `access' system call,
680 in which case file-name handlers are ignored. This usage is deprecated.
682 For compatibility, PREDICATE can also be one of the symbols
683 `executable', `readable', `writable', or `exists', or a list of
684 one or more of those symbols."
695 "Do completion for file names passed to `locate-file'."
716 "Do completion for file names passed to `locate-file'.
717 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
720 string nil action))
725 "Regexp of directory names which stop the search in `locate-dominating-file'.
726 Any directory whose name matches this regexp will be treated like
727 a kind of root directory by `locate-dominating-file' which will stop its search
728 when it bumps into it.
729 The default regexp prevents fruitless and time-consuming attempts to find
732 ;; (defun locate-dominating-files (file regexp)
733 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
734 ;; Stop at the first parent where a matching file is found and return the list
735 ;; of files that that match in this directory."
736 ;; (catch 'found
737 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
738 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
739 ;; (let ((user nil)
740 ;; ;; Abbreviate, so as to stop when we cross ~/.
741 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
742 ;; files)
743 ;; (while (and dir
744 ;; ;; As a heuristic, we stop looking up the hierarchy of
745 ;; ;; directories as soon as we find a directory belonging to
746 ;; ;; another user. This should save us from looking in
747 ;; ;; things like /net and /afs. This assumes that all the
748 ;; ;; files inside a project belong to the same user.
749 ;; (let ((prev-user user))
750 ;; (setq user (nth 2 (file-attributes dir)))
751 ;; (or (null prev-user) (equal user prev-user))))
752 ;; (if (setq files (condition-case nil
753 ;; (directory-files dir 'full regexp 'nosort)
754 ;; (error nil)))
755 ;; (throw 'found files)
756 ;; (if (equal dir
757 ;; (setq dir (file-name-directory
758 ;; (directory-file-name dir))))
759 ;; (setq dir nil))))
760 ;; nil)))
763 "Look up the directory hierarchy from FILE for a file named NAME.
764 Stop at the first parent directory containing a file NAME,
765 and return the directory. Return nil if not found."
766 ;; We used to use the above locate-dominating-files code, but the
767 ;; directory-files call is very costly, so we're much better off doing
768 ;; multiple calls using the code in here.
769 ;;
770 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
771 ;; `name' in /home or in /.
775 ;; `user' is not initialized outside the loop because
776 ;; `file' may not exist, so we may have to walk up part of the
777 ;; hierarchy before we find the "initial UID".
779 try)
782 ;; FIXME: Disabled this heuristic because it is sometimes
783 ;; inappropriate.
784 ;; As a heuristic, we stop looking up the hierarchy of
785 ;; directories as soon as we find a directory belonging
786 ;; to another user. This should save us from looking in
787 ;; things like /net and /afs. This assumes that all the
788 ;; files inside a project belong to the same user.
789 ;; (let ((prev-user user))
790 ;; (setq user (nth 2 (file-attributes file)))
791 ;; (and prev-user (not (equal user prev-user))))
799 root))
803 "Search for COMMAND in `exec-path' and return the absolute file name.
804 Return nil if COMMAND is not found anywhere in `exec-path'."
805 ;; Use 1 rather than file-executable-p to better match the behavior of
806 ;; call-process.
810 "Load the library named LIBRARY.
811 This is an interface to the function `load'."
815 load-path
820 "Test whether FILE specifies a location on a remote system.
821 Returns nil or a string identifying the remote connection (ideally
822 a prefix of FILE). For example, the remote identification for filename
825 less reliable than accessing local files.
826 Furthermore, relative file names do not work across remote connections.
828 IDENTIFICATION specifies which part of the identification shall
829 be returned as string. IDENTIFICATION can be the symbol
830 `method', `user', `host' or `localname'; any other value is
831 handled like nil and means to return the complete identification
832 string.
834 If CONNECTED is non-nil, the function returns an identification only
835 if FILE is located on a remote system, and a connection is established
836 to that remote system.
838 `file-remote-p' will never open a connection on its own."
842 nil)))
845 "Copy the file FILE into a temporary file on this machine.
846 Returns the name of the local copy, or nil, if FILE is directly
847 accessible."
848 ;; This formerly had an optional BUFFER argument that wasn't used by
849 ;; anything.
853 nil)))
856 "Return the truename of FILENAME, which should be absolute.
857 The truename of a file name is found by chasing symbolic links
858 both at the level of the file and at the level of the directories
859 containing it, until no links are left at any level.
862 ;; COUNTER and PREV-DIRS are only used in recursive calls.
863 ;; COUNTER can be a cons cell whose car is the count of how many
864 ;; more links to chase before getting an error.
865 ;; PREV-DIRS can be a cons cell whose car is an alist
866 ;; of truenames we've just recently computed.
880 ;; For speed, remove the ange-ftp completion handler from the list.
881 ;; We know it's not needed here.
882 ;; For even more speed, do this only on the outermost call.
889 ;; andrewi@harlequin.co.uk - none of the following code (except for
890 ;; invoking the file-name handler) currently applies on Windows
891 ;; (ie. there are no native symlinks), but there is an issue with
892 ;; case differences being ignored by the OS, and short "8.3 DOS"
893 ;; name aliases existing for all files. (The short names are not
894 ;; reported by directory-files, but can be used to refer to files.)
895 ;; It seems appropriate for file-truename to resolve these issues in
896 ;; the most natural way, which on Windows is to call the function
897 ;; `w32-long-file-name' - this returns the exact name of a file as
898 ;; it is stored on disk (expanding short name aliases with the full
899 ;; name in the process).
902 ;; For file name that has a special handler, call handler.
903 ;; This is so that ange-ftp can save time by doing a no-op.
906 ;; If filename contains a wildcard, newname will be the old name.
908 ;; If filename exists, use the long name. If it doesn't exist,
909 ;; drill down until we find a directory that exists, and use
910 ;; the long name of that, with the extra non-existent path
911 ;; components concatenated.
913 missing rest)
916 ;; Include the preceding directory separator in the missing
917 ;; part so subsequent recursion on the rest works.
922 ""
927 ;; If this file directly leads to a link, process that iteratively
928 ;; so that we don't use lots of stack.
934 ;; For file name that has a special handler, call handler.
935 ;; This is so that ange-ftp can save time by doing a no-op.
938 done t)
940 target dirfile)
941 ;; Get the truename of the directory.
943 ;; If these are equal, we have the (or a) root directory.
945 ;; If this is the same dir we last got the truename for,
946 ;; save time--don't recalculate.
956 done t)
959 done t)
960 ;; Put it back on the file name.
962 ;; Is the file name the name of a link?
965 ;; Yes => chase that link, then start all over
966 ;; since the link may point to a directory name that uses links.
967 ;; We can't safely use expand-file-name here
968 ;; since target might look like foo/../bar where foo
969 ;; is itself a link. Instead, we handle . and .. above.
972 target
974 done nil)
975 ;; No, we are done!
977 filename))
980 "Chase links in FILENAME until a name that is not a link.
981 Unlike `file-truename', this does not check whether a parent
982 directory name is a symbolic link.
983 If the optional argument LIMIT is a number,
984 it means chase no more than that many links and then stop."
992 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
995 ;; Handle `..' by hand, since it needs to work in the
996 ;; target of any directory symlink.
997 ;; This code is not quite complete; it does not handle
998 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1002 ;; Chase links in the default dir of the symlink.
1006 ;; Now find the parent of that dir.
1010 newname))
1013 "Create a temporary file.
1014 The returned file name (created by appending some random characters at the end
1015 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1016 is guaranteed to point to a newly created empty file.
1017 You can then use `write-region' to write new data into the file.
1019 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1021 If SUFFIX is non-nil, add that at the end of the file name."
1023 file)
1026 ;; Create temp files with strict access rights. It's easy to
1027 ;; loosen them later, whereas it's impossible to close the
1028 ;; time-window of loose permissions otherwise.
1036 temporary-file-directory)
1038 temporary-file-directory))))
1044 nil)
1046 ;; the file was somehow created by someone else between
1047 ;; `make-temp-name' and `write-region', let's try again.
1048 nil)
1049 file)
1050 ;; Reset the umask.
1054 "Change the encoding of FILE's name from CODING to NEW-CODING.
1055 The value is a new name of FILE.
1056 Signals a `file-already-exists' error if a file of the new name
1057 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1058 is non-nil. A number as fourth arg means request confirmation if
1059 the new name already exists. This is what happens in interactive
1060 use with M-x."
1063 default-file-name-coding-system))
1065 from-coding to-coding)
1067 ;; We provide the default coding only when it seems that
1068 ;; the filename is correctly decoded by the default
1069 ;; coding.
1075 filename default-coding)
1076 default-coding))
1080 ;; We provide the default coding only when a user is going to
1081 ;; change the encoding not from the default coding.
1085 filename from-coding)))
1088 filename from-coding default-coding)
1089 default-coding)))
1093 default-file-name-coding-system))
1094 ;; FILE should have been decoded by DEFAULT-CODING.
1098 ;; Suppress further encoding.
1103 newname))
1104 \f
1106 "Read the name of a buffer to switch to and return as a string.
1107 It is intended for `switch-to-buffer' family of commands since they
1108 need to omit the name of current buffer from the list of completions
1109 and default values."
1116 "Select buffer BUFFER in another window.
1117 If BUFFER does not identify an existing buffer, then this function
1118 creates a buffer with that name.
1120 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
1121 or nil. If BUFFER is nil, then this function chooses a buffer
1122 using `other-buffer'.
1123 Optional second arg NORECORD non-nil means do not put this
1124 buffer at the front of the list of recently selected ones.
1125 This function returns the buffer it switched to.
1127 This uses the function `display-buffer' as a subroutine; see its
1128 documentation for additional customization information."
1132 ;; Don't let these interfere.
1133 same-window-buffer-names same-window-regexps)
1137 "Switch to buffer BUFFER in another frame.
1138 Optional second arg NORECORD non-nil means do not put this
1139 buffer at the front of the list of recently selected ones.
1140 This function returns the buffer it switched to.
1142 This uses the function `display-buffer' as a subroutine; see
1143 its documentation for additional customization information."
1147 same-window-buffer-names same-window-regexps)
1151 "Display buffer BUFFER in another frame.
1152 This uses the function `display-buffer' as a subroutine; see
1153 its documentation for additional customization information."
1156 same-window-buffer-names same-window-regexps
1158 new-window)
1160 ;; This may have been here in order to prevent the new frame from hiding
1161 ;; the old frame. But it does more harm than good.
1162 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1163 ;;(lower-frame (window-frame new-window))
1165 ;; This may have been here in order to make sure the old-frame gets the
1166 ;; focus. But not only can it cause an annoying flicker, with some
1167 ;; window-managers it just makes the window invisible, with no easy
1168 ;; way to recover it. --Stef
1169 ;;(make-frame-invisible (window-frame old-window))
1170 ;;(make-frame-visible (window-frame old-window))
1171 ))
1177 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1178 BODY should use the minibuffer at most once.
1179 Recursive uses of the minibuffer will not be affected."
1185 ;; Clear out this hook so it does not interfere
1186 ;; with any recursive minibuffer usage.
1196 "If non-nil, `find-file' requires confirmation before visiting a new file."
1208 t))
1211 "Edit file FILENAME.
1212 Switch to a buffer visiting file FILENAME,
1213 creating one if none already exists.
1214 Interactively, the default if you just type RET is the current directory,
1215 but the visited file name is available through the minibuffer history:
1216 type M-n to pull it into the minibuffer.
1218 You can visit files on remote machines by specifying something
1219 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1220 also visit local files as a different user by specifying
1221 /sudo::FILE for the file name.
1222 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1223 manual, for more about this.
1225 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1226 expand wildcards (if any) and visit multiple files. You can
1227 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1229 To visit a file without any kind of conversion and without
1240 "Edit file FILENAME, in another window.
1243 an existing one. See the function `display-buffer'.
1245 Interactively, the default if you just type RET is the current directory,
1246 but the visited file name is available through the minibuffer history:
1247 type M-n to pull it into the minibuffer.
1249 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1250 expand wildcards (if any) and visit multiple files."
1263 "Edit file FILENAME, in another frame.
1266 an existing one. See the function `display-buffer'.
1268 Interactively, the default if you just type RET is the current directory,
1269 but the visited file name is available through the minibuffer history:
1270 type M-n to pull it into the minibuffer.
1272 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1273 expand wildcards (if any) and visit multiple files."
1286 "Edit the existing file FILENAME.
1288 file names with wildcards."
1296 "Edit file FILENAME but don't allow changes.
1310 value))
1313 "Edit file FILENAME in another window but don't allow changes.
1327 value))
1330 "Edit file FILENAME in another frame but don't allow changes.
1344 value))
1347 "Find file FILENAME as a replacement for the file in the next window.
1348 This command does not select that window.
1352 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1353 expand wildcards (if any) and replace the file with multiple files."
1365 t))))
1373 "Find file FILENAME, select its buffer, kill previous buffer.
1374 If the current buffer now contains an empty file that you just visited
1375 \(presumably by mistake), use this command to visit the file you really want.
1379 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1380 expand wildcards (if any) and replace the file with multiple files.
1382 If the current buffer is an indirect buffer, or the base buffer
1383 for one or more indirect buffers, the other buffer(s) are not
1384 killed."
1394 t)))
1415 ;; This prevents us from finding the same buffer
1416 ;; if we specified the same file again.
1420 ;; Likewise for dired buffers.
1424 ;; This executes if find-file gets an error
1425 ;; and does not really find anything.
1426 ;; We put things back as they were.
1427 ;; If find-file actually finds something, we kill obuf below.
1436 ;; We already asked; don't ask again.
1439 \f
1441 "Create a suitably named buffer for visiting FILENAME, and return it.
1442 FILENAME (sans directory) is used unchanged if that name is free;
1443 otherwise a string <2> or <3> or ... is appended to get an unused name.
1444 Spaces at the start of FILENAME (sans directory) are removed."
1453 "Create and return a buffer with a name based on NAME.
1454 Choose the buffer's name using `generate-new-buffer-name'."
1458 "Regexp to match the automounter prefix in a directory name."
1466 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1468 home directory is a root directory) and removes automounter prefixes
1469 \(see the variable `automount-dir-prefix')."
1470 ;; Get rid of the prefixes added by the automounter.
1477 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1478 ;; To fix this right, we need a `file-name-case-sensitive-p'
1479 ;; function, but we don't have that yet, so just guess.
1482 ;; If any elt of directory-abbrev-alist matches this name,
1483 ;; abbreviate accordingly.
1489 ;; Compute and save the abbreviated homedir name.
1490 ;; We defer computing this until the first time it's needed, to
1491 ;; give time for directory-abbrev-alist to be set properly.
1492 ;; We include a slash at the end, to avoid spurious matches
1493 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1500 ;; If FILENAME starts with the abbreviated homedir,
1501 ;; make it start with `~' instead.
1503 ;; If the home dir is just /, don't change it.
1506 ;; MS-DOS root directories can come with a drive letter;
1507 ;; Novell Netware allows drive letters beyond `Z:'.
1517 filename)))
1520 "List of logical names for which visiting shouldn't save the true dirname."
1525 "Return the buffer visiting file FILENAME (a string).
1526 This is like `get-file-buffer', except that it checks for any buffer
1527 visiting the same file, possibly under a different name.
1528 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1529 and others are ignored.
1530 If there is no such live buffer, return nil."
1544 found)
1554 ;; Verify this buffer's file number
1555 ;; still belongs to its file.
1558 attributes)
1562 found))))
1563 \f
1565 "Non-nil means file-visiting commands should handle wildcards.
1566 For example, if you specify `*.c', that would visit all the files
1567 whose names match the pattern."
1573 "Non-nil means suppress warning messages for symlinked files.
1574 When nil, Emacs prints a warning when visiting a file that is already
1575 visited, but with a different name. Setting this option to t
1576 suppresses this warning."
1582 "Maximum size of file above which a confirmation is requested.
1583 When nil, never request confirmation."
1590 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1591 OP-TYPE specifies the file operation being performed (for message to user)."
1601 "Read file FILENAME into a buffer and return the buffer.
1602 If a buffer exists visiting FILENAME, return that one, but
1603 verify that the file has not changed since visited or saved.
1604 The buffer is not selected, just returned to the caller.
1605 Optional second arg NOWARN non-nil means suppress any warning messages.
1606 Optional third arg RAWFILE non-nil means the file is read literally.
1607 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1608 and visit all the matching files. When wildcards are actually
1609 used and expanded, return a list of buffers that are visiting
1610 the various files."
1617 'find-directory-functions
1620 filename)))
1623 find-file-wildcards
1637 ;; Find any buffer for a file which has same truename.
1639 ;; Let user know if there is a buffer with the same truename.
1643 find-file-suppress-same-file-warnings
1647 ;; Optionally also find that buffer.
1650 ;; Check to see if the file looks uncommonly large.
1654 ;; We are using an existing buffer.
1661 ;; Certain files should be reverted automatically
1662 ;; if they have changed on disk and not in the buffer.
1670 found))
1680 "File %s changed on disk. Discard your edits? "
1685 "File %s changed on disk. Discard your edits in %s? "
1693 ;; Check if a formerly read-only file has become
1694 ;; writable and vice versa, but if the buffer agrees
1695 ;; with the new state of the file, that is ok too.
1703 buffer-file-name
1712 ;; It is confusing to ask whether to visit
1713 ;; non-literally if they have the file in
1714 ;; hexl-mode.
1720 "The file %s is already visited normally,
1721 and you have edited the buffer. Now you have asked to visit it literally,
1722 meaning no coding system handling, format conversion, or local variables.
1723 Emacs can only visit a file in one way at a time.
1725 Do you want to save the file, and visit it literally instead? "
1726 "The file %s is already visited literally,
1727 meaning no coding system handling, format conversion, or local variables.
1728 You have edited the buffer. Now you have asked to visit the file normally,
1729 but Emacs can only visit a file in one way at a time.
1736 rawfile truename number))
1740 "\
1741 Do you want to discard your changes, and visit the file literally now? "
1742 "\
1745 rawfile truename number)
1751 "The file %s is already visited normally.
1752 You have asked to visit it literally,
1753 meaning no coding system decoding, format conversion, or local variables.
1754 But Emacs can only visit a file in one way at a time.
1756 Do you want to revisit the file literally now? "
1757 "The file %s is already visited literally,
1758 meaning no coding system decoding, format conversion, or local variables.
1759 You have asked to visit it normally,
1760 but Emacs can only visit a file in one way at a time.
1765 rawfile truename number)
1768 ;; Return the buffer we are using.
1769 buf)
1770 ;; Create a new buffer.
1772 ;; find-file-noselect-1 may use a different buffer.
1774 rawfile truename number))))))
1780 ;; Needed in case we are re-visiting the file with a different
1781 ;; text representation.
1798 filename)))
1799 ;; Unconditionally set error
1809 filename)))
1810 ;; Run find-file-not-found-functions until one returns non-nil.
1812 ;; If they fail too, set error.
1814 ;; Record the file's truename, and maybe use that as visited name.
1822 ;; Set buffer's default directory to that of the file.
1824 ;; Turn off backup files for certain file names. Since
1825 ;; this is a permanent local, the major mode won't eliminate it.
1840 \f
1842 "Like `insert-file-contents', but only reads in the file literally.
1843 A buffer may be modified in several ways after reading into the buffer,
1844 to Emacs features such as format decoding, character code
1845 conversion, `find-file-hook', automatic uncompression, etc.
1847 This function ensures that none of these modifications will take place."
1855 nil))
1858 inhibit-file-name-handlers))
1871 filename)))
1872 ;; Check whether the file is uncommonly large
1883 "Insert contents of file FILENAME into buffer after point with no conversion.
1885 This function is meant for the user to run interactively.
1886 Don't call it from programs! Use `insert-file-contents-literally' instead.
1887 \(Its calling sequence is different; see its documentation)."
1892 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1897 "Visit file FILENAME with no conversion of any kind.
1898 Format conversion and character code conversion are both disabled,
1899 and multibyte characters are disabled in the resulting buffer.
1900 The major mode used is Fundamental mode regardless of the file name,
1901 and local variable specifications in the file are ignored.
1902 Automatic uncompression and adding a newline at the end of the
1903 file due to `require-final-newline' is also disabled.
1905 You cannot absolutely rely on this function to result in
1906 visiting the file literally. If Emacs already has a buffer
1907 which is visiting the file, you get the existing buffer,
1908 regardless of whether it was created literally or not.
1910 In a Lisp program, if you want to be sure of accessing a file's
1911 contents literally, you should create a temporary buffer and then read
1912 the file contents into it using `insert-file-contents-literally'."
1915 \f
1919 after-find-file-from-revert-buffer
1920 nomodes)
1921 "Called after finding a file and by the default revert function.
1922 Sets buffer mode, parses local variables.
1923 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1924 error in reading the file. WARN non-nil means warn if there
1925 exists an auto-save file more recent than the visited file.
1926 NOAUTO means don't mess with auto-save mode.
1927 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1928 means this call was from `revert-buffer'.
1929 Fifth arg NOMODES non-nil means don't alter the file's modes.
1930 Finishes by calling the functions in `find-file-hook'
1931 unless NOMODES is non-nil."
1934 nil
1944 ;; No need to warn if buffer is auto-saved
1945 ;; under the name of the visited file.
1947 auto-save-visited-file-name))
1950 buffer-file-name))
1970 ;; Make people do a little extra work (C-x C-q)
1971 ;; before altering a backup file.
1974 ;; When a file is marked read-only,
1975 ;; make the buffer read-only even if root is looking at it.
1983 ;; If requested, add a newline at the end of the file.
1993 view-read-only
1999 "Eval BODY and turn any error into a FORMAT message.
2000 FORMAT can have a %s escape which will be replaced with the actual error.
2001 If `debug-on-error' is set, errors are not caught, so that you can
2002 debug them.
2003 Avoid using a large BODY since it is duplicated."
2012 "Choose the major mode for this buffer automatically.
2013 Also sets up any specified local variables of the file.
2014 Uses the visited file name, the -*- line, and the local variables spec.
2016 This function is called automatically from `find-file'. In that case,
2017 we may set up the file-specified mode and local variables,
2018 depending on the value of `enable-local-variables'.
2019 In addition, if `local-enable-local-variables' is nil, we do
2020 not set local variables (though we do notice a mode specified with -*-.)
2022 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2023 or from Lisp without specifying the optional argument FIND-FILE;
2024 in that case, this function acts as if `enable-local-variables' were t."
2032 ;; Turn font lock off and on, to make sure it takes account of
2033 ;; whatever file local variables are relevant to it.
2035 ;; Font-lock-mode (now in font-core.el) can be ON when
2036 ;; font-lock.el still hasn't been loaded.
2046 "Non-nil means to try second pass through `auto-mode-alist'.
2047 This means that if the first case-sensitive search through the alist fails
2048 to find a matching major mode, a second case-insensitive search is made.
2049 On systems with case-insensitive file names, this variable is ignored,
2050 since only a single case-insensitive search through the alist is made."
2056 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2057 ;; c++-mode, java-mode and more) are added through autoload
2058 ;; directives in that file. That way is discouraged since it
2059 ;; spreads out the definition of the initial value.
2092 ;; Less common extensions come here
2093 ;; so more common ones above are found faster.
2132 ;; The list of archive file extensions should be in sync with
2133 ;; `auto-coding-alist' with `no-conversion' coding system.
2139 ;; Mailer puts message to be edited in
2140 ;; /tmp/Re.... or Message
2144 ;; some news reader is reported to use this
2153 ;; .emacs or .gnus or .viper following a directory delimiter in
2154 ;; Unix, MSDOG or VMS syntax.
2157 ;; _emacs following a directory delimiter
2158 ;; in MsDos syntax
2162 ;; Common Lisp ASDF package system.
2181 ;; Windows candidates may be opened case sensitively on Unix
2187 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2189 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2190 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2191 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2192 ;; this has lower priority to avoid matching changelog.sgml etc.
2194 ;; either user's dot-files or under /etc or some such
2196 ;; alas not all ~/.*rc files are like this
2197 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2202 ;; this contains everything twice, with space and with colon :-(
2204 ;; Get rid of any trailing .n.m and try again.
2205 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2206 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2207 ;; Using mode nil rather than `ignore' would let the search continue
2208 ;; through this list (with the shortened name) rather than start over.
2210 ;; The following should come after the ChangeLog pattern
2211 ;; for the sake of ChangeLog.1, etc.
2212 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2215 "Alist of filename patterns vs corresponding major mode functions.
2216 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2217 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2218 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2219 mode function to use. FUNCTION will be called, unless it is nil.
2221 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2222 calling FUNCTION (if it's not nil), we delete the suffix that matched
2223 REGEXP and search the list again for another match.
2225 If the file name matches `inhibit-first-line-modes-regexps',
2226 then `auto-mode-alist' is not processed.
2228 The extensions whose FUNCTION is `archive-mode' should also
2229 appear in `auto-coding-alist' with `no-conversion' coding system.
2231 See also `interpreter-mode-alist', which detects executable script modes
2232 based on the interpreters they specify to run,
2236 "Select Conf mode or XML mode according to start of file."
2246 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2247 ;; and pike-mode) are added through autoload directives in that
2248 ;; file. That way is discouraged since it spreads out the
2249 ;; definition of the initial value.
2287 "Alist mapping interpreter names to major modes.
2288 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2289 Each element looks like (INTERPRETER . MODE).
2290 If INTERPRETER matches the name of the interpreter specified in the first line
2291 of a script, mode MODE is enabled.
2299 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2300 When checking `inhibit-first-line-modes-regexps', we first discard
2306 "Regexp matching interpreters, for file mode determination.
2307 This regular expression is matched against the first line of a file
2308 to determine the file's mode in `set-auto-mode'. If it matches, the file
2309 is assumed to be interpreted by the interpreter matched by the second group
2310 of the regular expression. The mode is then determined as the mode
2314 "Alist of buffer beginnings vs. corresponding major mode functions.
2315 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2316 After visiting a file, if REGEXP matches the text at the beginning of the
2317 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2318 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2319 major mode.
2321 If FUNCTION is nil, then it is not called. (That is a way of saying
2327 ;; The < comes before the groups (but the first) to reduce backtracking.
2328 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2329 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2333 comment-re "*"
2336 . html-mode)
2338 ;; These two must come after html, because they are more general:
2343 . sgml-mode)
2346 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2347 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2348 After visiting a file, if REGEXP matches the text at the beginning of the
2349 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2350 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2351 have not specified a mode for this file.
2357 "Upper limit on `magic-mode-alist' regexp matches.
2361 "Select major mode appropriate for current buffer.
2363 To find the right major mode, this function checks for a -*- mode tag,
2364 checks if it uses an interpreter listed in `interpreter-mode-alist',
2365 matches the buffer beginning against `magic-mode-alist',
2366 compares the filename against the entries in `auto-mode-alist',
2367 then matches the buffer beginning against `magic-fallback-mode-alist'.
2369 It does not check for the `mode:' local variable in the
2370 Local Variables section of the file; for that, use `hack-local-variables'.
2372 If `enable-local-variables' is nil, this function does not check for a
2373 -*- mode tag.
2375 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2376 set the major mode only if that would change it. In other words
2377 we don't actually set it to the same mode the buffer already has."
2378 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2380 ;; Find a -*- mode tag
2387 ;; Find all specifications for the `mode:' variable
2388 ;; and execute them left to right.
2400 modes)))
2401 ;; Simple -*-MODE-*- case.
2404 modes))))
2405 ;; If we found modes to use, invoke them now, outside the save-excursion.
2413 ;; continuing would call minor modes again, toggling them off
2415 ;; If we didn't, look for an interpreter specified in the first line.
2416 ;; As a special case, allow for things like "#!/bin/env perl", which
2417 ;; finds the interpreter anywhere in $PATH.
2424 ;; Map interpreter name to a mode, signalling we're done at the
2425 ;; same time.
2427 interpreter-mode-alist))
2428 ;; If we found an interpreter mode to use, invoke it now.
2431 ;; Next try matching the buffer beginning against magic-mode-alist.
2445 ;; Next compare the filename against the entries in auto-mode-alist.
2450 ;; Remove remote file name identification.
2454 ;; Remove backup-suffixes from file name.
2457 ;; Find first matching alist entry.
2460 ;; System is case-insensitive.
2464 ;; System is case-sensitive.
2466 ;; First match case-sensitively.
2470 ;; Fallback to case-insensitive match.
2484 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2499 ;; When `keep-mode-if-same' is set, we are working on behalf of
2500 ;; set-visited-file-name. In that case, if the major mode specified is the
2501 ;; same one we already have, don't actually reset it. We don't want to lose
2502 ;; minor modes such as Font Lock.
2504 "Apply MODE and return it.
2505 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2506 any aliases and compared to current major mode. If they are the
2507 same, do nothing and return nil."
2513 mode)))
2516 "Find the -*- spec in the buffer.
2517 Call with point at the place to start searching from.
2518 If one is found, set point to the beginning
2519 and return the position of the end.
2520 Otherwise, return nil; point may be changed."
2523 ;; Don't look for -*- if this file name matches any
2524 ;; of the regexps in inhibit-first-line-modes-regexps.
2532 sufs)
2540 ;; If the file begins with "#!"
2541 ;; (exec interpreter magic), look
2542 ;; for mode frobs in the first two
2543 ;; lines. You cannot necessarily
2544 ;; put them in the first line of
2545 ;; such a file without screwing up
2546 ;; the interpreter invocation.
2547 ;; The same holds for
2548 ;; '\"
2549 ;; in man pages (preprocessor
2550 ;; magic for the `man' program).
2561 end))))
2562 \f
2563 ;;; Handling file local variables
2567 file-local-variables-alist)
2571 "Normal hook run after processing a file's local variables specs.
2572 Major modes can use this to examine user-specified local variables
2576 "List variable-value pairs that are considered safe.
2577 Each element is a cons cell (VAR . VAL), where VAR is a variable
2578 symbol and VAL is a value that is considered safe."
2583 "Expressions that are considered safe in an `eval:' local variable.
2584 Add expressions to this list if you want Emacs to evaluate them, when
2585 they appear in an `eval' local variable specification, without first
2586 asking you for confirmation."
2591 ;; Risky local variables:
2594 auto-mode-alist
2595 buffer-auto-save-file-name
2596 buffer-file-name
2597 buffer-file-truename
2598 buffer-undo-list
2599 dabbrev-case-fold-search
2600 dabbrev-case-replace
2601 debugger
2602 default-text-properties
2603 display-time-string
2604 enable-local-eval
2605 enable-local-variables
2606 eval
2607 exec-directory
2608 exec-path
2609 file-name-handler-alist
2610 font-lock-defaults
2611 format-alist
2612 frame-title-format
2613 global-mode-string
2614 header-line-format
2615 icon-title-format
2616 ignored-local-variables
2617 imenu--index-alist
2618 imenu-generic-expression
2619 inhibit-quit
2620 input-method-alist
2621 load-path
2622 max-lisp-eval-depth
2623 max-specpdl-size
2624 minor-mode-alist
2625 minor-mode-map-alist
2626 minor-mode-overriding-map-alist
2627 mode-line-buffer-identification
2628 mode-line-format
2629 mode-line-client
2630 mode-line-modes
2631 mode-line-modified
2632 mode-line-mule-info
2633 mode-line-position
2634 mode-line-process
2635 mode-line-remote
2636 mode-name
2637 outline-level
2638 overriding-local-map
2639 overriding-terminal-local-map
2640 parse-time-rules
2641 process-environment
2642 rmail-output-file-alist
2643 safe-local-variable-values
2644 safe-local-eval-forms
2645 save-some-buffers-action-alist
2646 special-display-buffer-names
2647 standard-input
2648 standard-output
2649 unread-command-events
2650 vc-mode))
2652 ;; Safe local variables:
2653 ;;
2654 ;; For variables defined by major modes, the safety declarations can go into
2655 ;; the major mode's file, since that will be loaded before file variables are
2656 ;; processed.
2657 ;;
2658 ;; For variables defined by minor modes, put the safety declarations in the
2659 ;; file defining the minor mode after the defcustom/defvar using an autoload
2660 ;; cookie, e.g.:
2661 ;;
2662 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2663 ;;
2664 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2665 ;; minor mode file may not be loaded yet.
2666 ;;
2667 ;; For variables defined in the C source code the declaration should go here:
2683 "Alist of file-local variable settings in the current buffer.
2684 Each element in this list has the form (VAR . VALUE), where VAR
2685 is a file-local variable (a symbol) and VALUE is the value
2686 specified. The actual value in the buffer may differ from VALUE,
2691 "Normal hook run before setting file-local variables.
2692 It is called after checking for unsafe/risky variables and
2693 setting `file-local-variables-alist', and before applying the
2694 variables stored in `file-local-variables-alist'. A hook
2695 function is allowed to change the contents of this alist.
2697 This hook is called only if there is at least one file-local
2701 "Get confirmation before setting up local variable values.
2702 ALL-VARS is the list of all variables to be set up.
2703 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2704 RISKY-VARS is the list of those that are marked as risky.
2705 PROJECT is a directory name if these settings come from directory-local
2706 settings, or nil otherwise."
2708 nil
2713 prompt char)
2723 ", and variables that are risky (**)."
2731 y -- to apply the local variables list.
2735 ! -- to apply the local variables list, and permanently mark these
2747 ;; Make strings with embedded whitespace easier to read.
2755 ""
2762 done)
2771 ;; read-event returns -1 if we are in a kbd
2772 ;; macro and there are no more events in the
2773 ;; macro. In that case, attempt to get an
2774 ;; event interactively.
2782 ;; When this is called from desktop-restore-file-buffer,
2783 ;; coding-system-for-read may be non-nil. Reset it before
2784 ;; writing to .emacs.
2788 'safe-local-variable-values
2789 safe-local-variable-values))))
2796 "Return local variables specified in the -*- line.
2797 Ignore any specification for `mode:' and `coding:';
2798 `set-auto-mode' should already have handled `mode:',
2799 `set-auto-coding' should already have handled `coding:'.
2801 If MODE-ONLY is non-nil, all we do is check whether the major
2802 mode is specified, returning t if it is specified. Otherwise,
2803 return an alist of elements (VAR . VAL), where VAR is a variable
2804 and VAL is the specified value."
2808 result mode-specified)
2809 ;; Parse the -*- line into the RESULT alist.
2810 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2812 nil)
2814 ;; Simple form: "-*- MODENAME -*-". Already handled.
2816 nil)
2818 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2819 ;; (last ";" is optional).
2824 ;; There used to be a downcase here,
2825 ;; but the manual didn't say so,
2826 ;; and people want to set var names that aren't all lc.
2831 ;; It is traditional to ignore
2832 ;; case when checking for `mode' in set-auto-mode,
2833 ;; so we must do that here as well.
2834 ;; That is inconsistent, but we're stuck with it.
2835 ;; The same can be said for `coding' in set-auto-coding.
2841 'eval
2848 mode-specified
2849 result))))
2852 "Filter local variable settings, querying the user if necessary.
2853 VARIABLES is the alist of variable-value settings. This alist is
2854 filtered based on the values of `ignored-local-variables',
2855 `enable-local-eval', `enable-local-variables', and (if necessary)
2856 user interaction. The results are added to
2857 `file-local-variables-alist', without applying them.
2858 PROJECT is a directory name if these settings come from
2859 directory-local settings, or nil otherwise."
2860 ;; Strip any variables that are in `ignored-local-variables'.
2863 ;; If `enable-local-eval' is nil, strip eval "variables".
2868 ;; Find those variables that we may want to save to
2869 ;; `safe-local-variable-values'.
2874 ;; Don't query about the fake variables.
2885 ;; If caller wants only safe variables, store only these.
2890 ;; Query, unless all are known safe or the user wants no
2891 ;; querying.
2897 variables unsafe-vars risky-vars project))
2902 "Parse and put into effect this buffer's local variables spec.
2903 If MODE-ONLY is non-nil, all we do is check whether the major mode
2904 is specified, returning t if it is specified."
2907 result)
2914 ;; Look for "Local variables:" line in last page.
2922 ;; suffix is what comes after "local variables:" in its line.
2923 ;; prefix is what comes before "local variables:" in its line.
2933 beg)
2937 endpos
2943 nil t))
2944 ;; This used to be an error, but really all it means is
2945 ;; that this may simply not be a local-variables section,
2946 ;; so just ignore it.
2956 ;; Discard the prefix.
2961 ;; Discard the suffix.
2969 ;; Find the variable name; strip whitespace.
2977 val)
2978 ;; Read the variable value.
2988 'eval
2993 ;; Now we've read all the local variables.
2994 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
2996 ;; Otherwise, set the variables.
3008 "Non-nil if SYM is safe as a file-local variable with value VAL.
3009 It is safe if any of these conditions are met:
3011 * There is a matching entry (SYM . VAL) in the
3012 `safe-local-variable-values' user option.
3014 * The `safe-local-variable' property of SYM is a function that
3015 evaluates to a non-nil value with VAL as an argument."
3021 "Non-nil if SYM could be dangerous as a file-local variable.
3022 It is dangerous if either of these conditions are met:
3024 * Its `risky-local-variable' property is non-nil.
3030 ;; If this is an alias, check the base name.
3050 "Return t if it is safe to eval EXP when it is found in a file."
3052 ;; Detect certain `put' expressions.
3059 lisp-indent-function
3060 scheme-indent-function))
3061 ;; Only allow safe values (not functions).
3066 ;; Only allow indirect form specs.
3067 ;; During bootstrapping, edebug-basic-spec might not be
3068 ;; defined yet.
3072 ;; Allow expressions that the user requested.
3074 ;; Certain functions can be allowed with safe arguments
3075 ;; or can specify verification functions to try.
3083 ok))
3091 ok)))))))
3094 "Set local variable VAR with value VAL.
3095 If VAR is `mode', call `VAL-mode' as a function unless it's
3096 already the major mode."
3106 ;; Make sure the string has no text properties.
3107 ;; Some text properties can get evaluated in various ways,
3108 ;; so it is risky to put them on with a local variable list.
3112 \f
3113 ;;; Handling directory local variables, aka project settings.
3122 "Return the project variable list for project CLASS."
3126 "Collect local variable settings from MODE-ALIST.
3127 SETTINGS is the initial list of bindings.
3128 Returns the new list."
3135 ;; Need a new cons in case we setcdr later.
3139 "Collect entries from BINDING-LIST into SETTINGS.
3140 ROOT is the root directory of the project.
3141 Return the new settings list."
3149 ;; Don't include this in the previous condition, because we
3150 ;; want to filter all strings before the next condition.
3155 root settings))))
3159 settings))))))))
3162 "Declare that the project rooted at DIRECTORY is an instance of CLASS.
3163 DIRECTORY is the name of a directory, a string.
3164 CLASS is the name of a project class, a symbol.
3166 When a file beneath DIRECTORY is visited, the mode-specific
3167 settings from CLASS will be applied to the buffer. The settings
3168 for a class are defined using `define-project-bindings'."
3175 "Map the project type CLASS to a list of variable settings.
3176 CLASS is the project class, a symbol.
3177 SETTINGS is a list that declares variable settings for the class.
3178 An element in SETTINGS is either of the form:
3179 (MAJOR-MODE . ALIST)
3180 or
3181 (DIRECTORY . LIST)
3183 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3184 whose elements are of the form (VARIABLE . VALUE).
3186 In the second form, DIRECTORY is a directory name (a string), and
3187 LIST is a list of the form accepted by the function.
3189 When a file is visited, the file's class is found. A directory
3190 may be assigned a class using `set-directory-project'. Then
3191 variables are set in the file's buffer according to the class'
3192 LIST. The list is processed in order.
3194 * If the element is of the form (MAJOR-MODE . ALIST), and the
3195 buffer's major mode is derived from MAJOR-MODE (as determined
3196 by `derived-mode-p'), then all the settings in ALIST are
3197 applied. A MAJOR-MODE of nil may be used to match any buffer.
3198 `make-local-variable' is called for each variable before it is
3199 set.
3201 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3202 is an initial substring of the file's directory, then LIST is
3203 applied by recursively following these rules."
3210 "Settings file for per-project settings.
3211 Set this to nil if you don't want to load project-specific settings."
3218 "Find the settings file for FILE.
3219 This searches upward in the directory tree.
3220 If a settings file is found, the file name is returned.
3221 If the file is in a registered project, a cons from
3222 `project-directory-alist' is returned.
3223 Otherwise this returns nil."
3228 ;; `locate-dominating-file' may have abbreviated the name.
3239 settings pda)
3243 "Load a settings file and register a new project class and instance.
3244 SETTINGS-FILE is the name of the file holding the settings to apply.
3245 The new class name is the same as the directory in which SETTINGS-FILE
3246 is found. Returns the new class name."
3248 ;; We should probably store the modtime of SETTINGS-FILE and then
3249 ;; reload it whenever it changes.
3256 class-name)))
3261 "Read local variables for the current buffer based on project settings.
3262 Store the project variables in `file-local-variables-alist',
3263 without applying them."
3267 ;; Find the settings file.
3281 root-dir nil)))
3285 \f
3288 However, the mode will not be changed if
3289 \(1) a local variables list or the `-*-' line specifies a major mode, or
3291 \ not suitable for ordinary files, or
3292 \(3) the new file name does not particularly specify any mode."
3297 "Change name of file visited in current buffer to FILENAME.
3298 This also renames the buffer to correspond to the new file.
3299 The next time the buffer is saved it will go in the newly specified file.
3300 FILENAME nil or an empty string means mark buffer as not visiting any file.
3301 Remember to delete the initial contents of the minibuffer
3302 if you wish to pass an empty string as the argument.
3304 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3305 confirmation in the case where another buffer is already visiting FILENAME.
3307 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3308 the old visited file has been renamed to the new name FILENAME."
3316 nil
3331 filename)))
3341 ;; If new-name == old-name, renaming would add a spurious <2>
3342 ;; and it's considered as a feature in rename-buffer.
3348 ;; Abbreviate the file names of the buffer.
3357 nil)))
3358 ;; write-file-functions is normally used for things like ftp-find-file
3359 ;; that visit things that are not local files as if they were files.
3360 ;; Changing to visit an ordinary local file instead should flush the hook.
3365 ;; If buffer was read-only because of version control,
3366 ;; that reason is gone now, so make it writable.
3370 ;; Turn off backup files for certain file names.
3371 ;; Since this is a permanent local, the major mode won't eliminate it.
3373 backup-enable-predicate
3379 ;; If auto-save was not already on, turn it on if appropriate.
3383 ;; If auto save is on, start using a new name.
3384 ;; We deliberately don't rename or delete the old auto save
3385 ;; for the old visited file name. This is because perhaps
3386 ;; the user wants to save the new state and then compare with the
3387 ;; previous state from the auto save file.
3390 ;; Rename the old auto save file if any.
3397 ;; Update the major mode, if the file name determines it.
3399 ;; Don't change the mode if it is special.
3402 ;; Don't change the mode if the local variable list specifies it.
3408 "Write current buffer into file FILENAME.
3409 This makes the buffer visit that file, and marks it as not modified.
3411 If you specify just a directory name as FILENAME, that means to use
3412 the default file name but in that directory. You can also yank
3413 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3415 If the buffer is not already visiting a file, the default file name
3416 for the output file is the buffer name.
3418 If optional second arg CONFIRM is non-nil, this function
3419 asks for confirmation before overwriting an existing file.
3420 Interactively, confirmation is required unless you supply a prefix argument."
3421 ;; (interactive "FWrite file: ")
3425 nil nil nil nil)
3429 default-directory)
3430 nil nil))
3434 ;; If arg is just a directory,
3435 ;; use the default file name, but in that directory.
3446 ;; Make buffer writable if file is writable.
3451 ;; It's likely that the VC status at the new location is different from
3452 ;; the one at the old location.
3454 \f
3456 "Make a backup of the disk file visited by the current buffer, if appropriate.
3457 This is normally done before saving the buffer the first time.
3459 A backup may be done by renaming or by copying; see documentation of
3460 variable `make-backup-files'. If it's done by renaming, then the file is
3461 no longer accessible under its old name.
3463 The value is non-nil after a backup was made by renaming.
3464 It has the form (MODES . BACKUPNAME).
3465 MODES is the result of `file-modes' on the original
3466 file; this means that the caller, after saving the buffer, should change
3467 the modes of the new file to agree with the old modes.
3468 BACKUPNAME is the backup file name, which is the old file renamed."
3475 backup-info backupname targets setmodes)
3476 ;; If specified name is a symbolic link, chase it to the target.
3477 ;; Thus we make the backups in the directory where the real file is.
3482 ;; (if (file-directory-p buffer-file-name)
3483 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3487 ;; If have old versions to maybe delete,
3488 ;; ask the user to confirm now, before doing anything.
3489 ;; But don't actually delete til later.
3494 real-file-name)))))
3496 ;; Actually write the back up file.
3499 ; (file-symlink-p buffer-file-name)
3500 backup-by-copying
3501 ;; Don't rename a suid or sgid file.
3516 ;; rename-file should delete old backup.
3520 ;; If trouble writing the backup, write it in ~.
3525 backupname)
3529 ;; Now delete the old versions, if desired.
3536 setmodes)
3543 ;; Create temp files with strict access rights. It's easy to
3544 ;; loosen them later, whereas it's impossible to close the
3545 ;; time-window of loose permissions otherwise.
3548 ;; Try to overwrite old backup first.
3556 nil)
3558 ;; The file was somehow created by someone else between
3559 ;; `delete-file' and `copy-file', so let's try again.
3560 ;; rms says "I think there is also a possible race
3561 ;; condition for making backup files" (emacs-devel 20070821).
3562 nil)))
3563 ;; Reset the umask.
3569 "Return file NAME sans backup versions or strings.
3570 This is a separate procedure so your site-init or startup file can
3571 redefine it.
3572 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3573 we do not remove backup version numbers, only true file version numbers."
3585 "Return t if deleting FILE and rewriting it would preserve the owner."
3590 ;; Return t if the file doesn't exist, since it's true that no
3591 ;; information would be lost by an (attempted) delete and create.
3597 The extension, in a file name, is the part that follows the last `.',
3598 except that a leading `.', if any, doesn't count."
3601 directory)
3605 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3606 ;; we don't want to expand it.
3609 filename))))
3613 The extension, in a file name, is the part that follows the last `.',
3614 excluding version numbers and backup suffixes,
3615 except that a leading `.', if any, doesn't count.
3616 Return nil for extensionless file names such as `foo'.
3617 Return the empty string for file names such as `foo.'.
3619 If PERIOD is non-nil, then the returned value includes the period
3620 that delimits the extension, and if FILENAME has no extension,
3631 "A function to use instead of the default `make-backup-file-name'.
3632 A value of nil gives the default `make-backup-file-name' behavior.
3634 This could be buffer-local to do something special for specific
3635 files. If you define it, you may need to change `backup-file-name-p'
3636 and `file-name-sans-versions' too.
3638 See also `backup-directory-alist'."
3644 "Alist of filename patterns and backup directory names.
3645 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3646 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3647 relative or absolute. If it is absolute, so that all matching files
3648 are backed up into the same directory, the file names in this
3649 directory will be the full name of the file backed up with all
3650 directory separators changed to `!' to prevent clashes. This will not
3651 work correctly if your filesystem truncates the resulting name.
3653 For the common case of all backups going into one directory, the alist
3655 directory name.
3657 If this variable is nil, or it fails to match a filename, the backup
3658 is made in the original file's directory.
3660 On MS-DOS filesystems without long names this variable is always
3661 ignored."
3667 "Default `backup-enable-predicate' function.
3668 Checks for files in `temporary-file-directory',
3669 `small-temporary-file-directory', and /tmp."
3672 ;; Directory is under temporary-file-directory.
3677 ;; Directory is under /tmp.
3682 0 nil
3684 ;; Directory is under small-temporary-file-directory.
3689 "Create the non-numeric backup file name for FILE.
3690 Normally this will just be the file's name with `~' appended.
3691 Customization hooks are provided as follows.
3693 If the variable `make-backup-file-name-function' is non-nil, its value
3694 should be a function which will be called with FILE as its argument;
3695 the resulting name is used.
3697 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3698 the documentation of that variable. If the directory for the backup
3699 doesn't exist, it is created."
3713 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3715 elt backup-directory abs-backup-directory)
3720 alist nil)))
3721 ;; If backup-directory is relative, it should be relative to the
3722 ;; file's directory. By expanding explicitly here, we avoid
3723 ;; depending on default-directory.
3732 abs-backup-directory nil))))
3734 file
3738 ;; Normalize DOSish file names: downcase the drive
3739 ;; letter, if any, and replace the leading "x:" with
3740 ;; "/drive_x".
3743 ;; Replace any invalid file-name characters (for the
3744 ;; case of backing up remote files).
3748 "drive_"
3751 ""
3754 ;; Make the name unique by substituting directory
3755 ;; separators. It may not really be worth bothering about
3756 ;; doubling `!'s in the original name...
3761 backup-directory))
3766 "Return non-nil if FILE is a backup file name (numeric or not).
3767 This is a separate function so you can redefine it for customization.
3768 You may need to redefine `file-name-sans-versions' as well."
3773 ;; This is used in various files.
3774 ;; The usage of backup-extract-version-start is not very clean,
3775 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3777 "Given the name of a numeric backup file, FN, return the backup number.
3778 Uses the free variable `backup-extract-version-start', whose value should be
3779 the index in the name where the version number begins."
3786 "Find a file name for a backup file FN, and suggestions for deletions.
3787 Value is a list whose car is the name for the backup file
3788 and whose cdr is a list of old versions to consider deleting now.
3789 If the value is nil, don't make a backup.
3790 Uses `backup-directory-alist' in the same way as does
3791 `make-backup-file-name'."
3793 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3797 ;; We don't support numbered backups on plain MS-DOS
3798 ;; when long file names are unavailable.
3808 possibilities deserve-versions-p versions)
3811 base-versions
3814 possibilities)
3815 #'<)
3820 kept-old-versions
3821 kept-new-versions
3828 ;; Delete nothing if there is overflow
3829 ;; in the number of versions to keep.
3835 v))))))))))
3838 "Return number of names file FILENAME has."
3841 ;; (defun file-relative-name (filename &optional directory)
3842 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3843 ;; This function returns a relative file name which is equivalent to FILENAME
3844 ;; when used with that default directory as the default.
3845 ;; If this is impossible (which can happen on MSDOS and Windows
3846 ;; when the file name and directory use different drive names)
3847 ;; then it returns FILENAME."
3848 ;; (save-match-data
3849 ;; (let ((fname (expand-file-name filename)))
3850 ;; (setq directory (file-name-as-directory
3851 ;; (expand-file-name (or directory default-directory))))
3852 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3853 ;; ;; drive names, they can't be relative, so return the absolute name.
3854 ;; (if (and (or (eq system-type 'ms-dos)
3855 ;; (eq system-type 'cygwin)
3856 ;; (eq system-type 'windows-nt))
3857 ;; (not (string-equal (substring fname 0 2)
3858 ;; (substring directory 0 2))))
3859 ;; filename
3860 ;; (let ((ancestor ".")
3861 ;; (fname-dir (file-name-as-directory fname)))
3862 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3863 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3864 ;; (setq directory (file-name-directory (substring directory 0 -1))
3865 ;; ancestor (if (equal ancestor ".")
3866 ;; ".."
3867 ;; (concat "../" ancestor))))
3868 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3869 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3870 ;; ;; We matched within FNAME's directory part.
3871 ;; ;; Add the rest of FNAME onto ANCESTOR.
3872 ;; (let ((rest (substring fname (match-end 0))))
3873 ;; (if (and (equal ancestor ".")
3874 ;; (not (equal rest "")))
3875 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3876 ;; rest
3877 ;; (concat (file-name-as-directory ancestor) rest)))
3878 ;; ;; We matched FNAME's directory equivalent.
3879 ;; ancestor))))))
3882 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3883 This function returns a relative file name which is equivalent to FILENAME
3884 when used with that default directory as the default.
3885 If FILENAME and DIRECTORY lie on different machines or on different drives
3886 on a DOS/Windows machine, it returns FILENAME in expanded form."
3890 default-directory))))
3896 ;; Test for different drives on DOS/Windows
3898 ;; Should `cygwin' really be included here? --stef
3901 ;; Test for different remote file system identification
3903 filename
3909 directory nil nil case-fold-search))
3911 directory nil nil case-fold-search))))
3914 ".."
3916 ;; Now ancestor is empty, or .., or ../.., etc.
3918 directory nil nil case-fold-search))
3919 ;; We matched within FILENAME's directory part.
3920 ;; Add the rest of FILENAME onto ANCESTOR.
3923 ;; But don't bother with ANCESTOR if it would give us `./'.
3924 rest
3926 ;; We matched FILENAME's directory equivalent.
3927 ancestor))))))
3928 \f
3930 "Save current buffer in visited file if modified.
3931 Variations are described below.
3933 By default, makes the previous version into a backup file
3934 if previously requested or if this is the first save.
3936 to become a backup when the next save is done.
3938 unconditionally makes the previous version into a backup file.
3940 to become a backup when the next save is done,
3941 and unconditionally makes the previous version into a backup file.
3943 With a numeric argument of 0, never make the previous version
3944 into a backup file.
3946 If a file's name is FOO, the names of its numbered backup versions are
3947 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3948 Numeric backups (rather than FOO~) will be made if value of
3949 `version-control' is not the atom `never' and either there are already
3950 numeric versions of the file being backed up, or `version-control' is
3951 non-nil.
3952 We don't want excessive versions piling up, so there are variables
3953 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3954 and `kept-new-versions', which tells how many newest versions to keep.
3955 Defaults are 2 old versions and 2 new.
3956 `dired-kept-versions' controls dired's clean-directory (.) command.
3957 If `delete-old-versions' is nil, system will query user
3958 before trimming versions. Otherwise it does it silently.
3960 If `vc-make-backup-files' is nil, which is the default,
3961 no backup files are made for files managed by version control.
3962 (This is because the version control system itself records previous versions.)
3964 See the subroutine `basic-save-buffer' for more information."
3977 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3978 Normally delete only if the file was written by this Emacs since
3979 the last real save, but optional arg FORCE non-nil means delete anyway."
3993 "Normal hook that is run before a buffer is saved to its file."
3999 "Normal hook that is run after a buffer is saved to its file."
4005 "If non-nil, use this coding system for saving the buffer.
4006 More precisely, use this coding system in place of the
4007 value of `buffer-file-coding-system', when saving the buffer.
4008 Calling `write-region' for any purpose other than saving the buffer
4009 will still use `buffer-file-coding-system'; this variable has no effect
4016 "Save the current buffer in its visited file, if it has been modified.
4017 The hooks `write-contents-functions' and `write-file-functions' get a chance
4018 to do the job of saving; if they do not, then the buffer is saved in
4019 the visited file in the usual way.
4020 Before and after saving the buffer, this function runs
4021 `before-save-hook' and `after-save-hook', respectively."
4024 ;; In an indirect buffer, save its base buffer instead.
4029 setmodes)
4030 ;; If buffer has no file name, ask user for one.
4037 ;; Signal an error if the user specified the name of an
4038 ;; existing directory.
4041 filename))
4043 ;; Signal an error if the specified name refers to a
4044 ;; non-existing directory.
4074 ;; Support VC version backups.
4080 ;; If a hook returned t, file is already "written".
4081 ;; Otherwise, write it the usual way now.
4083 ;; Now we have saved the current buffer. Let's make sure
4084 ;; that buffer-file-coding-system is fixed to what
4085 ;; actually used for saving by binding it locally.
4095 ;; If the auto-save file was recent before this command,
4096 ;; delete it now.
4098 ;; Support VC `implicit' locking.
4103 ;; This does the "real job" of writing a buffer into its visited file
4104 ;; and making a backup file. This is what is normally done
4105 ;; but inhibited if one of write-file-functions returns non-nil.
4106 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4115 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4129 buffer-file-name)))
4137 ;; If file is precious, write temp name, then rename it.
4138 ;; This requires write access to the containing dir,
4139 ;; which is why we don't try it if we don't have that access.
4141 tempname succeed
4144 ;; Create temp files with strict access rights. It's easy to
4145 ;; loosen them later, whereas it's impossible to close the
4146 ;; time-window of loose permissions otherwise.
4151 ;; Try various temporary names.
4152 ;; This code follows the example of make-temp-file,
4153 ;; but it calls write-region in the appropriate way
4154 ;; for saving the buffer.
4160 ;; Pass in nil&nil rather than point-min&max
4161 ;; cause we're saving the whole buffer.
4162 ;; write-region-annotate-functions may use it.
4164 tempname nil realname
4166 nil)
4168 ;; The file was somehow created by someone else between
4169 ;; `make-temp-name' and `write-region', let's try again.
4170 nil)
4172 ;; Reset the umask.
4174 ;; If we failed, restore the buffer's modtime.
4177 ;; Since we have created an entirely new file,
4178 ;; make sure it gets the right permission bits set.
4182 buffer-file-name)))
4183 ;; We succeeded in writing the temp file,
4184 ;; so rename it.
4186 ;; If file not writable, see if we can make it writable
4187 ;; temporarily while we write it.
4188 ;; But no need to do so if we have just backed it up
4189 ;; (setmodes is set) because that says we're superseding.
4191 ;; Change the mode back, after writing.
4197 ;; Pass in nil&nil rather than point-min&max to indicate
4198 ;; we're saving the buffer rather than just a region.
4199 ;; write-region-annotate-functions may make us of it.
4201 buffer-file-name nil t buffer-file-truename)
4203 ;; If we get an error writing the new file, and we made
4204 ;; the backup by renaming, undo the backing-up.
4209 setmodes))
4212 "View the differences between BUFFER and its associated file.
4213 This requires the external program `diff' to be in your `exec-path'."
4227 ;; Display that message for 1 second so that user can read it
4228 ;; in the minibuffer.
4230 ;; return always nil, so that save-buffers-kill-emacs will not move
4231 ;; over to the next unsaved buffer when calling `d'.
4232 nil)
4235 `((?\C-r
4242 ;; Return nil to ask about BUF again.
4243 nil)
4255 ;; Return nil to ask about BUF again.
4256 nil)
4265 "Save some modified file-visiting buffers. Asks user about each one.
4266 You can answer `y' to save, `n' not to save, `C-r' to look at the
4267 buffer in question with `view-buffer' before deciding or `d' to
4268 view the differences using `diff-buffer-with-file'.
4270 Optional argument (the prefix) non-nil means save all with no questions.
4271 Optional second argument PRED determines which buffers are considered:
4272 If PRED is nil, all the file-visiting buffers are considered.
4273 If PRED is t, then certain non-file buffers will also be considered.
4274 If PRED is a zero-argument function, it indicates for each buffer whether
4275 to consider it or not when called with that buffer current.
4277 See `save-some-buffers-action-alist' if you want to
4278 change the additional actions you can take on files."
4282 files-done abbrevs-done)
4284 ;; First save any buffers that we're supposed to save unconditionally.
4285 ;; That way the following code won't ask about them.
4290 ;; Ask about those buffers that merit it,
4291 ;; and record the number thus saved.
4306 t
4318 save-some-buffers-action-alist))
4319 ;; Maybe to save abbrevs, and record whether
4320 ;; we either saved them or asked to.
4326 abbrev-file-name)))
4328 ;; Don't keep bothering user if he says no.
4333 "(Some special files were saved without asking)"
4335 \f
4337 "Mark current buffer as unmodified, not needing to be saved.
4340 It is not a good idea to use this function in Lisp programs, because it
4341 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4348 "Change whether this buffer is visiting its file read-only.
4349 With prefix argument ARG, make the buffer read-only if ARG is
4350 positive, otherwise make it writable. If visiting file read-only
4351 and `view-read-only' is non-nil, enter view mode."
4356 nil ; do nothing.
4357 ;; Toggle.
4364 ;; If view-mode is already active, `view-mode-enter' is a nop.
4376 "Insert contents of file FILENAME into buffer after point.
4377 Set mark after the inserted text.
4379 This function is meant for the user to run interactively.
4380 Don't call it from programs! Use `insert-file-contents' instead.
4381 \(Its calling sequence is different; see its documentation)."
4386 "Append the contents of the region to the end of file FILENAME.
4387 When called from a function, expects three arguments,
4388 START, END and FILENAME. START and END are buffer positions
4389 saying what text to write."
4394 "Return most recent backup file for FILENAME or nil if no backups exist."
4395 ;; `make-backup-file-name' will get us the right directory for
4396 ;; ordinary or numeric backups. It might create a directory for
4397 ;; backups as a side-effect, according to `backup-directory-alist'.
4404 tem)
4413 newest))
4416 "Rename current buffer to a similar name not already taken.
4417 This function is useful for creating multiple shell process buffers
4418 or multiple mail buffers, etc."
4426 ;; If the existing buffer name has a <NNN>,
4427 ;; which isn't part of the file name (if any),
4428 ;; then get rid of that.
4434 "Create the directory DIR and any nonexistent parent dirs.
4435 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4437 Interactively, the default choice of directory to create
4438 is the current default directory for file names.
4439 That is useful when you have visited a file in a nonexistent directory.
4441 Noninteractively, the second (optional) argument PARENTS says whether
4442 to create parent directories if they don't exist. Interactively,
4443 this happens by default."
4446 nil nil)
4447 t))
4448 ;; If default-directory is a remote directory,
4449 ;; make sure we find its make-directory handler.
4457 create-list)
4464 \f
4467 "Function to use to revert this buffer, or nil to do the default.
4468 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4473 "Function to use to insert contents when reverting this buffer.
4474 Gets two args, first the nominal file name to use,
4475 and second, t if reading the auto-save file.
4480 "Function to check whether a non-file buffer needs reverting.
4481 This should be a function with one optional argument NOCONFIRM.
4482 Auto Revert Mode passes t for NOCONFIRM. The function should return
4483 non-nil if the buffer should be reverted. A return value of
4484 `fast' means that the need for reverting was not checked, but
4485 that reverting the buffer is fast. The buffer is current when
4486 this function is called.
4488 The idea behind the NOCONFIRM argument is that it should be
4489 non-nil if the buffer is going to be reverted without asking the
4490 user. In such situations, one has to be careful with potentially
4491 time consuming operations.
4493 For more information on how this variable is used by Auto Revert mode,
4497 "Normal hook for `revert-buffer' to run before reverting.
4498 If `revert-buffer-function' is used to override the normal revert
4502 "Normal hook for `revert-buffer' to run after reverting.
4503 Note that the hook value that it runs is the value that was in effect
4504 before reverting; that makes a difference if you have buffer-local
4505 hook functions.
4507 If `revert-buffer-function' is used to override the normal revert
4513 "Replace current buffer text with the text of the visited file on disk.
4514 This undoes all changes since the file was visited or saved.
4515 With a prefix argument, offer to revert from latest auto-save file, if
4516 that is more recent than the visited file.
4518 This command also implements an interface for special buffers
4519 that contain text which doesn't come from a file, but reflects
4520 some other data instead (e.g. Dired buffers, `buffer-list'
4521 buffers). This is done via the variable `revert-buffer-function'.
4522 In these cases, it should reconstruct the buffer contents from the
4523 appropriate data.
4525 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4526 to revert from the auto-save file when this is nil. Note that the
4527 sense of this argument is the reverse of the prefix argument, for the
4528 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4529 to nil.
4531 Optional second argument NOCONFIRM means don't ask for confirmation
4532 at all. \(The variable `revert-without-query' offers another way to
4533 revert buffers without querying for confirmation.)
4535 Optional third argument PRESERVE-MODES non-nil means don't alter
4536 the files modes. Normally we reinitialize them using `normal-mode'.
4538 If the value of `revert-buffer-function' is non-nil, it is called to
4539 do all the work for this command. Otherwise, the hooks
4540 `before-revert-hook' and `after-revert-hook' are run at the beginning
4541 and the end, and if `revert-buffer-insert-file-contents-function' is
4542 non-nil, it is called instead of rereading visited file contents."
4544 ;; I admit it's odd to reverse the sense of the prefix argument, but
4545 ;; there is a lot of code out there which assumes that the first
4546 ;; argument should be t to avoid consulting the auto-save file, and
4547 ;; there's no straightforward way to encourage authors to notice a
4548 ;; reversal of the argument sense. So I'm just changing the user
4549 ;; interface, but leaving the programmatic interface the same.
4557 buffer-auto-save-file-name
4562 buffer-auto-save-file-name
4563 buffer-file-name)))
4573 file-name)))
4575 ;; If file was backed up but has changed since,
4576 ;; we shd make another backup.
4580 ;; Effectively copy the after-revert-hook status,
4581 ;; since after-find-file will clobber it.
4584 after-revert-hook))
4589 ;; Get rid of all undo records for this buffer.
4591 ;; Don't make undo records for the reversion.
4594 file-name auto-save-p)))
4597 "File %s no longer exists!"
4599 file-name))
4602 "File %s no longer readable!"
4604 file-name))
4606 ;; Bind buffer-file-name to nil
4607 ;; so that we don't try to lock the file.
4613 ;; Auto-saved file should be read by Emacs'
4614 ;; internal coding.
4617 buffer-file-coding-system-explicit))))
4619 coding-system-for-read
4621 coding-system-for-read)
4623 ;; As a coding system suitable for multibyte
4624 ;; buffer is specified, make the current
4625 ;; buffer multibyte.
4628 ;; This force after-insert-file-set-coding
4629 ;; (called from insert-file-contents) to set
4630 ;; buffer-file-coding-system to a proper value.
4633 ;; Note that this preserves point in an intelligent way.
4637 nil nil t))
4639 nil nil t)))))
4640 ;; Recompute the truename in case changes in symlinks
4641 ;; have changed the truename.
4645 ;; Run after-revert-hook as it was before we reverted.
4649 local-hook)
4652 t))))))
4655 "Recover the visited file--get contents from its last auto-save file."
4660 "Visit file FILE, but get contents from its last auto-save file."
4661 ;; Actually putting the file name in the minibuffer should be used
4662 ;; only rarely.
4663 ;; Not just because users often use the default.
4683 ;; Use insert-directory-safely, not insert-directory,
4684 ;; because these files might not exist. In particular,
4685 ;; FILE might not exist if the auto-save file was for
4686 ;; a buffer that didn't visit a file, such as "*mail*".
4687 ;; The code in v20.x called `ls' directly, so we need
4688 ;; to emulate what `ls' did in that case.
4694 ;; Keep the current buffer-file-coding-system.
4696 ;; Auto-saved file should be read with special coding.
4705 "Recover auto save files from a previous Emacs session.
4706 This command first displays a Dired buffer showing you the
4707 previous sessions that you could recover from.
4708 To choose one, move point to the proper line and then type C-c C-c.
4709 Then you'll be asked about a number of files to recover."
4719 auto-save-list-file-prefix)))
4720 t)
4729 ;; Each line starts with a space
4730 ;; so that Font Lock mode won't highlight the first character.
4739 "Choose one saved session to recover auto-save files from.
4740 This command is used in the special Dired buffer created by
4743 ;; Get the name of the session file to recover from.
4745 files
4751 ;; Read in the auto-save-list file.
4755 ;; Loop thru the text of that file
4756 ;; and get out the names of the files to recover.
4760 ;; This is a pair of lines for a non-file-visiting buffer.
4761 ;; Get the auto-save file name and manufacture
4762 ;; a "visited file name" from that.
4765 ;; If there is no auto-save file name, the
4766 ;; auto-save-list file is probably corrupted.
4779 ;; This pair of lines is a file-visiting
4780 ;; buffer. Use the visited file name.
4790 ;; Ignore a file if its auto-save file does not exist now.
4794 ;; The file contains a pair of line for each auto-saved buffer.
4795 ;; The first line of the pair contains the visited file name
4796 ;; or is empty if the buffer was not visiting a file.
4797 ;; The second line is the auto-save file name.
4805 files
4811 "Kill BUFFER if confirmed."
4819 "Kill some buffers. Asks the user whether to kill each one of them.
4820 Non-interactively, if optional argument LIST is non-nil, it
4821 specifies the list of buffers to kill, asking for approval for each one."
4829 ; if we killed the base buffer.
4836 "Kill buffers whose name matches the specified REGEXP.
4837 The optional second argument indicates whether to kill internal buffers too."
4846 \f
4848 "Toggle auto-saving of contents of current buffer.
4849 With prefix argument ARG, turn auto-saving on if positive, else off."
4854 ;; If auto-save is off because buffer has shrunk,
4855 ;; then toggling should turn it on.
4860 buffer-file-name
4862 ;; If -1 was stored here, to temporarily turn off saving,
4863 ;; turn it back on.
4869 buffer-auto-save-file-name)
4872 "Adjust current buffer's auto save file name for current conditions.
4873 Also rename any existing auto save file, if it was made in this session."
4885 "Return file name to use for auto-saves of current buffer.
4886 Does not consider `auto-save-visited-file-name' as that variable is checked
4887 before calling this function. You can redefine this for customization.
4888 See also `auto-save-file-name-p'."
4896 result uniq)
4897 ;; Apply user-specified translations
4898 ;; to the file name.
4902 filename)
4912 filename))))
4917 ;; We truncate the file name to DOS 8+3 limits
4918 ;; before doing anything else, because the regexp
4919 ;; passed to string-match below cannot handle
4920 ;; extensions longer than 3 characters, multiple
4921 ;; dots, and other atrocities.
4926 fn)
4931 "#"
4934 ;; Make sure auto-save file names don't contain characters
4935 ;; invalid for the underlying filesystem.
4937 ;; Don't modify remote (ange-ftp) filenames
4940 result))))
4942 ;; Deal with buffers that don't have any associated files. (Mail
4943 ;; mode tends to create a good number of these.)
4947 file-name)
4948 ;; Restrict the characters used in the file name to those which
4949 ;; are known to be safe on all filesystems, url-encoding the
4950 ;; rest.
4951 ;; We do this on all platforms, because even if we are not
4952 ;; running on DOS/Windows, the current directory may be on a
4953 ;; mounted VFAT filesystem, such as a USB memory stick.
4957 ;; For multibyte characters, this will produce more than
4958 ;; 2 hex digits, so is not true URL encoding.
4962 ;; Generate the file name.
4968 ;; Try a few alternative directories, to get one we can
4969 ;; write it.
4975 ;; Don't modify remote (ange-ftp) filenames
4977 ;; The call to convert-standard-filename is in case
4978 ;; buffer-name includes characters not allowed by the
4979 ;; DOS/Windows filesystems. make-temp-file writes to the
4980 ;; file it creates, so we must fix the file name _before_
4981 ;; make-temp-file is called.
4983 fname))
4985 ;; make-temp-file creates the file,
4986 ;; but we don't want it to exist until we do an auto-save.
4990 file-name)))
4993 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4994 FILENAME should lack slashes. You can redefine this for customization."
4996 \f
4998 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4999 The generated regexp will match a filename only if the filename
5000 matches that wildcard according to shell rules. Only wildcards known
5001 by `sh' are supported."
5003 ;; Copy the initial run of non-special characters.
5006 ;; If no special characters, we're almost done.
5010 j)
5012 result
5033 ;; Found "[^". Insert a `\0' character
5034 ;; (which cannot happen in a filename)
5035 ;; into the character class, so that `^'
5036 ;; is not the first character after `[',
5037 ;; and thus non-special in a regexp.
5042 ;; I don't think `]' can appear in a
5043 ;; character class in a wildcard, but
5044 ;; let's be general here.
5051 i
5064 ;; Shell wildcards should match the entire filename,
5065 ;; not its part. Make the regexp say so.
5067 \f
5069 "-CF"
5070 "Switches for `list-directory' to pass to `ls' for brief listing."
5075 "-l"
5076 "Switches for `list-directory' to pass to `ls' for verbose listing."
5081 "Expand wildcard pattern PATTERN.
5082 This returns a list of file names which match the pattern.
5084 If PATTERN is written as an absolute file name,
5085 the values are absolute also.
5087 If PATTERN is written as a relative file name, it is interpreted
5088 relative to the current default directory, `default-directory'.
5089 The file names returned are normally also relative to the current
5090 default directory. However, if FULL is non-nil, they are absolute."
5094 ;; A list of all dirs that DIRPART specifies.
5095 ;; This can be more than one dir
5096 ;; if DIRPART contains wildcards.
5101 contents)
5106 ;; Filter out "." and ".."
5111 name))
5118 this-dir-contents)
5119 this-dir-contents)
5120 contents))))
5122 contents)))
5125 "Display a list of files in or matching DIRNAME, a la `ls'.
5126 DIRNAME is globbed by the shell if necessary.
5127 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5128 Actions controlled by variables `list-directory-brief-switches'
5129 and `list-directory-verbose-switches'."
5133 nil default-directory nil)
5134 pfx)))
5136 list-directory-brief-switches))
5137 buffer)
5150 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5158 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5160 PATTERN is assumed to represent a file-name wildcard suitable for the
5161 underlying filesystem. For Unix and GNU/Linux, the characters from the
5163 the parts of the pattern which don't include wildcard characters are
5164 quoted with double quotes.
5165 Existing quote characters in PATTERN are left alone, so you can pass
5166 PATTERN that already quotes some of the special characters."
5170 ;; DOS/Windows don't allow `"' in file names. So if the
5171 ;; argument has quotes, we can safely assume it is already
5172 ;; quoted by the caller.
5174 ;; We quote [&()#$'] in case their shell is a port of a
5175 ;; Unixy shell. We quote [,=+] because stock DOS and
5176 ;; Windows shells require that in some cases, such as
5177 ;; passing arguments to batch files that use positional
5178 ;; arguments like %1.
5180 pattern
5183 end)
5200 pattern))))
5207 "Program to get the amount of free space on a file system.
5208 We assume the output has the format of `df'.
5209 The value of this variable must be just a command name or file name;
5210 if you want to specify options, use `directory-free-space-args'.
5212 A value of nil disables this feature.
5214 If the function `file-system-info' is defined, it is always used in
5215 preference to the program given by this variable."
5221 "Options to use when running `directory-free-space-program'."
5226 "Return the amount of free space on directory DIR's file system.
5227 The result is a string that gives the number of free 1KB blocks,
5228 or nil if the system call or the program which retrieve the information
5229 fail. It returns also nil when DIR is a remote directory.
5231 This function calls `file-system-info' if it is available, or invokes the
5232 program specified by `directory-free-space-program' if that is non-nil."
5234 ;; Try to find the number of free blocks. Non-Posix systems don't
5235 ;; always have df, but might have an equivalent system call.
5244 nil t nil
5245 directory-free-space-args
5246 dir)))
5247 ;; Usual format is a header line followed by a line of
5248 ;; numbers.
5253 ;; Move to the end of the "available blocks" number.
5256 ;; Copy it into AVAILABLE.
5261 ;; The following expression replaces `dired-move-to-filename-regexp'.
5265 ;; In some locales, month abbreviations are as short as 2 letters,
5266 ;; and they can be followed by ".".
5267 ;; In Breton, a month name can include a quote character.
5280 s "+"
5283 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5284 ;; omits the Kanji characters after month and day-of-month.
5285 ;; On Mac OS X 10.3, the date format in East Asian locales is
5286 ;; day-of-month digits followed by month digits.
5292 ;; The "[0-9]" below requires the previous column to end in a digit.
5293 ;; This avoids recognizing `1 may 1997' as a date in the line:
5294 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5296 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5297 ;; The ".*" below finds the last match if there are multiple matches.
5298 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5299 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5301 ;; vc dired listings provide the state or blanks between file
5302 ;; permissions and date. The state is always surrounded by
5303 ;; parantheses:
5304 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5305 ;; This is not supported yet.
5309 "Regular expression to match up to the file name in a directory listing.
5310 The default value is designed to recognize dates and times
5315 ;; insert-directory
5316 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5317 ;; FULL-DIRECTORY-P is nil.
5318 ;; The single line of output must display FILE's name as it was
5319 ;; given, namely, an absolute path name.
5320 ;; - must insert exactly one line for each file if WILDCARD or
5321 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5322 ;; before the file lines, plus optional text after the file lines.
5323 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5324 ;; allowed.
5325 ;; File lines should display the basename.
5326 ;; - must be consistent with
5327 ;; - functions dired-move-to-filename, (these two define what a file line is)
5328 ;; dired-move-to-end-of-filename,
5329 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5330 ;; dired-insert-headerline
5331 ;; dired-after-subdir-garbage (defines what a "total" line is)
5332 ;; - variable dired-subdir-regexp
5333 ;; - may be passed "--dired" as the first argument in SWITCHES.
5334 ;; Filename handlers might have to remove this switch if their
5335 ;; "ls" command does not support it.
5337 "Insert directory listing for FILE, formatted according to SWITCHES.
5338 Leaves point after the inserted text.
5339 SWITCHES may be a string of options, or a list of strings
5340 representing individual options.
5341 Optional third arg WILDCARD means treat FILE as shell wildcard.
5342 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5343 switches do not contain `d', so that a full listing is expected.
5345 This works by running a directory listing program
5346 whose name is in the variable `insert-directory-program'.
5347 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5349 When SWITCHES contains the long `--dired' option, this function
5350 treats it specially, for the sake of dired. However, the
5351 normally equivalent short `-D' option is just passed on to
5352 `insert-directory-program', as any other option."
5353 ;; We need the directory in order to find the right handler.
5358 wildcard full-directory-p)
5361 ;; Read the actual directory using `insert-directory-program'.
5362 ;; RESULT gets the status code.
5364 ;; putting text property `dired-filename, decode one
5365 ;; bunch by one to preserve that property.
5367 ;; This is to control encoding the arguments in call-process.
5371 default-file-name-coding-system))))
5374 ;; Run ls in the directory part of the file pattern
5375 ;; using the last component as argument.
5382 shell-file-name nil t nil
5383 "-c"
5385 ""
5387 insert-directory-program
5388 " -d "
5390 switches
5392 " -- "
5393 ;; Quote some characters that have
5394 ;; special meanings in shells; but
5395 ;; don't quote the wildcards--we want
5396 ;; them to be special. We also
5397 ;; currently don't quote the quoting
5398 ;; characters in case people want to
5399 ;; use them explicitly to quote
5400 ;; wildcard characters.
5402 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5403 ;; directory if FILE is a symbolic link.
5405 insert-directory-program nil t nil
5409 ;; Split the switches at any spaces so we can
5410 ;; pass separate options as separate args.
5412 ;; Avoid lossage if FILE starts with `-'.
5420 file))))))))
5422 ;; If we got "//DIRED//" in the output, it means we got a real
5423 ;; directory listing, even if `ls' returned nonzero.
5424 ;; So ignore any errors.
5437 ;; The first time ls returns an error,
5438 ;; find the version numbers of ls,
5439 ;; and set insert-directory-ls-version
5440 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5441 ;; is equal or if the info cannot be obtained.
5442 ;; (That can mean it isn't GNU ls.)
5452 comparison)
5468 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5472 ;; If `insert-directory-program' failed, signal an error.
5474 ;; Delete the error message it may have output.
5476 ;; On non-Posix systems, we cannot open a directory, so
5477 ;; don't even try, because that will always result in
5478 ;; the ubiquitous "Access denied". Instead, show the
5479 ;; command line so the user can try to guess what went wrong.
5484 insert-directory-program
5486 file result)
5487 ;; Unix. Access the file to get a suitable error.
5494 ;; The following overshoots by one line for an empty
5495 ;; directory listed with "--dired", but without "-a"
5496 ;; switch, where the ls output contains a
5497 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5498 ;; We take care of that case later.
5506 error-lines)
5507 ;; Find all the lines that are error messages,
5508 ;; and record the bounds of each one.
5515 ;; Now read the numeric positions of file names.
5522 error-lines))
5525 error-lines)))
5527 ;; End is followed by \n or by " -> ".
5529 ;; It seems that we can't trust ls's output as to
5530 ;; byte positions of filenames.
5536 ;; Take care of the case where the ls output contains a
5537 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5538 ;; and we went one line too far back (see above).
5543 ;; Now decode what read if necessary.
5545 file-name-coding-system
5546 default-file-name-coding-system
5548 coding-no-eol
5549 val pos)
5553 ;; If no coding system is specified or detection is
5554 ;; requested, detect the coding.
5568 ;; Force no eol conversion on a file name, so
5569 ;; that CR is preserved.
5577 ;; Try to insert the amount of free space.
5580 ;; First find the line to put it on.
5584 ;; Replace "total" with "used", to avoid confusion.
5590 "Convert `ls --dired' file name position value POS to a buffer position.
5591 File name position values returned in ls --dired output
5592 count only stdout; they don't count the error messages sent to stderr.
5593 So this function converts to them to real buffer positions.
5594 ERROR-LINES is a list of buffer positions of error message lines,
5595 of the form (START END)."
5599 pos)
5603 "Insert directory listing for FILE, formatted according to SWITCHES.
5605 Like `insert-directory', but if FILE does not exist, it inserts a
5606 message to that effect instead of signaling an error."
5609 ;; Simulate the message printed by `ls'.
5613 "Functions to call with no arguments to query about killing Emacs.
5614 If any of these functions returns nil, killing Emacs is cancelled.
5615 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5619 "How to ask for confirmation when leaving Emacs.
5620 If nil, the default, don't ask at all. If the value is non-nil, it should
5621 be a predicate function such as `yes-or-no-p'."
5629 "Offer to save each buffer, then kill this Emacs process.
5630 With prefix ARG, silently save all file-visiting buffers, then kill."
5639 ;; process-list is not defined on MSDOS.
5641 active)
5650 ;; Query the user for other things, perhaps.
5657 "Offer to save each buffer, then kill the current connection.
5658 If the current frame has no client, kill Emacs itself.
5660 With prefix ARG, silently save all file-visiting buffers, then kill.
5662 If emacsclient was started with a list of filenames to edit, then
5663 only these files will be asked to be saved."
5671 \f
5672 ;; We use /: as a prefix to "quote" a file name
5673 ;; so that magic file name handlers will not apply to it.
5677 file-name-handler-alist))
5679 ;; We depend on being the last handler on the list,
5680 ;; so that anything else which does need handling
5681 ;; has been handled already.
5682 ;; So it is safe for us to inhibit *all* magic file name handlers.
5691 default-directory))
5692 ;; Get a list of the indices of the args which are file names.
5695 ;; The first six are special because they
5696 ;; return a file name. We want to include the /:
5697 ;; in the return value.
5698 ;; So just avoid stripping it in the first place.
5705 ;; `identity' means just return the first arg
5706 ;; not stripped of its quoting.
5708 ;; `add' means add "/:" to the result.
5710 ;; `quote' means add "/:" to buffer-file-name.
5712 ;; `unquote-then-quote' means set buffer-file-name
5713 ;; temporarily to unquoted filename.
5715 ;; List the arguments which are filenames.
5723 ;; For all other operations, treat the first argument only
5724 ;; as the file name.
5726 method
5727 ;; Copy ARGUMENTS so we can replace elements in it.
5731 ;; Strip off the /: from the file names that have it.
5739 "/"
5755 res))
5758 \f
5759 ;; Symbolic modes and read-file-modes.
5762 "Convert CHAR to a numeric bit-mask for extracting mode bits.
5763 CHAR is in [ugoa] and represents the category of users (Owner, Group,
5764 Others, or All) for whom to produce the mask.
5765 The bit-mask that is returned extracts from mode bits the access rights
5766 for the specified category of users."
5774 "Convert CHAR to a numeric value of mode bits.
5775 CHAR is in [rwxXstugo] and represents symbolic access permissions.
5776 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
5783 ;; Rights relative to the previous file modes.
5794 "Convert a symbolic mode string specification to an equivalent number.
5796 WHO-MASK is the bit-mask specifying the category of users to which to
5797 apply the access permissions. See `file-modes-char-to-who'.
5798 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5799 RIGHTS request to add, remove, or set permissions based on existing ones,
5806 char-right)
5813 num-rights
5817 op char-right)))
5818 num-rights))
5821 "Convert symbolic file modes to numeric file modes.
5822 MODES is the string to convert, it should match
5825 notation.
5826 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5827 MODES request to add, remove, or set permissions based on existing ones,
5841 num-who num-modes)
5844 num-modes)))
5847 "Read file modes in octal or symbolic notation and return its numeric value.
5848 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5849 ORIG-FILE is the name of a file on whose mode bits to base returned
5850 permissions if what user types requests to add, remove, or set permissions
5866 nil nil default)))
5872 \f
5873 ;; Trashcan handling.
5875 "Directory for `move-file-to-trash' to move files and directories to.
5876 This directory is only used when the function `system-move-file-to-trash' is
5877 not defined. Relative paths are interpreted relative to `default-directory'.
5878 See also `delete-by-moving-to-trash'."
5886 "Move file (or directory) name FILENAME to the trash.
5887 This function is called by `delete-file' and `delete-directory' when
5888 `delete-by-moving-to-trash' is non-nil. On platforms that define
5889 `system-move-file-to-trash', that function is used to move FILENAME to the
5890 system trash, otherwise FILENAME is moved to `trash-directory'.
5891 Returns nil on success."
5904 ;; make new-fn unique.
5905 ;; example: "~/.Trash/abc.txt" -> "~/.Trash/abc.txt.~1~"
5908 ;; stop processing if fn is same or parent directory of trash-dir.
5911 filename))
5915 \f
5940 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5941 ;;; files.el ends here