| blob | 9b317252c36c40e77374b15e588a23214162d452 |
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 "If non-nil, confirmation is requested before visiting a new file or buffer.
1107 This affects commands like `switch-to-buffer' and `find-file'."
1113 "Read the name of a buffer to switch to and return as a string.
1114 It is intended for `switch-to-buffer' family of commands since they
1115 need to omit the name of current buffer from the list of completions
1116 and default values."
1124 "Select the buffer specified by BUFFER-OR-NAME in another window.
1125 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1126 nil. Return the buffer switched to.
1128 If BUFFER-OR-NAME is a string and does not identify an existing
1129 buffer, create a new buffer with that name. Interactively, if
1130 `confirm-nonexistent-file-or-buffer' is non-nil, request
1131 confirmation before creating a new buffer. If BUFFER-OR-NAME is
1132 nil, switch to buffer returned by `other-buffer'.
1134 Optional second argument NORECORD non-nil means do not put this
1135 buffer at the front of the list of recently selected ones.
1137 This uses the function `display-buffer' as a subroutine; see its
1138 documentation for additional customization information."
1142 same-window-buffer-names same-window-regexps)
1146 "Switch to buffer BUFFER-OR-NAME in another frame.
1147 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1148 nil. Return the buffer switched to.
1150 If BUFFER-OR-NAME is a string and does not identify an existing
1151 buffer, create a new buffer with that name. Interactively, if
1152 `confirm-nonexistent-file-or-buffer' is non-nil, request
1153 confirmation before creating a new buffer. If BUFFER-OR-NAME is
1154 nil, switch to buffer returned by `other-buffer'.
1156 Optional second arg NORECORD non-nil means do not put this
1157 buffer at the front of the list of recently selected ones.
1159 This uses the function `display-buffer' as a subroutine; see its
1160 documentation for additional customization information."
1164 same-window-buffer-names same-window-regexps)
1168 "Display buffer BUFFER in another frame.
1169 This uses the function `display-buffer' as a subroutine; see
1170 its documentation for additional customization information."
1173 same-window-buffer-names same-window-regexps
1175 new-window)
1177 ;; This may have been here in order to prevent the new frame from hiding
1178 ;; the old frame. But it does more harm than good.
1179 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1180 ;;(lower-frame (window-frame new-window))
1182 ;; This may have been here in order to make sure the old-frame gets the
1183 ;; focus. But not only can it cause an annoying flicker, with some
1184 ;; window-managers it just makes the window invisible, with no easy
1185 ;; way to recover it. --Stef
1186 ;;(make-frame-invisible (window-frame old-window))
1187 ;;(make-frame-visible (window-frame old-window))
1188 ))
1194 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1195 BODY should use the minibuffer at most once.
1196 Recursive uses of the minibuffer will not be affected."
1202 ;; Clear out this hook so it does not interfere
1203 ;; with any recursive minibuffer usage.
1219 t))
1222 "Edit file FILENAME.
1223 Switch to a buffer visiting file FILENAME,
1224 creating one if none already exists.
1225 Interactively, the default if you just type RET is the current directory,
1226 but the visited file name is available through the minibuffer history:
1227 type M-n to pull it into the minibuffer.
1229 You can visit files on remote machines by specifying something
1230 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1231 also visit local files as a different user by specifying
1232 /sudo::FILE for the file name.
1233 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1234 manual, for more about this.
1236 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1237 expand wildcards (if any) and visit multiple files. You can
1238 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1240 To visit a file without any kind of conversion and without
1251 "Edit file FILENAME, in another window.
1254 an existing one. See the function `display-buffer'.
1256 Interactively, the default if you just type RET is the current directory,
1257 but the visited file name is available through the minibuffer history:
1258 type M-n to pull it into the minibuffer.
1260 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1261 expand wildcards (if any) and visit multiple files."
1274 "Edit file FILENAME, in another frame.
1277 an existing one. See the function `display-buffer'.
1279 Interactively, the default if you just type RET is the current directory,
1280 but the visited file name is available through the minibuffer history:
1281 type M-n to pull it into the minibuffer.
1283 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1284 expand wildcards (if any) and visit multiple files."
1297 "Edit the existing file FILENAME.
1299 file names with wildcards."
1307 "Edit file FILENAME but don't allow changes.
1321 value))
1324 "Edit file FILENAME in another window but don't allow changes.
1338 value))
1341 "Edit file FILENAME in another frame but don't allow changes.
1355 value))
1358 "Find file FILENAME as a replacement for the file in the next window.
1359 This command does not select that window.
1363 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1364 expand wildcards (if any) and replace the file with multiple files."
1376 t))))
1384 "Find file FILENAME, select its buffer, kill previous buffer.
1385 If the current buffer now contains an empty file that you just visited
1386 \(presumably by mistake), use this command to visit the file you really want.
1390 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1391 expand wildcards (if any) and replace the file with multiple files.
1393 If the current buffer is an indirect buffer, or the base buffer
1394 for one or more indirect buffers, the other buffer(s) are not
1395 killed."
1405 t)))
1426 ;; This prevents us from finding the same buffer
1427 ;; if we specified the same file again.
1431 ;; Likewise for dired buffers.
1435 ;; This executes if find-file gets an error
1436 ;; and does not really find anything.
1437 ;; We put things back as they were.
1438 ;; If find-file actually finds something, we kill obuf below.
1447 ;; We already asked; don't ask again.
1450 \f
1452 "Create a suitably named buffer for visiting FILENAME, and return it.
1453 FILENAME (sans directory) is used unchanged if that name is free;
1454 otherwise a string <2> or <3> or ... is appended to get an unused name.
1455 Spaces at the start of FILENAME (sans directory) are removed."
1464 "Create and return a buffer with a name based on NAME.
1465 Choose the buffer's name using `generate-new-buffer-name'."
1469 "Regexp to match the automounter prefix in a directory name."
1477 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1479 home directory is a root directory) and removes automounter prefixes
1480 \(see the variable `automount-dir-prefix')."
1481 ;; Get rid of the prefixes added by the automounter.
1488 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1489 ;; To fix this right, we need a `file-name-case-sensitive-p'
1490 ;; function, but we don't have that yet, so just guess.
1493 ;; If any elt of directory-abbrev-alist matches this name,
1494 ;; abbreviate accordingly.
1500 ;; Compute and save the abbreviated homedir name.
1501 ;; We defer computing this until the first time it's needed, to
1502 ;; give time for directory-abbrev-alist to be set properly.
1503 ;; We include a slash at the end, to avoid spurious matches
1504 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1511 ;; If FILENAME starts with the abbreviated homedir,
1512 ;; make it start with `~' instead.
1514 ;; If the home dir is just /, don't change it.
1517 ;; MS-DOS root directories can come with a drive letter;
1518 ;; Novell Netware allows drive letters beyond `Z:'.
1528 filename)))
1531 "List of logical names for which visiting shouldn't save the true dirname."
1536 "Return the buffer visiting file FILENAME (a string).
1537 This is like `get-file-buffer', except that it checks for any buffer
1538 visiting the same file, possibly under a different name.
1539 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1540 and others are ignored.
1541 If there is no such live buffer, return nil."
1555 found)
1565 ;; Verify this buffer's file number
1566 ;; still belongs to its file.
1569 attributes)
1573 found))))
1574 \f
1576 "Non-nil means file-visiting commands should handle wildcards.
1577 For example, if you specify `*.c', that would visit all the files
1578 whose names match the pattern."
1584 "Non-nil means suppress warning messages for symlinked files.
1585 When nil, Emacs prints a warning when visiting a file that is already
1586 visited, but with a different name. Setting this option to t
1587 suppresses this warning."
1593 "Maximum size of file above which a confirmation is requested.
1594 When nil, never request confirmation."
1601 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1602 OP-TYPE specifies the file operation being performed (for message to user)."
1612 "Read file FILENAME into a buffer and return the buffer.
1613 If a buffer exists visiting FILENAME, return that one, but
1614 verify that the file has not changed since visited or saved.
1615 The buffer is not selected, just returned to the caller.
1616 Optional second arg NOWARN non-nil means suppress any warning messages.
1617 Optional third arg RAWFILE non-nil means the file is read literally.
1618 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1619 and visit all the matching files. When wildcards are actually
1620 used and expanded, return a list of buffers that are visiting
1621 the various files."
1628 'find-directory-functions
1631 filename)))
1634 find-file-wildcards
1648 ;; Find any buffer for a file which has same truename.
1650 ;; Let user know if there is a buffer with the same truename.
1654 find-file-suppress-same-file-warnings
1658 ;; Optionally also find that buffer.
1661 ;; Check to see if the file looks uncommonly large.
1665 ;; We are using an existing buffer.
1672 ;; Certain files should be reverted automatically
1673 ;; if they have changed on disk and not in the buffer.
1681 found))
1691 "File %s changed on disk. Discard your edits? "
1696 "File %s changed on disk. Discard your edits in %s? "
1704 ;; Check if a formerly read-only file has become
1705 ;; writable and vice versa, but if the buffer agrees
1706 ;; with the new state of the file, that is ok too.
1714 buffer-file-name
1723 ;; It is confusing to ask whether to visit
1724 ;; non-literally if they have the file in
1725 ;; hexl-mode.
1731 "The file %s is already visited normally,
1732 and you have edited the buffer. Now you have asked to visit it literally,
1733 meaning no coding system handling, format conversion, or local variables.
1734 Emacs can only visit a file in one way at a time.
1736 Do you want to save the file, and visit it literally instead? "
1737 "The file %s is already visited literally,
1738 meaning no coding system handling, format conversion, or local variables.
1739 You have edited the buffer. Now you have asked to visit the file normally,
1740 but Emacs can only visit a file in one way at a time.
1747 rawfile truename number))
1751 "\
1752 Do you want to discard your changes, and visit the file literally now? "
1753 "\
1756 rawfile truename number)
1762 "The file %s is already visited normally.
1763 You have asked to visit it literally,
1764 meaning no coding system decoding, format conversion, or local variables.
1765 But Emacs can only visit a file in one way at a time.
1767 Do you want to revisit the file literally now? "
1768 "The file %s is already visited literally,
1769 meaning no coding system decoding, format conversion, or local variables.
1770 You have asked to visit it normally,
1771 but Emacs can only visit a file in one way at a time.
1776 rawfile truename number)
1779 ;; Return the buffer we are using.
1780 buf)
1781 ;; Create a new buffer.
1783 ;; find-file-noselect-1 may use a different buffer.
1785 rawfile truename number))))))
1791 ;; Needed in case we are re-visiting the file with a different
1792 ;; text representation.
1809 filename)))
1810 ;; Unconditionally set error
1820 filename)))
1821 ;; Run find-file-not-found-functions until one returns non-nil.
1823 ;; If they fail too, set error.
1825 ;; Record the file's truename, and maybe use that as visited name.
1833 ;; Set buffer's default directory to that of the file.
1835 ;; Turn off backup files for certain file names. Since
1836 ;; this is a permanent local, the major mode won't eliminate it.
1851 \f
1853 "Like `insert-file-contents', but only reads in the file literally.
1854 A buffer may be modified in several ways after reading into the buffer,
1855 to Emacs features such as format decoding, character code
1856 conversion, `find-file-hook', automatic uncompression, etc.
1858 This function ensures that none of these modifications will take place."
1866 nil))
1869 inhibit-file-name-handlers))
1882 filename)))
1883 ;; Check whether the file is uncommonly large
1894 "Insert contents of file FILENAME into buffer after point with no conversion.
1896 This function is meant for the user to run interactively.
1897 Don't call it from programs! Use `insert-file-contents-literally' instead.
1898 \(Its calling sequence is different; see its documentation)."
1903 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1908 "Visit file FILENAME with no conversion of any kind.
1909 Format conversion and character code conversion are both disabled,
1910 and multibyte characters are disabled in the resulting buffer.
1911 The major mode used is Fundamental mode regardless of the file name,
1912 and local variable specifications in the file are ignored.
1913 Automatic uncompression and adding a newline at the end of the
1914 file due to `require-final-newline' is also disabled.
1916 You cannot absolutely rely on this function to result in
1917 visiting the file literally. If Emacs already has a buffer
1918 which is visiting the file, you get the existing buffer,
1919 regardless of whether it was created literally or not.
1921 In a Lisp program, if you want to be sure of accessing a file's
1922 contents literally, you should create a temporary buffer and then read
1923 the file contents into it using `insert-file-contents-literally'."
1926 \f
1930 after-find-file-from-revert-buffer
1931 nomodes)
1932 "Called after finding a file and by the default revert function.
1933 Sets buffer mode, parses local variables.
1934 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1935 error in reading the file. WARN non-nil means warn if there
1936 exists an auto-save file more recent than the visited file.
1937 NOAUTO means don't mess with auto-save mode.
1938 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1939 means this call was from `revert-buffer'.
1940 Fifth arg NOMODES non-nil means don't alter the file's modes.
1941 Finishes by calling the functions in `find-file-hook'
1942 unless NOMODES is non-nil."
1945 nil
1955 ;; No need to warn if buffer is auto-saved
1956 ;; under the name of the visited file.
1958 auto-save-visited-file-name))
1961 buffer-file-name))
1981 ;; Make people do a little extra work (C-x C-q)
1982 ;; before altering a backup file.
1985 ;; When a file is marked read-only,
1986 ;; make the buffer read-only even if root is looking at it.
1994 ;; If requested, add a newline at the end of the file.
2004 view-read-only
2010 "Eval BODY and turn any error into a FORMAT message.
2011 FORMAT can have a %s escape which will be replaced with the actual error.
2012 If `debug-on-error' is set, errors are not caught, so that you can
2013 debug them.
2014 Avoid using a large BODY since it is duplicated."
2023 "Choose the major mode for this buffer automatically.
2024 Also sets up any specified local variables of the file.
2025 Uses the visited file name, the -*- line, and the local variables spec.
2027 This function is called automatically from `find-file'. In that case,
2028 we may set up the file-specified mode and local variables,
2029 depending on the value of `enable-local-variables'.
2030 In addition, if `local-enable-local-variables' is nil, we do
2031 not set local variables (though we do notice a mode specified with -*-.)
2033 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2034 or from Lisp without specifying the optional argument FIND-FILE;
2035 in that case, this function acts as if `enable-local-variables' were t."
2043 ;; Turn font lock off and on, to make sure it takes account of
2044 ;; whatever file local variables are relevant to it.
2046 ;; Font-lock-mode (now in font-core.el) can be ON when
2047 ;; font-lock.el still hasn't been loaded.
2057 "Non-nil means to try second pass through `auto-mode-alist'.
2058 This means that if the first case-sensitive search through the alist fails
2059 to find a matching major mode, a second case-insensitive search is made.
2060 On systems with case-insensitive file names, this variable is ignored,
2061 since only a single case-insensitive search through the alist is made."
2067 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2068 ;; c++-mode, java-mode and more) are added through autoload
2069 ;; directives in that file. That way is discouraged since it
2070 ;; spreads out the definition of the initial value.
2103 ;; Less common extensions come here
2104 ;; so more common ones above are found faster.
2143 ;; The list of archive file extensions should be in sync with
2144 ;; `auto-coding-alist' with `no-conversion' coding system.
2150 ;; Mailer puts message to be edited in
2151 ;; /tmp/Re.... or Message
2155 ;; some news reader is reported to use this
2164 ;; .emacs or .gnus or .viper following a directory delimiter in
2165 ;; Unix, MSDOG or VMS syntax.
2168 ;; _emacs following a directory delimiter
2169 ;; in MsDos syntax
2173 ;; Common Lisp ASDF package system.
2192 ;; Windows candidates may be opened case sensitively on Unix
2198 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2200 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2201 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2202 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2203 ;; this has lower priority to avoid matching changelog.sgml etc.
2205 ;; either user's dot-files or under /etc or some such
2207 ;; alas not all ~/.*rc files are like this
2208 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2213 ;; this contains everything twice, with space and with colon :-(
2215 ;; Get rid of any trailing .n.m and try again.
2216 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2217 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2218 ;; Using mode nil rather than `ignore' would let the search continue
2219 ;; through this list (with the shortened name) rather than start over.
2221 ;; The following should come after the ChangeLog pattern
2222 ;; for the sake of ChangeLog.1, etc.
2223 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2226 "Alist of filename patterns vs corresponding major mode functions.
2227 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2228 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2229 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2230 mode function to use. FUNCTION will be called, unless it is nil.
2232 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2233 calling FUNCTION (if it's not nil), we delete the suffix that matched
2234 REGEXP and search the list again for another match.
2236 If the file name matches `inhibit-first-line-modes-regexps',
2237 then `auto-mode-alist' is not processed.
2239 The extensions whose FUNCTION is `archive-mode' should also
2240 appear in `auto-coding-alist' with `no-conversion' coding system.
2242 See also `interpreter-mode-alist', which detects executable script modes
2243 based on the interpreters they specify to run,
2247 "Select Conf mode or XML mode according to start of file."
2257 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2258 ;; and pike-mode) are added through autoload directives in that
2259 ;; file. That way is discouraged since it spreads out the
2260 ;; definition of the initial value.
2298 "Alist mapping interpreter names to major modes.
2299 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2300 Each element looks like (INTERPRETER . MODE).
2301 If INTERPRETER matches the name of the interpreter specified in the first line
2302 of a script, mode MODE is enabled.
2310 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2311 When checking `inhibit-first-line-modes-regexps', we first discard
2317 "Regexp matching interpreters, for file mode determination.
2318 This regular expression is matched against the first line of a file
2319 to determine the file's mode in `set-auto-mode'. If it matches, the file
2320 is assumed to be interpreted by the interpreter matched by the second group
2321 of the regular expression. The mode is then determined as the mode
2325 "Alist of buffer beginnings vs. corresponding major mode functions.
2326 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2327 After visiting a file, if REGEXP matches the text at the beginning of the
2328 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2329 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2330 major mode.
2332 If FUNCTION is nil, then it is not called. (That is a way of saying
2338 ;; The < comes before the groups (but the first) to reduce backtracking.
2339 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2340 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2344 comment-re "*"
2347 . html-mode)
2349 ;; These two must come after html, because they are more general:
2354 . sgml-mode)
2357 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2358 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2359 After visiting a file, if REGEXP matches the text at the beginning of the
2360 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2361 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2362 have not specified a mode for this file.
2368 "Upper limit on `magic-mode-alist' regexp matches.
2372 "Select major mode appropriate for current buffer.
2374 To find the right major mode, this function checks for a -*- mode tag,
2375 checks if it uses an interpreter listed in `interpreter-mode-alist',
2376 matches the buffer beginning against `magic-mode-alist',
2377 compares the filename against the entries in `auto-mode-alist',
2378 then matches the buffer beginning against `magic-fallback-mode-alist'.
2380 It does not check for the `mode:' local variable in the
2381 Local Variables section of the file; for that, use `hack-local-variables'.
2383 If `enable-local-variables' is nil, this function does not check for a
2384 -*- mode tag.
2386 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2387 set the major mode only if that would change it. In other words
2388 we don't actually set it to the same mode the buffer already has."
2389 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2391 ;; Find a -*- mode tag
2398 ;; Find all specifications for the `mode:' variable
2399 ;; and execute them left to right.
2411 modes)))
2412 ;; Simple -*-MODE-*- case.
2415 modes))))
2416 ;; If we found modes to use, invoke them now, outside the save-excursion.
2424 ;; continuing would call minor modes again, toggling them off
2426 ;; If we didn't, look for an interpreter specified in the first line.
2427 ;; As a special case, allow for things like "#!/bin/env perl", which
2428 ;; finds the interpreter anywhere in $PATH.
2435 ;; Map interpreter name to a mode, signalling we're done at the
2436 ;; same time.
2438 interpreter-mode-alist))
2439 ;; If we found an interpreter mode to use, invoke it now.
2442 ;; Next try matching the buffer beginning against magic-mode-alist.
2456 ;; Next compare the filename against the entries in auto-mode-alist.
2461 ;; Remove remote file name identification.
2465 ;; Remove backup-suffixes from file name.
2468 ;; Find first matching alist entry.
2471 ;; System is case-insensitive.
2475 ;; System is case-sensitive.
2477 ;; First match case-sensitively.
2481 ;; Fallback to case-insensitive match.
2495 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2510 ;; When `keep-mode-if-same' is set, we are working on behalf of
2511 ;; set-visited-file-name. In that case, if the major mode specified is the
2512 ;; same one we already have, don't actually reset it. We don't want to lose
2513 ;; minor modes such as Font Lock.
2515 "Apply MODE and return it.
2516 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2517 any aliases and compared to current major mode. If they are the
2518 same, do nothing and return nil."
2524 mode)))
2527 "Find the -*- spec in the buffer.
2528 Call with point at the place to start searching from.
2529 If one is found, set point to the beginning
2530 and return the position of the end.
2531 Otherwise, return nil; point may be changed."
2534 ;; Don't look for -*- if this file name matches any
2535 ;; of the regexps in inhibit-first-line-modes-regexps.
2543 sufs)
2551 ;; If the file begins with "#!"
2552 ;; (exec interpreter magic), look
2553 ;; for mode frobs in the first two
2554 ;; lines. You cannot necessarily
2555 ;; put them in the first line of
2556 ;; such a file without screwing up
2557 ;; the interpreter invocation.
2558 ;; The same holds for
2559 ;; '\"
2560 ;; in man pages (preprocessor
2561 ;; magic for the `man' program).
2572 end))))
2573 \f
2574 ;;; Handling file local variables
2578 file-local-variables-alist)
2582 "Normal hook run after processing a file's local variables specs.
2583 Major modes can use this to examine user-specified local variables
2587 "List variable-value pairs that are considered safe.
2588 Each element is a cons cell (VAR . VAL), where VAR is a variable
2589 symbol and VAL is a value that is considered safe."
2594 "Expressions that are considered safe in an `eval:' local variable.
2595 Add expressions to this list if you want Emacs to evaluate them, when
2596 they appear in an `eval' local variable specification, without first
2597 asking you for confirmation."
2602 ;; Risky local variables:
2605 auto-mode-alist
2606 buffer-auto-save-file-name
2607 buffer-file-name
2608 buffer-file-truename
2609 buffer-undo-list
2610 dabbrev-case-fold-search
2611 dabbrev-case-replace
2612 debugger
2613 default-text-properties
2614 display-time-string
2615 enable-local-eval
2616 enable-local-variables
2617 eval
2618 exec-directory
2619 exec-path
2620 file-name-handler-alist
2621 font-lock-defaults
2622 format-alist
2623 frame-title-format
2624 global-mode-string
2625 header-line-format
2626 icon-title-format
2627 ignored-local-variables
2628 imenu--index-alist
2629 imenu-generic-expression
2630 inhibit-quit
2631 input-method-alist
2632 load-path
2633 max-lisp-eval-depth
2634 max-specpdl-size
2635 minor-mode-alist
2636 minor-mode-map-alist
2637 minor-mode-overriding-map-alist
2638 mode-line-buffer-identification
2639 mode-line-format
2640 mode-line-client
2641 mode-line-modes
2642 mode-line-modified
2643 mode-line-mule-info
2644 mode-line-position
2645 mode-line-process
2646 mode-line-remote
2647 mode-name
2648 outline-level
2649 overriding-local-map
2650 overriding-terminal-local-map
2651 parse-time-rules
2652 process-environment
2653 rmail-output-file-alist
2654 safe-local-variable-values
2655 safe-local-eval-forms
2656 save-some-buffers-action-alist
2657 special-display-buffer-names
2658 standard-input
2659 standard-output
2660 unread-command-events
2661 vc-mode))
2663 ;; Safe local variables:
2664 ;;
2665 ;; For variables defined by major modes, the safety declarations can go into
2666 ;; the major mode's file, since that will be loaded before file variables are
2667 ;; processed.
2668 ;;
2669 ;; For variables defined by minor modes, put the safety declarations in the
2670 ;; file defining the minor mode after the defcustom/defvar using an autoload
2671 ;; cookie, e.g.:
2672 ;;
2673 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2674 ;;
2675 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2676 ;; minor mode file may not be loaded yet.
2677 ;;
2678 ;; For variables defined in the C source code the declaration should go here:
2694 "Alist of file-local variable settings in the current buffer.
2695 Each element in this list has the form (VAR . VALUE), where VAR
2696 is a file-local variable (a symbol) and VALUE is the value
2697 specified. The actual value in the buffer may differ from VALUE,
2702 "Normal hook run before setting file-local variables.
2703 It is called after checking for unsafe/risky variables and
2704 setting `file-local-variables-alist', and before applying the
2705 variables stored in `file-local-variables-alist'. A hook
2706 function is allowed to change the contents of this alist.
2708 This hook is called only if there is at least one file-local
2712 "Get confirmation before setting up local variable values.
2713 ALL-VARS is the list of all variables to be set up.
2714 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2715 RISKY-VARS is the list of those that are marked as risky.
2716 DIR-NAME is a directory name if these settings come from
2717 directory-local variables, or nil otherwise."
2719 nil
2725 prompt char)
2735 ", and variables that are risky (**)."
2742 y -- to apply the local variables list.
2746 ! -- to apply the local variables list, and permanently mark these
2758 ;; Make strings with embedded whitespace easier to read.
2766 ""
2773 done)
2782 ;; read-event returns -1 if we are in a kbd
2783 ;; macro and there are no more events in the
2784 ;; macro. In that case, attempt to get an
2785 ;; event interactively.
2793 ;; When this is called from desktop-restore-file-buffer,
2794 ;; coding-system-for-read may be non-nil. Reset it before
2795 ;; writing to .emacs.
2799 'safe-local-variable-values
2800 safe-local-variable-values))))
2807 "Return local variables specified in the -*- line.
2808 Ignore any specification for `mode:' and `coding:';
2809 `set-auto-mode' should already have handled `mode:',
2810 `set-auto-coding' should already have handled `coding:'.
2812 If MODE-ONLY is non-nil, all we do is check whether the major
2813 mode is specified, returning t if it is specified. Otherwise,
2814 return an alist of elements (VAR . VAL), where VAR is a variable
2815 and VAL is the specified value."
2819 result mode-specified)
2820 ;; Parse the -*- line into the RESULT alist.
2821 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2823 nil)
2825 ;; Simple form: "-*- MODENAME -*-". Already handled.
2827 nil)
2829 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2830 ;; (last ";" is optional).
2835 ;; There used to be a downcase here,
2836 ;; but the manual didn't say so,
2837 ;; and people want to set var names that aren't all lc.
2842 ;; It is traditional to ignore
2843 ;; case when checking for `mode' in set-auto-mode,
2844 ;; so we must do that here as well.
2845 ;; That is inconsistent, but we're stuck with it.
2846 ;; The same can be said for `coding' in set-auto-coding.
2852 'eval
2859 mode-specified
2860 result))))
2863 "Filter local variable settings, querying the user if necessary.
2864 VARIABLES is the alist of variable-value settings. This alist is
2865 filtered based on the values of `ignored-local-variables',
2866 `enable-local-eval', `enable-local-variables', and (if necessary)
2867 user interaction. The results are added to
2868 `file-local-variables-alist', without applying them.
2869 DIR-NAME is a directory name if these settings come from
2870 directory-local variables, or nil otherwise."
2871 ;; Strip any variables that are in `ignored-local-variables'.
2874 ;; If `enable-local-eval' is nil, strip eval "variables".
2879 ;; Find those variables that we may want to save to
2880 ;; `safe-local-variable-values'.
2885 ;; Don't query about the fake variables.
2896 ;; If caller wants only safe variables, store only these.
2901 ;; Query, unless all are known safe or the user wants no
2902 ;; querying.
2908 variables unsafe-vars risky-vars dir-name))
2913 "Parse and put into effect this buffer's local variables spec.
2914 If MODE-ONLY is non-nil, all we do is check whether the major mode
2915 is specified, returning t if it is specified."
2918 result)
2925 ;; Look for "Local variables:" line in last page.
2933 ;; suffix is what comes after "local variables:" in its line.
2934 ;; prefix is what comes before "local variables:" in its line.
2944 beg)
2948 endpos
2954 nil t))
2955 ;; This used to be an error, but really all it means is
2956 ;; that this may simply not be a local-variables section,
2957 ;; so just ignore it.
2967 ;; Discard the prefix.
2972 ;; Discard the suffix.
2980 ;; Find the variable name; strip whitespace.
2988 val)
2989 ;; Read the variable value.
2999 'eval
3004 ;; Now we've read all the local variables.
3005 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3007 ;; Otherwise, set the variables.
3019 "Non-nil if SYM is safe as a file-local variable with value VAL.
3020 It is safe if any of these conditions are met:
3022 * There is a matching entry (SYM . VAL) in the
3023 `safe-local-variable-values' user option.
3025 * The `safe-local-variable' property of SYM is a function that
3026 evaluates to a non-nil value with VAL as an argument."
3032 "Non-nil if SYM could be dangerous as a file-local variable.
3033 It is dangerous if either of these conditions are met:
3035 * Its `risky-local-variable' property is non-nil.
3041 ;; If this is an alias, check the base name.
3061 "Return t if it is safe to eval EXP when it is found in a file."
3063 ;; Detect certain `put' expressions.
3070 lisp-indent-function
3071 scheme-indent-function))
3072 ;; Only allow safe values (not functions).
3077 ;; Only allow indirect form specs.
3078 ;; During bootstrapping, edebug-basic-spec might not be
3079 ;; defined yet.
3083 ;; Allow expressions that the user requested.
3085 ;; Certain functions can be allowed with safe arguments
3086 ;; or can specify verification functions to try.
3094 ok))
3102 ok)))))))
3105 "Set local variable VAR with value VAL.
3106 If VAR is `mode', call `VAL-mode' as a function unless it's
3107 already the major mode."
3117 ;; Make sure the string has no text properties.
3118 ;; Some text properties can get evaluated in various ways,
3119 ;; so it is risky to put them on with a local variable list.
3123 \f
3124 ;;; Handling directory-local variables, aka project settings.
3133 "Return the variable list for CLASS."
3137 "Collect directory-local variables from MODE-VARIABLES.
3138 VARIABLES is the initial list of variables.
3139 Returns the new list."
3146 ;; Need a new cons in case we setcdr later.
3150 "Collect entries from CLASS-VARIABLES into VARIABLES.
3151 ROOT is the root directory of the project.
3152 Return the new variables list."
3160 ;; Don't include this in the previous condition, because we
3161 ;; want to filter all strings before the next condition.
3173 "Declare that the DIRECTORY root is an instance of CLASS.
3174 DIRECTORY is the name of a directory, a string.
3175 CLASS is the name of a project class, a symbol.
3177 When a file beneath DIRECTORY is visited, the mode-specific
3178 variables from CLASS will be applied to the buffer. The variables
3179 for a class are defined using `dir-locals-set-class-variables'."
3186 "Map the type CLASS to a list of variable settings.
3187 CLASS is the project class, a symbol. VARIABLES is a list
3188 that declares directory-local variables for the class.
3189 An element in VARIABLES is either of the form:
3190 (MAJOR-MODE . ALIST)
3191 or
3192 (DIRECTORY . LIST)
3194 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3195 whose elements are of the form (VARIABLE . VALUE).
3197 In the second form, DIRECTORY is a directory name (a string), and
3198 LIST is a list of the form accepted by the function.
3200 When a file is visited, the file's class is found. A directory
3201 may be assigned a class using `dir-locals-set-directory-class'.
3202 Then variables are set in the file's buffer according to the
3203 class' LIST. The list is processed in order.
3205 * If the element is of the form (MAJOR-MODE . ALIST), and the
3206 buffer's major mode is derived from MAJOR-MODE (as determined
3207 by `derived-mode-p'), then all the variables in ALIST are
3208 applied. A MAJOR-MODE of nil may be used to match any buffer.
3209 `make-local-variable' is called for each variable before it is
3210 set.
3212 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3213 is an initial substring of the file's directory, then LIST is
3214 applied by recursively following these rules."
3221 "File that contains directory-local variables.
3222 It has to be constant to enforce uniform values
3226 "Find the directory-local variables FILE.
3227 This searches upward in the directory tree.
3228 If a local variables file is found, the file name is returned.
3229 If the file is already registered, a cons from
3230 `dir-locals-directory-alist' is returned.
3231 Otherwise this returns nil."
3235 ;; `locate-dominating-file' may have abbreviated the name.
3246 locals-file
3247 dir-elt)
3251 "Load a variables FILE and register a new class and instance.
3252 FILE is the name of the file holding the variables to apply.
3253 The new class name is the same as the directory in which FILE
3254 is found. Returns the new class name."
3256 ;; We should probably store the modtime of FILE and then
3257 ;; reload it whenever it changes.
3264 class-name)))
3269 "Read per-directory local variables for the current buffer.
3270 Store the directory-local variables in `file-local-variables-alist',
3271 without applying them."
3275 ;; Find the variables file.
3293 \f
3296 However, the mode will not be changed if
3297 \(1) a local variables list or the `-*-' line specifies a major mode, or
3299 \ not suitable for ordinary files, or
3300 \(3) the new file name does not particularly specify any mode."
3305 "Change name of file visited in current buffer to FILENAME.
3306 This also renames the buffer to correspond to the new file.
3307 The next time the buffer is saved it will go in the newly specified file.
3308 FILENAME nil or an empty string means mark buffer as not visiting any file.
3309 Remember to delete the initial contents of the minibuffer
3310 if you wish to pass an empty string as the argument.
3312 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3313 confirmation in the case where another buffer is already visiting FILENAME.
3315 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3316 the old visited file has been renamed to the new name FILENAME."
3324 nil
3339 filename)))
3349 ;; If new-name == old-name, renaming would add a spurious <2>
3350 ;; and it's considered as a feature in rename-buffer.
3356 ;; Abbreviate the file names of the buffer.
3365 nil)))
3366 ;; write-file-functions is normally used for things like ftp-find-file
3367 ;; that visit things that are not local files as if they were files.
3368 ;; Changing to visit an ordinary local file instead should flush the hook.
3373 ;; If buffer was read-only because of version control,
3374 ;; that reason is gone now, so make it writable.
3378 ;; Turn off backup files for certain file names.
3379 ;; Since this is a permanent local, the major mode won't eliminate it.
3381 backup-enable-predicate
3387 ;; If auto-save was not already on, turn it on if appropriate.
3391 ;; If auto save is on, start using a new name.
3392 ;; We deliberately don't rename or delete the old auto save
3393 ;; for the old visited file name. This is because perhaps
3394 ;; the user wants to save the new state and then compare with the
3395 ;; previous state from the auto save file.
3398 ;; Rename the old auto save file if any.
3405 ;; Update the major mode, if the file name determines it.
3407 ;; Don't change the mode if it is special.
3410 ;; Don't change the mode if the local variable list specifies it.
3416 "Write current buffer into file FILENAME.
3417 This makes the buffer visit that file, and marks it as not modified.
3419 If you specify just a directory name as FILENAME, that means to use
3420 the default file name but in that directory. You can also yank
3421 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3423 If the buffer is not already visiting a file, the default file name
3424 for the output file is the buffer name.
3426 If optional second arg CONFIRM is non-nil, this function
3427 asks for confirmation before overwriting an existing file.
3428 Interactively, confirmation is required unless you supply a prefix argument."
3429 ;; (interactive "FWrite file: ")
3433 nil nil nil nil)
3437 default-directory)
3438 nil nil))
3442 ;; If arg is just a directory,
3443 ;; use the default file name, but in that directory.
3454 ;; Make buffer writable if file is writable.
3459 ;; It's likely that the VC status at the new location is different from
3460 ;; the one at the old location.
3462 \f
3464 "Make a backup of the disk file visited by the current buffer, if appropriate.
3465 This is normally done before saving the buffer the first time.
3467 A backup may be done by renaming or by copying; see documentation of
3468 variable `make-backup-files'. If it's done by renaming, then the file is
3469 no longer accessible under its old name.
3471 The value is non-nil after a backup was made by renaming.
3472 It has the form (MODES . BACKUPNAME).
3473 MODES is the result of `file-modes' on the original
3474 file; this means that the caller, after saving the buffer, should change
3475 the modes of the new file to agree with the old modes.
3476 BACKUPNAME is the backup file name, which is the old file renamed."
3483 backup-info backupname targets setmodes)
3484 ;; If specified name is a symbolic link, chase it to the target.
3485 ;; Thus we make the backups in the directory where the real file is.
3490 ;; (if (file-directory-p buffer-file-name)
3491 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3495 ;; If have old versions to maybe delete,
3496 ;; ask the user to confirm now, before doing anything.
3497 ;; But don't actually delete til later.
3502 real-file-name)))))
3504 ;; Actually write the back up file.
3507 ; (file-symlink-p buffer-file-name)
3508 backup-by-copying
3509 ;; Don't rename a suid or sgid file.
3524 ;; rename-file should delete old backup.
3528 ;; If trouble writing the backup, write it in ~.
3533 backupname)
3537 ;; Now delete the old versions, if desired.
3544 setmodes)
3551 ;; Create temp files with strict access rights. It's easy to
3552 ;; loosen them later, whereas it's impossible to close the
3553 ;; time-window of loose permissions otherwise.
3556 ;; Try to overwrite old backup first.
3564 nil)
3566 ;; The file was somehow created by someone else between
3567 ;; `delete-file' and `copy-file', so let's try again.
3568 ;; rms says "I think there is also a possible race
3569 ;; condition for making backup files" (emacs-devel 20070821).
3570 nil)))
3571 ;; Reset the umask.
3577 "Return file NAME sans backup versions or strings.
3578 This is a separate procedure so your site-init or startup file can
3579 redefine it.
3580 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3581 we do not remove backup version numbers, only true file version numbers."
3593 "Return t if deleting FILE and rewriting it would preserve the owner."
3598 ;; Return t if the file doesn't exist, since it's true that no
3599 ;; information would be lost by an (attempted) delete and create.
3605 The extension, in a file name, is the part that follows the last `.',
3606 except that a leading `.', if any, doesn't count."
3609 directory)
3613 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3614 ;; we don't want to expand it.
3617 filename))))
3621 The extension, in a file name, is the part that follows the last `.',
3622 excluding version numbers and backup suffixes,
3623 except that a leading `.', if any, doesn't count.
3624 Return nil for extensionless file names such as `foo'.
3625 Return the empty string for file names such as `foo.'.
3627 If PERIOD is non-nil, then the returned value includes the period
3628 that delimits the extension, and if FILENAME has no extension,
3639 "A function to use instead of the default `make-backup-file-name'.
3640 A value of nil gives the default `make-backup-file-name' behavior.
3642 This could be buffer-local to do something special for specific
3643 files. If you define it, you may need to change `backup-file-name-p'
3644 and `file-name-sans-versions' too.
3646 See also `backup-directory-alist'."
3652 "Alist of filename patterns and backup directory names.
3653 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3654 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3655 relative or absolute. If it is absolute, so that all matching files
3656 are backed up into the same directory, the file names in this
3657 directory will be the full name of the file backed up with all
3658 directory separators changed to `!' to prevent clashes. This will not
3659 work correctly if your filesystem truncates the resulting name.
3661 For the common case of all backups going into one directory, the alist
3663 directory name.
3665 If this variable is nil, or it fails to match a filename, the backup
3666 is made in the original file's directory.
3668 On MS-DOS filesystems without long names this variable is always
3669 ignored."
3675 "Default `backup-enable-predicate' function.
3676 Checks for files in `temporary-file-directory',
3677 `small-temporary-file-directory', and /tmp."
3680 ;; Directory is under temporary-file-directory.
3685 ;; Directory is under /tmp.
3690 0 nil
3692 ;; Directory is under small-temporary-file-directory.
3697 "Create the non-numeric backup file name for FILE.
3698 Normally this will just be the file's name with `~' appended.
3699 Customization hooks are provided as follows.
3701 If the variable `make-backup-file-name-function' is non-nil, its value
3702 should be a function which will be called with FILE as its argument;
3703 the resulting name is used.
3705 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3706 the documentation of that variable. If the directory for the backup
3707 doesn't exist, it is created."
3721 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3723 elt backup-directory abs-backup-directory)
3728 alist nil)))
3729 ;; If backup-directory is relative, it should be relative to the
3730 ;; file's directory. By expanding explicitly here, we avoid
3731 ;; depending on default-directory.
3740 abs-backup-directory nil))))
3742 file
3746 ;; Normalize DOSish file names: downcase the drive
3747 ;; letter, if any, and replace the leading "x:" with
3748 ;; "/drive_x".
3751 ;; Replace any invalid file-name characters (for the
3752 ;; case of backing up remote files).
3756 "drive_"
3759 ""
3762 ;; Make the name unique by substituting directory
3763 ;; separators. It may not really be worth bothering about
3764 ;; doubling `!'s in the original name...
3769 backup-directory))
3774 "Return non-nil if FILE is a backup file name (numeric or not).
3775 This is a separate function so you can redefine it for customization.
3776 You may need to redefine `file-name-sans-versions' as well."
3781 ;; This is used in various files.
3782 ;; The usage of backup-extract-version-start is not very clean,
3783 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3785 "Given the name of a numeric backup file, FN, return the backup number.
3786 Uses the free variable `backup-extract-version-start', whose value should be
3787 the index in the name where the version number begins."
3794 "Find a file name for a backup file FN, and suggestions for deletions.
3795 Value is a list whose car is the name for the backup file
3796 and whose cdr is a list of old versions to consider deleting now.
3797 If the value is nil, don't make a backup.
3798 Uses `backup-directory-alist' in the same way as does
3799 `make-backup-file-name'."
3801 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3805 ;; We don't support numbered backups on plain MS-DOS
3806 ;; when long file names are unavailable.
3816 possibilities deserve-versions-p versions)
3819 base-versions
3822 possibilities)
3823 #'<)
3828 kept-old-versions
3829 kept-new-versions
3836 ;; Delete nothing if there is overflow
3837 ;; in the number of versions to keep.
3843 v))))))))))
3846 "Return number of names file FILENAME has."
3849 ;; (defun file-relative-name (filename &optional directory)
3850 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3851 ;; This function returns a relative file name which is equivalent to FILENAME
3852 ;; when used with that default directory as the default.
3853 ;; If this is impossible (which can happen on MSDOS and Windows
3854 ;; when the file name and directory use different drive names)
3855 ;; then it returns FILENAME."
3856 ;; (save-match-data
3857 ;; (let ((fname (expand-file-name filename)))
3858 ;; (setq directory (file-name-as-directory
3859 ;; (expand-file-name (or directory default-directory))))
3860 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3861 ;; ;; drive names, they can't be relative, so return the absolute name.
3862 ;; (if (and (or (eq system-type 'ms-dos)
3863 ;; (eq system-type 'cygwin)
3864 ;; (eq system-type 'windows-nt))
3865 ;; (not (string-equal (substring fname 0 2)
3866 ;; (substring directory 0 2))))
3867 ;; filename
3868 ;; (let ((ancestor ".")
3869 ;; (fname-dir (file-name-as-directory fname)))
3870 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3871 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3872 ;; (setq directory (file-name-directory (substring directory 0 -1))
3873 ;; ancestor (if (equal ancestor ".")
3874 ;; ".."
3875 ;; (concat "../" ancestor))))
3876 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3877 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3878 ;; ;; We matched within FNAME's directory part.
3879 ;; ;; Add the rest of FNAME onto ANCESTOR.
3880 ;; (let ((rest (substring fname (match-end 0))))
3881 ;; (if (and (equal ancestor ".")
3882 ;; (not (equal rest "")))
3883 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3884 ;; rest
3885 ;; (concat (file-name-as-directory ancestor) rest)))
3886 ;; ;; We matched FNAME's directory equivalent.
3887 ;; ancestor))))))
3890 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3891 This function returns a relative file name which is equivalent to FILENAME
3892 when used with that default directory as the default.
3893 If FILENAME and DIRECTORY lie on different machines or on different drives
3894 on a DOS/Windows machine, it returns FILENAME in expanded form."
3898 default-directory))))
3904 ;; Test for different drives on DOS/Windows
3906 ;; Should `cygwin' really be included here? --stef
3909 ;; Test for different remote file system identification
3911 filename
3917 directory nil nil case-fold-search))
3919 directory nil nil case-fold-search))))
3922 ".."
3924 ;; Now ancestor is empty, or .., or ../.., etc.
3926 directory nil nil case-fold-search))
3927 ;; We matched within FILENAME's directory part.
3928 ;; Add the rest of FILENAME onto ANCESTOR.
3931 ;; But don't bother with ANCESTOR if it would give us `./'.
3932 rest
3934 ;; We matched FILENAME's directory equivalent.
3935 ancestor))))))
3936 \f
3938 "Save current buffer in visited file if modified.
3939 Variations are described below.
3941 By default, makes the previous version into a backup file
3942 if previously requested or if this is the first save.
3944 to become a backup when the next save is done.
3946 unconditionally makes the previous version into a backup file.
3948 to become a backup when the next save is done,
3949 and unconditionally makes the previous version into a backup file.
3951 With a numeric argument of 0, never make the previous version
3952 into a backup file.
3954 If a file's name is FOO, the names of its numbered backup versions are
3955 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3956 Numeric backups (rather than FOO~) will be made if value of
3957 `version-control' is not the atom `never' and either there are already
3958 numeric versions of the file being backed up, or `version-control' is
3959 non-nil.
3960 We don't want excessive versions piling up, so there are variables
3961 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3962 and `kept-new-versions', which tells how many newest versions to keep.
3963 Defaults are 2 old versions and 2 new.
3964 `dired-kept-versions' controls dired's clean-directory (.) command.
3965 If `delete-old-versions' is nil, system will query user
3966 before trimming versions. Otherwise it does it silently.
3968 If `vc-make-backup-files' is nil, which is the default,
3969 no backup files are made for files managed by version control.
3970 (This is because the version control system itself records previous versions.)
3972 See the subroutine `basic-save-buffer' for more information."
3985 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3986 Normally delete only if the file was written by this Emacs since
3987 the last real save, but optional arg FORCE non-nil means delete anyway."
4001 "Normal hook that is run before a buffer is saved to its file."
4007 "Normal hook that is run after a buffer is saved to its file."
4013 "If non-nil, use this coding system for saving the buffer.
4014 More precisely, use this coding system in place of the
4015 value of `buffer-file-coding-system', when saving the buffer.
4016 Calling `write-region' for any purpose other than saving the buffer
4017 will still use `buffer-file-coding-system'; this variable has no effect
4024 "Save the current buffer in its visited file, if it has been modified.
4025 The hooks `write-contents-functions' and `write-file-functions' get a chance
4026 to do the job of saving; if they do not, then the buffer is saved in
4027 the visited file in the usual way.
4028 Before and after saving the buffer, this function runs
4029 `before-save-hook' and `after-save-hook', respectively."
4032 ;; In an indirect buffer, save its base buffer instead.
4037 setmodes)
4038 ;; If buffer has no file name, ask user for one.
4045 ;; Signal an error if the user specified the name of an
4046 ;; existing directory.
4049 filename))
4051 ;; Signal an error if the specified name refers to a
4052 ;; non-existing directory.
4082 ;; Support VC version backups.
4088 ;; If a hook returned t, file is already "written".
4089 ;; Otherwise, write it the usual way now.
4091 ;; Now we have saved the current buffer. Let's make sure
4092 ;; that buffer-file-coding-system is fixed to what
4093 ;; actually used for saving by binding it locally.
4103 ;; If the auto-save file was recent before this command,
4104 ;; delete it now.
4106 ;; Support VC `implicit' locking.
4111 ;; This does the "real job" of writing a buffer into its visited file
4112 ;; and making a backup file. This is what is normally done
4113 ;; but inhibited if one of write-file-functions returns non-nil.
4114 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4123 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4137 buffer-file-name)))
4145 ;; If file is precious, write temp name, then rename it.
4146 ;; This requires write access to the containing dir,
4147 ;; which is why we don't try it if we don't have that access.
4149 tempname succeed
4152 ;; Create temp files with strict access rights. It's easy to
4153 ;; loosen them later, whereas it's impossible to close the
4154 ;; time-window of loose permissions otherwise.
4159 ;; Try various temporary names.
4160 ;; This code follows the example of make-temp-file,
4161 ;; but it calls write-region in the appropriate way
4162 ;; for saving the buffer.
4168 ;; Pass in nil&nil rather than point-min&max
4169 ;; cause we're saving the whole buffer.
4170 ;; write-region-annotate-functions may use it.
4172 tempname nil realname
4174 nil)
4176 ;; The file was somehow created by someone else between
4177 ;; `make-temp-name' and `write-region', let's try again.
4178 nil)
4180 ;; Reset the umask.
4182 ;; If we failed, restore the buffer's modtime.
4185 ;; Since we have created an entirely new file,
4186 ;; make sure it gets the right permission bits set.
4190 buffer-file-name)))
4191 ;; We succeeded in writing the temp file,
4192 ;; so rename it.
4194 ;; If file not writable, see if we can make it writable
4195 ;; temporarily while we write it.
4196 ;; But no need to do so if we have just backed it up
4197 ;; (setmodes is set) because that says we're superseding.
4199 ;; Change the mode back, after writing.
4205 ;; Pass in nil&nil rather than point-min&max to indicate
4206 ;; we're saving the buffer rather than just a region.
4207 ;; write-region-annotate-functions may make us of it.
4209 buffer-file-name nil t buffer-file-truename)
4211 ;; If we get an error writing the new file, and we made
4212 ;; the backup by renaming, undo the backing-up.
4217 setmodes))
4220 "View the differences between BUFFER and its associated file.
4221 This requires the external program `diff' to be in your `exec-path'."
4235 ;; Display that message for 1 second so that user can read it
4236 ;; in the minibuffer.
4238 ;; return always nil, so that save-buffers-kill-emacs will not move
4239 ;; over to the next unsaved buffer when calling `d'.
4240 nil)
4243 `((?\C-r
4250 ;; Return nil to ask about BUF again.
4251 nil)
4263 ;; Return nil to ask about BUF again.
4264 nil)
4273 "Save some modified file-visiting buffers. Asks user about each one.
4274 You can answer `y' to save, `n' not to save, `C-r' to look at the
4275 buffer in question with `view-buffer' before deciding or `d' to
4276 view the differences using `diff-buffer-with-file'.
4278 Optional argument (the prefix) non-nil means save all with no questions.
4279 Optional second argument PRED determines which buffers are considered:
4280 If PRED is nil, all the file-visiting buffers are considered.
4281 If PRED is t, then certain non-file buffers will also be considered.
4282 If PRED is a zero-argument function, it indicates for each buffer whether
4283 to consider it or not when called with that buffer current.
4285 See `save-some-buffers-action-alist' if you want to
4286 change the additional actions you can take on files."
4290 files-done abbrevs-done)
4292 ;; First save any buffers that we're supposed to save unconditionally.
4293 ;; That way the following code won't ask about them.
4298 ;; Ask about those buffers that merit it,
4299 ;; and record the number thus saved.
4314 t
4326 save-some-buffers-action-alist))
4327 ;; Maybe to save abbrevs, and record whether
4328 ;; we either saved them or asked to.
4334 abbrev-file-name)))
4336 ;; Don't keep bothering user if he says no.
4341 "(Some special files were saved without asking)"
4343 \f
4345 "Mark current buffer as unmodified, not needing to be saved.
4348 It is not a good idea to use this function in Lisp programs, because it
4349 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4356 "Change whether this buffer is visiting its file read-only.
4357 With prefix argument ARG, make the buffer read-only if ARG is
4358 positive, otherwise make it writable. If visiting file read-only
4359 and `view-read-only' is non-nil, enter view mode."
4364 nil ; do nothing.
4365 ;; Toggle.
4372 ;; If view-mode is already active, `view-mode-enter' is a nop.
4384 "Insert contents of file FILENAME into buffer after point.
4385 Set mark after the inserted text.
4387 This function is meant for the user to run interactively.
4388 Don't call it from programs! Use `insert-file-contents' instead.
4389 \(Its calling sequence is different; see its documentation)."
4394 "Append the contents of the region to the end of file FILENAME.
4395 When called from a function, expects three arguments,
4396 START, END and FILENAME. START and END are buffer positions
4397 saying what text to write."
4402 "Return most recent backup file for FILENAME or nil if no backups exist."
4403 ;; `make-backup-file-name' will get us the right directory for
4404 ;; ordinary or numeric backups. It might create a directory for
4405 ;; backups as a side-effect, according to `backup-directory-alist'.
4412 tem)
4421 newest))
4424 "Rename current buffer to a similar name not already taken.
4425 This function is useful for creating multiple shell process buffers
4426 or multiple mail buffers, etc."
4434 ;; If the existing buffer name has a <NNN>,
4435 ;; which isn't part of the file name (if any),
4436 ;; then get rid of that.
4442 "Create the directory DIR and any nonexistent parent dirs.
4443 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4445 Interactively, the default choice of directory to create
4446 is the current default directory for file names.
4447 That is useful when you have visited a file in a nonexistent directory.
4449 Noninteractively, the second (optional) argument PARENTS says whether
4450 to create parent directories if they don't exist. Interactively,
4451 this happens by default."
4454 nil nil)
4455 t))
4456 ;; If default-directory is a remote directory,
4457 ;; make sure we find its make-directory handler.
4465 create-list)
4472 \f
4475 "Function to use to revert this buffer, or nil to do the default.
4476 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4481 "Function to use to insert contents when reverting this buffer.
4482 Gets two args, first the nominal file name to use,
4483 and second, t if reading the auto-save file.
4488 "Function to check whether a non-file buffer needs reverting.
4489 This should be a function with one optional argument NOCONFIRM.
4490 Auto Revert Mode passes t for NOCONFIRM. The function should return
4491 non-nil if the buffer should be reverted. A return value of
4492 `fast' means that the need for reverting was not checked, but
4493 that reverting the buffer is fast. The buffer is current when
4494 this function is called.
4496 The idea behind the NOCONFIRM argument is that it should be
4497 non-nil if the buffer is going to be reverted without asking the
4498 user. In such situations, one has to be careful with potentially
4499 time consuming operations.
4501 For more information on how this variable is used by Auto Revert mode,
4505 "Normal hook for `revert-buffer' to run before reverting.
4506 If `revert-buffer-function' is used to override the normal revert
4510 "Normal hook for `revert-buffer' to run after reverting.
4511 Note that the hook value that it runs is the value that was in effect
4512 before reverting; that makes a difference if you have buffer-local
4513 hook functions.
4515 If `revert-buffer-function' is used to override the normal revert
4521 "Replace current buffer text with the text of the visited file on disk.
4522 This undoes all changes since the file was visited or saved.
4523 With a prefix argument, offer to revert from latest auto-save file, if
4524 that is more recent than the visited file.
4526 This command also implements an interface for special buffers
4527 that contain text which doesn't come from a file, but reflects
4528 some other data instead (e.g. Dired buffers, `buffer-list'
4529 buffers). This is done via the variable `revert-buffer-function'.
4530 In these cases, it should reconstruct the buffer contents from the
4531 appropriate data.
4533 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4534 to revert from the auto-save file when this is nil. Note that the
4535 sense of this argument is the reverse of the prefix argument, for the
4536 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4537 to nil.
4539 Optional second argument NOCONFIRM means don't ask for confirmation
4540 at all. \(The variable `revert-without-query' offers another way to
4541 revert buffers without querying for confirmation.)
4543 Optional third argument PRESERVE-MODES non-nil means don't alter
4544 the files modes. Normally we reinitialize them using `normal-mode'.
4546 If the value of `revert-buffer-function' is non-nil, it is called to
4547 do all the work for this command. Otherwise, the hooks
4548 `before-revert-hook' and `after-revert-hook' are run at the beginning
4549 and the end, and if `revert-buffer-insert-file-contents-function' is
4550 non-nil, it is called instead of rereading visited file contents."
4552 ;; I admit it's odd to reverse the sense of the prefix argument, but
4553 ;; there is a lot of code out there which assumes that the first
4554 ;; argument should be t to avoid consulting the auto-save file, and
4555 ;; there's no straightforward way to encourage authors to notice a
4556 ;; reversal of the argument sense. So I'm just changing the user
4557 ;; interface, but leaving the programmatic interface the same.
4565 buffer-auto-save-file-name
4570 buffer-auto-save-file-name
4571 buffer-file-name)))
4581 file-name)))
4583 ;; If file was backed up but has changed since,
4584 ;; we shd make another backup.
4588 ;; Effectively copy the after-revert-hook status,
4589 ;; since after-find-file will clobber it.
4592 after-revert-hook))
4597 ;; Get rid of all undo records for this buffer.
4599 ;; Don't make undo records for the reversion.
4602 file-name auto-save-p)))
4605 "File %s no longer exists!"
4607 file-name))
4610 "File %s no longer readable!"
4612 file-name))
4614 ;; Bind buffer-file-name to nil
4615 ;; so that we don't try to lock the file.
4621 ;; Auto-saved file should be read by Emacs'
4622 ;; internal coding.
4625 buffer-file-coding-system-explicit))))
4627 coding-system-for-read
4629 coding-system-for-read)
4631 ;; As a coding system suitable for multibyte
4632 ;; buffer is specified, make the current
4633 ;; buffer multibyte.
4636 ;; This force after-insert-file-set-coding
4637 ;; (called from insert-file-contents) to set
4638 ;; buffer-file-coding-system to a proper value.
4641 ;; Note that this preserves point in an intelligent way.
4645 nil nil t))
4647 nil nil t)))))
4648 ;; Recompute the truename in case changes in symlinks
4649 ;; have changed the truename.
4653 ;; Run after-revert-hook as it was before we reverted.
4657 local-hook)
4660 t))))))
4663 "Recover the visited file--get contents from its last auto-save file."
4668 "Visit file FILE, but get contents from its last auto-save file."
4669 ;; Actually putting the file name in the minibuffer should be used
4670 ;; only rarely.
4671 ;; Not just because users often use the default.
4691 ;; Use insert-directory-safely, not insert-directory,
4692 ;; because these files might not exist. In particular,
4693 ;; FILE might not exist if the auto-save file was for
4694 ;; a buffer that didn't visit a file, such as "*mail*".
4695 ;; The code in v20.x called `ls' directly, so we need
4696 ;; to emulate what `ls' did in that case.
4702 ;; Keep the current buffer-file-coding-system.
4704 ;; Auto-saved file should be read with special coding.
4713 "Recover auto save files from a previous Emacs session.
4714 This command first displays a Dired buffer showing you the
4715 previous sessions that you could recover from.
4716 To choose one, move point to the proper line and then type C-c C-c.
4717 Then you'll be asked about a number of files to recover."
4727 auto-save-list-file-prefix)))
4728 t)
4737 ;; Each line starts with a space
4738 ;; so that Font Lock mode won't highlight the first character.
4747 "Choose one saved session to recover auto-save files from.
4748 This command is used in the special Dired buffer created by
4751 ;; Get the name of the session file to recover from.
4753 files
4759 ;; Read in the auto-save-list file.
4763 ;; Loop thru the text of that file
4764 ;; and get out the names of the files to recover.
4768 ;; This is a pair of lines for a non-file-visiting buffer.
4769 ;; Get the auto-save file name and manufacture
4770 ;; a "visited file name" from that.
4773 ;; If there is no auto-save file name, the
4774 ;; auto-save-list file is probably corrupted.
4787 ;; This pair of lines is a file-visiting
4788 ;; buffer. Use the visited file name.
4798 ;; Ignore a file if its auto-save file does not exist now.
4802 ;; The file contains a pair of line for each auto-saved buffer.
4803 ;; The first line of the pair contains the visited file name
4804 ;; or is empty if the buffer was not visiting a file.
4805 ;; The second line is the auto-save file name.
4813 files
4819 "Kill BUFFER if confirmed."
4827 "Kill some buffers. Asks the user whether to kill each one of them.
4828 Non-interactively, if optional argument LIST is non-nil, it
4829 specifies the list of buffers to kill, asking for approval for each one."
4837 ; if we killed the base buffer.
4844 "Kill buffers whose name matches the specified REGEXP.
4845 The optional second argument indicates whether to kill internal buffers too."
4854 \f
4856 "Toggle auto-saving of contents of current buffer.
4857 With prefix argument ARG, turn auto-saving on if positive, else off."
4862 ;; If auto-save is off because buffer has shrunk,
4863 ;; then toggling should turn it on.
4868 buffer-file-name
4870 ;; If -1 was stored here, to temporarily turn off saving,
4871 ;; turn it back on.
4877 buffer-auto-save-file-name)
4880 "Adjust current buffer's auto save file name for current conditions.
4881 Also rename any existing auto save file, if it was made in this session."
4893 "Return file name to use for auto-saves of current buffer.
4894 Does not consider `auto-save-visited-file-name' as that variable is checked
4895 before calling this function. You can redefine this for customization.
4896 See also `auto-save-file-name-p'."
4904 result uniq)
4905 ;; Apply user-specified translations
4906 ;; to the file name.
4910 filename)
4920 filename))))
4925 ;; We truncate the file name to DOS 8+3 limits
4926 ;; before doing anything else, because the regexp
4927 ;; passed to string-match below cannot handle
4928 ;; extensions longer than 3 characters, multiple
4929 ;; dots, and other atrocities.
4934 fn)
4939 "#"
4942 ;; Make sure auto-save file names don't contain characters
4943 ;; invalid for the underlying filesystem.
4945 ;; Don't modify remote (ange-ftp) filenames
4948 result))))
4950 ;; Deal with buffers that don't have any associated files. (Mail
4951 ;; mode tends to create a good number of these.)
4955 file-name)
4956 ;; Restrict the characters used in the file name to those which
4957 ;; are known to be safe on all filesystems, url-encoding the
4958 ;; rest.
4959 ;; We do this on all platforms, because even if we are not
4960 ;; running on DOS/Windows, the current directory may be on a
4961 ;; mounted VFAT filesystem, such as a USB memory stick.
4965 ;; For multibyte characters, this will produce more than
4966 ;; 2 hex digits, so is not true URL encoding.
4970 ;; Generate the file name.
4976 ;; Try a few alternative directories, to get one we can
4977 ;; write it.
4983 ;; Don't modify remote (ange-ftp) filenames
4985 ;; The call to convert-standard-filename is in case
4986 ;; buffer-name includes characters not allowed by the
4987 ;; DOS/Windows filesystems. make-temp-file writes to the
4988 ;; file it creates, so we must fix the file name _before_
4989 ;; make-temp-file is called.
4991 fname))
4993 ;; make-temp-file creates the file,
4994 ;; but we don't want it to exist until we do an auto-save.
4998 file-name)))
5001 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5002 FILENAME should lack slashes. You can redefine this for customization."
5004 \f
5006 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5007 The generated regexp will match a filename only if the filename
5008 matches that wildcard according to shell rules. Only wildcards known
5009 by `sh' are supported."
5011 ;; Copy the initial run of non-special characters.
5014 ;; If no special characters, we're almost done.
5018 j)
5020 result
5041 ;; Found "[^". Insert a `\0' character
5042 ;; (which cannot happen in a filename)
5043 ;; into the character class, so that `^'
5044 ;; is not the first character after `[',
5045 ;; and thus non-special in a regexp.
5050 ;; I don't think `]' can appear in a
5051 ;; character class in a wildcard, but
5052 ;; let's be general here.
5059 i
5072 ;; Shell wildcards should match the entire filename,
5073 ;; not its part. Make the regexp say so.
5075 \f
5077 "-CF"
5078 "Switches for `list-directory' to pass to `ls' for brief listing."
5083 "-l"
5084 "Switches for `list-directory' to pass to `ls' for verbose listing."
5089 "Expand wildcard pattern PATTERN.
5090 This returns a list of file names which match the pattern.
5092 If PATTERN is written as an absolute file name,
5093 the values are absolute also.
5095 If PATTERN is written as a relative file name, it is interpreted
5096 relative to the current default directory, `default-directory'.
5097 The file names returned are normally also relative to the current
5098 default directory. However, if FULL is non-nil, they are absolute."
5102 ;; A list of all dirs that DIRPART specifies.
5103 ;; This can be more than one dir
5104 ;; if DIRPART contains wildcards.
5109 contents)
5114 ;; Filter out "." and ".."
5119 name))
5126 this-dir-contents)
5127 this-dir-contents)
5128 contents))))
5130 contents)))
5133 "Display a list of files in or matching DIRNAME, a la `ls'.
5134 DIRNAME is globbed by the shell if necessary.
5135 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5136 Actions controlled by variables `list-directory-brief-switches'
5137 and `list-directory-verbose-switches'."
5141 nil default-directory nil)
5142 pfx)))
5144 list-directory-brief-switches))
5145 buffer)
5158 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5166 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5168 PATTERN is assumed to represent a file-name wildcard suitable for the
5169 underlying filesystem. For Unix and GNU/Linux, the characters from the
5171 the parts of the pattern which don't include wildcard characters are
5172 quoted with double quotes.
5173 Existing quote characters in PATTERN are left alone, so you can pass
5174 PATTERN that already quotes some of the special characters."
5178 ;; DOS/Windows don't allow `"' in file names. So if the
5179 ;; argument has quotes, we can safely assume it is already
5180 ;; quoted by the caller.
5182 ;; We quote [&()#$'] in case their shell is a port of a
5183 ;; Unixy shell. We quote [,=+] because stock DOS and
5184 ;; Windows shells require that in some cases, such as
5185 ;; passing arguments to batch files that use positional
5186 ;; arguments like %1.
5188 pattern
5191 end)
5208 pattern))))
5215 "Program to get the amount of free space on a file system.
5216 We assume the output has the format of `df'.
5217 The value of this variable must be just a command name or file name;
5218 if you want to specify options, use `directory-free-space-args'.
5220 A value of nil disables this feature.
5222 If the function `file-system-info' is defined, it is always used in
5223 preference to the program given by this variable."
5229 "Options to use when running `directory-free-space-program'."
5234 "Return the amount of free space on directory DIR's file system.
5235 The result is a string that gives the number of free 1KB blocks,
5236 or nil if the system call or the program which retrieve the information
5237 fail. It returns also nil when DIR is a remote directory.
5239 This function calls `file-system-info' if it is available, or invokes the
5240 program specified by `directory-free-space-program' if that is non-nil."
5242 ;; Try to find the number of free blocks. Non-Posix systems don't
5243 ;; always have df, but might have an equivalent system call.
5252 nil t nil
5253 directory-free-space-args
5254 dir)))
5255 ;; Usual format is a header line followed by a line of
5256 ;; numbers.
5261 ;; Move to the end of the "available blocks" number.
5264 ;; Copy it into AVAILABLE.
5269 ;; The following expression replaces `dired-move-to-filename-regexp'.
5273 ;; In some locales, month abbreviations are as short as 2 letters,
5274 ;; and they can be followed by ".".
5275 ;; In Breton, a month name can include a quote character.
5288 s "+"
5291 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5292 ;; omits the Kanji characters after month and day-of-month.
5293 ;; On Mac OS X 10.3, the date format in East Asian locales is
5294 ;; day-of-month digits followed by month digits.
5300 ;; The "[0-9]" below requires the previous column to end in a digit.
5301 ;; This avoids recognizing `1 may 1997' as a date in the line:
5302 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5304 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5305 ;; The ".*" below finds the last match if there are multiple matches.
5306 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5307 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5309 ;; vc dired listings provide the state or blanks between file
5310 ;; permissions and date. The state is always surrounded by
5311 ;; parantheses:
5312 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5313 ;; This is not supported yet.
5317 "Regular expression to match up to the file name in a directory listing.
5318 The default value is designed to recognize dates and times
5323 ;; insert-directory
5324 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5325 ;; FULL-DIRECTORY-P is nil.
5326 ;; The single line of output must display FILE's name as it was
5327 ;; given, namely, an absolute path name.
5328 ;; - must insert exactly one line for each file if WILDCARD or
5329 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5330 ;; before the file lines, plus optional text after the file lines.
5331 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5332 ;; allowed.
5333 ;; File lines should display the basename.
5334 ;; - must be consistent with
5335 ;; - functions dired-move-to-filename, (these two define what a file line is)
5336 ;; dired-move-to-end-of-filename,
5337 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5338 ;; dired-insert-headerline
5339 ;; dired-after-subdir-garbage (defines what a "total" line is)
5340 ;; - variable dired-subdir-regexp
5341 ;; - may be passed "--dired" as the first argument in SWITCHES.
5342 ;; Filename handlers might have to remove this switch if their
5343 ;; "ls" command does not support it.
5345 "Insert directory listing for FILE, formatted according to SWITCHES.
5346 Leaves point after the inserted text.
5347 SWITCHES may be a string of options, or a list of strings
5348 representing individual options.
5349 Optional third arg WILDCARD means treat FILE as shell wildcard.
5350 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5351 switches do not contain `d', so that a full listing is expected.
5353 This works by running a directory listing program
5354 whose name is in the variable `insert-directory-program'.
5355 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5357 When SWITCHES contains the long `--dired' option, this function
5358 treats it specially, for the sake of dired. However, the
5359 normally equivalent short `-D' option is just passed on to
5360 `insert-directory-program', as any other option."
5361 ;; We need the directory in order to find the right handler.
5366 wildcard full-directory-p)
5369 ;; Read the actual directory using `insert-directory-program'.
5370 ;; RESULT gets the status code.
5372 ;; putting text property `dired-filename, decode one
5373 ;; bunch by one to preserve that property.
5375 ;; This is to control encoding the arguments in call-process.
5379 default-file-name-coding-system))))
5382 ;; Run ls in the directory part of the file pattern
5383 ;; using the last component as argument.
5390 shell-file-name nil t nil
5391 "-c"
5393 ""
5395 insert-directory-program
5396 " -d "
5398 switches
5400 " -- "
5401 ;; Quote some characters that have
5402 ;; special meanings in shells; but
5403 ;; don't quote the wildcards--we want
5404 ;; them to be special. We also
5405 ;; currently don't quote the quoting
5406 ;; characters in case people want to
5407 ;; use them explicitly to quote
5408 ;; wildcard characters.
5410 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5411 ;; directory if FILE is a symbolic link.
5413 insert-directory-program nil t nil
5417 ;; Split the switches at any spaces so we can
5418 ;; pass separate options as separate args.
5420 ;; Avoid lossage if FILE starts with `-'.
5428 file))))))))
5430 ;; If we got "//DIRED//" in the output, it means we got a real
5431 ;; directory listing, even if `ls' returned nonzero.
5432 ;; So ignore any errors.
5445 ;; The first time ls returns an error,
5446 ;; find the version numbers of ls,
5447 ;; and set insert-directory-ls-version
5448 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5449 ;; is equal or if the info cannot be obtained.
5450 ;; (That can mean it isn't GNU ls.)
5460 comparison)
5476 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5480 ;; If `insert-directory-program' failed, signal an error.
5482 ;; Delete the error message it may have output.
5484 ;; On non-Posix systems, we cannot open a directory, so
5485 ;; don't even try, because that will always result in
5486 ;; the ubiquitous "Access denied". Instead, show the
5487 ;; command line so the user can try to guess what went wrong.
5492 insert-directory-program
5494 file result)
5495 ;; Unix. Access the file to get a suitable error.
5502 ;; The following overshoots by one line for an empty
5503 ;; directory listed with "--dired", but without "-a"
5504 ;; switch, where the ls output contains a
5505 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5506 ;; We take care of that case later.
5514 error-lines)
5515 ;; Find all the lines that are error messages,
5516 ;; and record the bounds of each one.
5523 ;; Now read the numeric positions of file names.
5530 error-lines))
5533 error-lines)))
5535 ;; End is followed by \n or by " -> ".
5537 ;; It seems that we can't trust ls's output as to
5538 ;; byte positions of filenames.
5544 ;; Take care of the case where the ls output contains a
5545 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5546 ;; and we went one line too far back (see above).
5551 ;; Now decode what read if necessary.
5553 file-name-coding-system
5554 default-file-name-coding-system
5556 coding-no-eol
5557 val pos)
5561 ;; If no coding system is specified or detection is
5562 ;; requested, detect the coding.
5576 ;; Force no eol conversion on a file name, so
5577 ;; that CR is preserved.
5585 ;; Try to insert the amount of free space.
5588 ;; First find the line to put it on.
5592 ;; Replace "total" with "used", to avoid confusion.
5598 "Convert `ls --dired' file name position value POS to a buffer position.
5599 File name position values returned in ls --dired output
5600 count only stdout; they don't count the error messages sent to stderr.
5601 So this function converts to them to real buffer positions.
5602 ERROR-LINES is a list of buffer positions of error message lines,
5603 of the form (START END)."
5607 pos)
5611 "Insert directory listing for FILE, formatted according to SWITCHES.
5613 Like `insert-directory', but if FILE does not exist, it inserts a
5614 message to that effect instead of signaling an error."
5617 ;; Simulate the message printed by `ls'.
5621 "Functions to call with no arguments to query about killing Emacs.
5622 If any of these functions returns nil, killing Emacs is cancelled.
5623 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5627 "How to ask for confirmation when leaving Emacs.
5628 If nil, the default, don't ask at all. If the value is non-nil, it should
5629 be a predicate function such as `yes-or-no-p'."
5637 "Offer to save each buffer, then kill this Emacs process.
5638 With prefix ARG, silently save all file-visiting buffers, then kill."
5647 ;; process-list is not defined on MSDOS.
5649 active)
5658 ;; Query the user for other things, perhaps.
5665 "Offer to save each buffer, then kill the current connection.
5666 If the current frame has no client, kill Emacs itself.
5668 With prefix ARG, silently save all file-visiting buffers, then kill.
5670 If emacsclient was started with a list of filenames to edit, then
5671 only these files will be asked to be saved."
5679 \f
5680 ;; We use /: as a prefix to "quote" a file name
5681 ;; so that magic file name handlers will not apply to it.
5685 file-name-handler-alist))
5687 ;; We depend on being the last handler on the list,
5688 ;; so that anything else which does need handling
5689 ;; has been handled already.
5690 ;; So it is safe for us to inhibit *all* magic file name handlers.
5699 default-directory))
5700 ;; Get a list of the indices of the args which are file names.
5703 ;; The first six are special because they
5704 ;; return a file name. We want to include the /:
5705 ;; in the return value.
5706 ;; So just avoid stripping it in the first place.
5713 ;; `identity' means just return the first arg
5714 ;; not stripped of its quoting.
5716 ;; `add' means add "/:" to the result.
5718 ;; `quote' means add "/:" to buffer-file-name.
5720 ;; `unquote-then-quote' means set buffer-file-name
5721 ;; temporarily to unquoted filename.
5723 ;; List the arguments which are filenames.
5731 ;; For all other operations, treat the first argument only
5732 ;; as the file name.
5734 method
5735 ;; Copy ARGUMENTS so we can replace elements in it.
5739 ;; Strip off the /: from the file names that have it.
5747 "/"
5763 res))
5766 \f
5767 ;; Symbolic modes and read-file-modes.
5770 "Convert CHAR to a numeric bit-mask for extracting mode bits.
5771 CHAR is in [ugoa] and represents the category of users (Owner, Group,
5772 Others, or All) for whom to produce the mask.
5773 The bit-mask that is returned extracts from mode bits the access rights
5774 for the specified category of users."
5782 "Convert CHAR to a numeric value of mode bits.
5783 CHAR is in [rwxXstugo] and represents symbolic access permissions.
5784 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
5791 ;; Rights relative to the previous file modes.
5802 "Convert a symbolic mode string specification to an equivalent number.
5804 WHO-MASK is the bit-mask specifying the category of users to which to
5805 apply the access permissions. See `file-modes-char-to-who'.
5806 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5807 RIGHTS request to add, remove, or set permissions based on existing ones,
5814 char-right)
5821 num-rights
5825 op char-right)))
5826 num-rights))
5829 "Convert symbolic file modes to numeric file modes.
5830 MODES is the string to convert, it should match
5833 notation.
5834 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5835 MODES request to add, remove, or set permissions based on existing ones,
5849 num-who num-modes)
5852 num-modes)))
5855 "Read file modes in octal or symbolic notation and return its numeric value.
5856 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5857 ORIG-FILE is the name of a file on whose mode bits to base returned
5858 permissions if what user types requests to add, remove, or set permissions
5874 nil nil default)))
5880 \f
5881 ;; Trashcan handling.
5883 "Directory for `move-file-to-trash' to move files and directories to.
5884 This directory is only used when the function `system-move-file-to-trash' is
5885 not defined. Relative paths are interpreted relative to `default-directory'.
5886 See also `delete-by-moving-to-trash'."
5894 "Move file (or directory) name FILENAME to the trash.
5895 This function is called by `delete-file' and `delete-directory' when
5896 `delete-by-moving-to-trash' is non-nil. On platforms that define
5897 `system-move-file-to-trash', that function is used to move FILENAME to the
5898 system trash, otherwise FILENAME is moved to `trash-directory'.
5899 Returns nil on success."
5912 ;; make new-fn unique.
5913 ;; example: "~/.Trash/abc.txt" -> "~/.Trash/abc.txt.~1~"
5916 ;; stop processing if fn is same or parent directory of trash-dir.
5919 filename))
5923 \f
5948 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5949 ;;; files.el ends here