| blob | 0e303805d0ca9e0c891a02fb74d279e97231fd3f |
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 writable, Emacs may ignore a non-nil value
246 of `file-precious-flag' and write directly into the file.
248 See also: `break-hardlink-on-save'."
253 "Non-nil means when saving a file that exists under several names
254 \(i.e., has multiple hardlinks), break the hardlink associated with
255 `buffer-file-name' and write to a new file, so that the other
256 instances of the file are not affected by the save.
258 If `buffer-file-name' refers to a symlink, do not break the symlink.
260 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
261 For example, if the directory in which a file is being saved is not
262 itself writable, then error instead of saving in some
263 hardlink-nonbreaking way.
265 See also `backup-by-copying' and `backup-by-copying-when-linked'."
271 "Control use of version numbers for backup files.
272 When t, make numeric backup versions unconditionally.
273 When nil, make them for files that have some already.
274 The value `never' means do not make them."
284 "When cleaning directory, number of versions to keep."
290 "If t, delete excess backup versions silently.
291 If nil, ask confirmation. Any other value prevents any trimming."
298 "Number of oldest versions to keep when a new numbered backup is made."
304 "Number of newest versions to keep when a new numbered backup is made.
305 Includes the new backup. Must be > 0"
311 "Whether to add a newline automatically at the end of the file.
313 A value of t means do this only when the file is about to be saved.
314 A value of `visit' means do this right after the file is visited.
315 A value of `visit-save' means do it at both of those times.
316 Any other non-nil value means ask user whether to add a newline, when saving.
317 A value of nil means don't add newlines.
319 Certain major modes set this locally to the value obtained
320 from `mode-require-final-newline'."
329 "Whether to add a newline at end of file, in certain major modes.
330 Those modes set `require-final-newline' to this value when you enable them.
331 They do so because they are often used for files that are supposed
332 to end in newlines, and the question is how to arrange that.
334 A value of t means do this only when the file is about to be saved.
335 A value of `visit' means do this right after the file is visited.
336 A value of `visit-save' means do it at both of those times.
337 Any other non-nil value means ask user whether to add a newline, when saving.
339 A value of nil means do not add newlines. That is a risky choice in this
340 variable since this value is used for modes for files that ought to have
341 final newlines. So if you set this to nil, you must explicitly check and
342 add a final newline, whenever you save a file that really needs one."
352 "Non-nil says by default do auto-saving of every file-visiting buffer."
358 ;; Don't put "\\2" inside expand-file-name, since it will be
359 ;; transformed to "/2" on DOS/Windows.
361 "Transforms to apply to buffer file name before making auto-save file name.
362 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
363 REGEXP is a regular expression to match against the file name.
364 If it matches, `replace-match' is used to replace the
365 matching part with REPLACEMENT.
366 If the optional element UNIQUIFY is non-nil, the auto-save file name is
367 constructed by taking the directory part of the replaced file-name,
368 concatenated with the buffer file name with all directory separators
369 changed to `!' to prevent clashes. This will not work
370 correctly if your filesystem truncates the resulting name.
372 All the transforms in the list are tried, in the order they are listed.
373 When one transform applies, its result is final;
374 no further transforms are tried.
376 The default value is set up to put the auto-save file into the
377 temporary directory (see the variable `temporary-file-directory') for
378 editing a remote file.
380 On MS-DOS filesystems without long names this variable is always
381 ignored."
388 "Non-nil means save word abbrevs too when files are saved.
389 If `silently', don't ask the user before saving."
394 "Non-nil means allow `find-file' to visit directories.
395 To visit the directory, `find-file' runs `find-directory-functions'."
400 "List of functions to try in sequence to visit a directory.
401 Each function is called with the directory name as the sole argument
402 and should return either a buffer or nil."
406 ;;;It is not useful to make this a local variable.
407 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
409 "List of functions to be called for `find-file' on nonexistent file.
410 These functions are called as soon as the error is detected.
411 Variable `buffer-file-name' is already set up.
416 ;;;It is not useful to make this a local variable.
417 ;;;(put 'find-file-hooks 'permanent-local t)
420 "List of functions to be called after a buffer is loaded from a file.
421 The buffer's local variables (if any) will have been processed before the
422 functions are called."
429 "List of functions to be called before writing out a buffer to a file.
430 If one of them returns non-nil, the file is considered already written
431 and the rest are not called.
432 These hooks are considered to pertain to the visited file.
433 So any buffer-local binding of this variable is discarded if you change
435 change the major mode.
437 This hook is not run if any of the functions in
438 `write-contents-functions' returns non-nil. Both hooks pertain
439 to how to save a buffer to file, for instance, choosing a suitable
440 coding system and setting mode bits. (See Info
441 node `(elisp)Saving Buffers'.) To perform various checks or
452 "List of functions to be called before writing out a buffer to a file.
453 If one of them returns non-nil, the file is considered already written
454 and the rest are not called and neither are the functions in
455 `write-file-functions'.
457 This variable is meant to be used for hooks that pertain to the
458 buffer's contents, not to the particular visited file; thus,
459 `set-visited-file-name' does not clear this variable; but changing the
460 major mode does clear it.
462 For hooks that _do_ pertain to the particular visited file, use
463 `write-file-functions'. Both this variable and
464 `write-file-functions' relate to how a buffer is saved to file.
465 To perform various checks or updates before the buffer is saved,
472 "Control use of local variables in files you visit.
473 The value can be t, nil, :safe, :all, or something else.
475 A value of t means file local variables specifications are obeyed
476 if all the specified variable values are safe; if any values are
477 not safe, Emacs queries you, once, whether to set them all.
478 \(When you say yes to certain values, they are remembered as safe.)
480 :safe means set the safe variables, and ignore the rest.
481 :all means set all variables, whether safe or not.
482 (Don't set it permanently to :all.)
483 A value of nil means always ignore the file local variables.
485 Any other value means always query you once whether to set them all.
486 \(When you say yes to certain values, they are remembered as safe, but
489 This variable also controls use of major modes specified in
490 a -*- line.
493 always obeys file local variable specifications and the -*- line,
494 and ignores this variable."
503 "Like `enable-local-variables' but meant for buffer-local bindings.
504 The meaningful values are nil and non-nil. The default is non-nil.
505 If a major mode sets this to nil, buffer-locally, then any local
506 variables list in the file will be ignored.
508 This variable does not affect the use of major modes
513 The value can be t, nil or something else.
514 A value of t means obey `eval' variables.
515 A value of nil means ignore them; anything else means query."
521 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
530 "Non-nil means buffers visiting files read-only do so in view mode.
531 In fact, this means that all read-only buffers normally have
532 View mode enabled, including buffers that are read-only because
533 you visit a file you cannot alter, and buffers you make read-only
539 "History list of file names entered in the minibuffer.
541 Maximum length of the history list is determined by the value
543 \f
546 "Provides support for ange-ftp host name completion.
547 Runs the usual ange-ftp hook, but only for completion operations."
548 ;; Having this here avoids the need to load ange-ftp when it's not
549 ;; really in use.
555 inhibit-file-name-handlers)))
560 "Convert a standard file's name to something suitable for the OS.
561 This means to guarantee valid names and perhaps to canonicalize
562 certain patterns.
564 FILENAME should be an absolute file name since the conversion rules
565 sometimes vary depending on the position in the file name. E.g. c:/foo
566 is a valid DOS file name, but c:/bar/c:/foo is not.
568 This function's standard definition is trivial; it just returns
569 the argument. However, on Windows and DOS, replace invalid
570 characters. On DOS, make sure to obey the 8.3 limitations.
571 In the native Windows build, turn Cygwin names into native names,
572 and also turn slashes into backslashes if the shell requires it (see
573 `w32-shell-dos-semantics').
575 See Info node `(elisp)Standard File Names' for more details."
579 ;; Replace invalid filename characters with !
583 name)
584 filename))
587 "Read directory name, prompting with PROMPT and completing in directory DIR.
588 Value is not expanded---you must call `expand-file-name' yourself.
589 Default name to DEFAULT-DIRNAME if user exits with the same
590 non-empty string that was inserted by this function.
591 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
592 or just DIR if INITIAL is nil.)
593 If the user exits with an empty minibuffer, this function returns
594 an empty string. (This can only happen if the user erased the
595 pre-inserted contents or if `insert-default-directory' is nil.)
596 Fourth arg MUSTMATCH non-nil means require existing directory's name.
597 Non-nil and non-t means also require confirmation after completion.
598 Fifth arg INITIAL specifies text to start with.
599 DIR should be an absolute directory name. It defaults to
600 the value of `default-directory'."
605 dir))
606 mustmatch initial
609 \f
611 "Show the current default directory."
616 "Value of the CDPATH environment variable, as a list.
620 "Explode a search path into a list of directory names.
621 Directories are separated by occurrences of `path-separator'
622 \(which is colon in GNU and GNU-like systems)."
623 ;; We could use split-string here.
631 nil
636 cd-list)))
639 "Change current directory to given absolute file name DIR."
640 ;; Put the name into directory syntax now,
641 ;; because otherwise expand-file-name may give some bad results.
654 "Make DIR become the current buffer's default directory.
655 If your environment includes a `CDPATH' variable, try each one of
656 that list of directories (separated by occurrences of
657 `path-separator') when resolving a relative directory name.
658 The path separator is colon in GNU and GNU-like systems."
661 default-directory default-directory
677 cd-path)
678 nil))
682 "Load the Lisp file named FILE."
683 ;; This is a case where .elc makes a lot of sense.
690 "Search for FILENAME through PATH.
691 If found, return the absolute file name of FILENAME, with its suffixes;
692 otherwise return nil.
693 PATH should be a list of directories to look in, like the lists in
694 `exec-path' or `load-path'.
695 If SUFFIXES is non-nil, it should be a list of suffixes to append to
698 If non-nil, PREDICATE is used instead of `file-readable-p'.
699 PREDICATE can also be an integer to pass to the `access' system call,
700 in which case file-name handlers are ignored. This usage is deprecated.
702 For compatibility, PREDICATE can also be one of the symbols
703 `executable', `readable', `writable', or `exists', or a list of
704 one or more of those symbols."
715 "Do completion for file names passed to `locate-file'."
736 "Do completion for file names passed to `locate-file'.
737 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
740 string nil action))
745 "Regexp of directory names which stop the search in `locate-dominating-file'.
746 Any directory whose name matches this regexp will be treated like
747 a kind of root directory by `locate-dominating-file' which will stop its search
748 when it bumps into it.
749 The default regexp prevents fruitless and time-consuming attempts to find
752 ;; (defun locate-dominating-files (file regexp)
753 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
754 ;; Stop at the first parent where a matching file is found and return the list
755 ;; of files that that match in this directory."
756 ;; (catch 'found
757 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
758 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
759 ;; (let ((user nil)
760 ;; ;; Abbreviate, so as to stop when we cross ~/.
761 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
762 ;; files)
763 ;; (while (and dir
764 ;; ;; As a heuristic, we stop looking up the hierarchy of
765 ;; ;; directories as soon as we find a directory belonging to
766 ;; ;; another user. This should save us from looking in
767 ;; ;; things like /net and /afs. This assumes that all the
768 ;; ;; files inside a project belong to the same user.
769 ;; (let ((prev-user user))
770 ;; (setq user (nth 2 (file-attributes dir)))
771 ;; (or (null prev-user) (equal user prev-user))))
772 ;; (if (setq files (condition-case nil
773 ;; (directory-files dir 'full regexp 'nosort)
774 ;; (error nil)))
775 ;; (throw 'found files)
776 ;; (if (equal dir
777 ;; (setq dir (file-name-directory
778 ;; (directory-file-name dir))))
779 ;; (setq dir nil))))
780 ;; nil)))
783 "Look up the directory hierarchy from FILE for a file named NAME.
784 Stop at the first parent directory containing a file NAME,
785 and return the directory. Return nil if not found."
786 ;; We used to use the above locate-dominating-files code, but the
787 ;; directory-files call is very costly, so we're much better off doing
788 ;; multiple calls using the code in here.
789 ;;
790 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
791 ;; `name' in /home or in /.
795 ;; `user' is not initialized outside the loop because
796 ;; `file' may not exist, so we may have to walk up part of the
797 ;; hierarchy before we find the "initial UID".
799 try)
802 ;; FIXME: Disabled this heuristic because it is sometimes
803 ;; inappropriate.
804 ;; As a heuristic, we stop looking up the hierarchy of
805 ;; directories as soon as we find a directory belonging
806 ;; to another user. This should save us from looking in
807 ;; things like /net and /afs. This assumes that all the
808 ;; files inside a project belong to the same user.
809 ;; (let ((prev-user user))
810 ;; (setq user (nth 2 (file-attributes file)))
811 ;; (and prev-user (not (equal user prev-user))))
819 root))
823 "Search for COMMAND in `exec-path' and return the absolute file name.
824 Return nil if COMMAND is not found anywhere in `exec-path'."
825 ;; Use 1 rather than file-executable-p to better match the behavior of
826 ;; call-process.
830 "Load the library named LIBRARY.
831 This is an interface to the function `load'."
835 load-path
840 "Test whether FILE specifies a location on a remote system.
841 Returns nil or a string identifying the remote connection (ideally
842 a prefix of FILE). For example, the remote identification for filename
845 less reliable than accessing local files.
846 Furthermore, relative file names do not work across remote connections.
848 IDENTIFICATION specifies which part of the identification shall
849 be returned as string. IDENTIFICATION can be the symbol
850 `method', `user', `host' or `localname'; any other value is
851 handled like nil and means to return the complete identification
852 string.
854 If CONNECTED is non-nil, the function returns an identification only
855 if FILE is located on a remote system, and a connection is established
856 to that remote system.
858 `file-remote-p' will never open a connection on its own."
862 nil)))
865 "Copy the file FILE into a temporary file on this machine.
866 Returns the name of the local copy, or nil, if FILE is directly
867 accessible."
868 ;; This formerly had an optional BUFFER argument that wasn't used by
869 ;; anything.
873 nil)))
876 "Return the truename of FILENAME, which should be absolute.
877 The truename of a file name is found by chasing symbolic links
878 both at the level of the file and at the level of the directories
879 containing it, until no links are left at any level.
882 ;; COUNTER and PREV-DIRS are only used in recursive calls.
883 ;; COUNTER can be a cons cell whose car is the count of how many
884 ;; more links to chase before getting an error.
885 ;; PREV-DIRS can be a cons cell whose car is an alist
886 ;; of truenames we've just recently computed.
900 ;; For speed, remove the ange-ftp completion handler from the list.
901 ;; We know it's not needed here.
902 ;; For even more speed, do this only on the outermost call.
909 ;; andrewi@harlequin.co.uk - none of the following code (except for
910 ;; invoking the file-name handler) currently applies on Windows
911 ;; (ie. there are no native symlinks), but there is an issue with
912 ;; case differences being ignored by the OS, and short "8.3 DOS"
913 ;; name aliases existing for all files. (The short names are not
914 ;; reported by directory-files, but can be used to refer to files.)
915 ;; It seems appropriate for file-truename to resolve these issues in
916 ;; the most natural way, which on Windows is to call the function
917 ;; `w32-long-file-name' - this returns the exact name of a file as
918 ;; it is stored on disk (expanding short name aliases with the full
919 ;; name in the process).
922 ;; For file name that has a special handler, call handler.
923 ;; This is so that ange-ftp can save time by doing a no-op.
926 ;; If filename contains a wildcard, newname will be the old name.
928 ;; If filename exists, use the long name. If it doesn't exist,
929 ;; drill down until we find a directory that exists, and use
930 ;; the long name of that, with the extra non-existent path
931 ;; components concatenated.
933 missing rest)
936 ;; Include the preceding directory separator in the missing
937 ;; part so subsequent recursion on the rest works.
942 ""
947 ;; If this file directly leads to a link, process that iteratively
948 ;; so that we don't use lots of stack.
954 ;; For file name that has a special handler, call handler.
955 ;; This is so that ange-ftp can save time by doing a no-op.
958 done t)
960 target dirfile)
961 ;; Get the truename of the directory.
963 ;; If these are equal, we have the (or a) root directory.
965 ;; If this is the same dir we last got the truename for,
966 ;; save time--don't recalculate.
976 done t)
979 done t)
980 ;; Put it back on the file name.
982 ;; Is the file name the name of a link?
985 ;; Yes => chase that link, then start all over
986 ;; since the link may point to a directory name that uses links.
987 ;; We can't safely use expand-file-name here
988 ;; since target might look like foo/../bar where foo
989 ;; is itself a link. Instead, we handle . and .. above.
992 target
994 done nil)
995 ;; No, we are done!
997 filename))
1000 "Chase links in FILENAME until a name that is not a link.
1001 Unlike `file-truename', this does not check whether a parent
1002 directory name is a symbolic link.
1003 If the optional argument LIMIT is a number,
1004 it means chase no more than that many links and then stop."
1012 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1015 ;; Handle `..' by hand, since it needs to work in the
1016 ;; target of any directory symlink.
1017 ;; This code is not quite complete; it does not handle
1018 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1022 ;; Chase links in the default dir of the symlink.
1026 ;; Now find the parent of that dir.
1030 newname))
1033 "Create a temporary file.
1034 The returned file name (created by appending some random characters at the end
1035 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1036 is guaranteed to point to a newly created empty file.
1037 You can then use `write-region' to write new data into the file.
1039 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1041 If SUFFIX is non-nil, add that at the end of the file name."
1043 file)
1046 ;; Create temp files with strict access rights. It's easy to
1047 ;; loosen them later, whereas it's impossible to close the
1048 ;; time-window of loose permissions otherwise.
1056 temporary-file-directory)
1058 temporary-file-directory))))
1064 nil)
1066 ;; the file was somehow created by someone else between
1067 ;; `make-temp-name' and `write-region', let's try again.
1068 nil)
1069 file)
1070 ;; Reset the umask.
1074 "Change the encoding of FILE's name from CODING to NEW-CODING.
1075 The value is a new name of FILE.
1076 Signals a `file-already-exists' error if a file of the new name
1077 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1078 is non-nil. A number as fourth arg means request confirmation if
1079 the new name already exists. This is what happens in interactive
1080 use with M-x."
1083 default-file-name-coding-system))
1085 from-coding to-coding)
1087 ;; We provide the default coding only when it seems that
1088 ;; the filename is correctly decoded by the default
1089 ;; coding.
1095 filename default-coding)
1096 default-coding))
1100 ;; We provide the default coding only when a user is going to
1101 ;; change the encoding not from the default coding.
1105 filename from-coding)))
1108 filename from-coding default-coding)
1109 default-coding)))
1113 default-file-name-coding-system))
1114 ;; FILE should have been decoded by DEFAULT-CODING.
1118 ;; Suppress further encoding.
1123 newname))
1124 \f
1126 "Whether confirmation is requested before visiting a new file or buffer.
1127 If nil, confirmation is not requested.
1128 If the value is `after-completion', confirmation is only
1129 requested if the user called `minibuffer-complete' right before
1130 `minibuffer-complete-and-exit'.
1131 Any other non-nil value means to request confirmation.
1133 This affects commands like `switch-to-buffer' and `find-file'."
1141 "Whether to request confirmation before visiting a new file or buffer.
1142 The variable `confirm-nonexistent-file-or-buffer' determines the
1143 return value, which may be passed as the REQUIRE-MATCH arg to
1144 `read-buffer' or `find-file-read-args'."
1152 "Read the name of a buffer to switch to and return as a string.
1153 It is intended for `switch-to-buffer' family of commands since they
1154 need to omit the name of current buffer from the list of completions
1155 and default values."
1163 "Select the buffer specified by BUFFER-OR-NAME in another window.
1164 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1165 nil. Return the buffer switched to.
1167 If called interactively, prompt for the buffer name using the
1168 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1169 determines whether to request confirmation before creating a new
1170 buffer.
1172 If BUFFER-OR-NAME is a string and does not identify an existing
1173 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1174 nil, switch to the buffer returned by `other-buffer'.
1176 Optional second argument NORECORD non-nil means do not put this
1177 buffer at the front of the list of recently selected ones.
1179 This uses the function `display-buffer' as a subroutine; see its
1180 documentation for additional customization information."
1184 same-window-buffer-names same-window-regexps)
1188 "Switch to buffer BUFFER-OR-NAME in another frame.
1189 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1190 nil. Return the buffer switched to.
1192 If called interactively, prompt for the buffer name using the
1193 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1194 determines whether to request confirmation before creating a new
1195 buffer.
1197 If BUFFER-OR-NAME is a string and does not identify an existing
1198 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1199 nil, switch to the buffer returned by `other-buffer'.
1201 Optional second arg NORECORD non-nil means do not put this
1202 buffer at the front of the list of recently selected ones.
1204 This uses the function `display-buffer' as a subroutine; see its
1205 documentation for additional customization information."
1209 same-window-buffer-names same-window-regexps)
1213 "Display buffer BUFFER in another frame.
1214 This uses the function `display-buffer' as a subroutine; see
1215 its documentation for additional customization information."
1218 same-window-buffer-names same-window-regexps
1220 new-window)
1222 ;; This may have been here in order to prevent the new frame from hiding
1223 ;; the old frame. But it does more harm than good.
1224 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1225 ;;(lower-frame (window-frame new-window))
1227 ;; This may have been here in order to make sure the old-frame gets the
1228 ;; focus. But not only can it cause an annoying flicker, with some
1229 ;; window-managers it just makes the window invisible, with no easy
1230 ;; way to recover it. --Stef
1231 ;;(make-frame-invisible (window-frame old-window))
1232 ;;(make-frame-visible (window-frame old-window))
1233 ))
1239 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1240 BODY should use the minibuffer at most once.
1241 Recursive uses of the minibuffer will not be affected."
1247 ;; Clear out this hook so it does not interfere
1248 ;; with any recursive minibuffer usage.
1264 t))
1267 "Edit file FILENAME.
1268 Switch to a buffer visiting file FILENAME,
1269 creating one if none already exists.
1270 Interactively, the default if you just type RET is the current directory,
1271 but the visited file name is available through the minibuffer history:
1272 type M-n to pull it into the minibuffer.
1274 You can visit files on remote machines by specifying something
1275 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1276 also visit local files as a different user by specifying
1277 /sudo::FILE for the file name.
1278 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1279 manual, for more about this.
1281 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1282 expand wildcards (if any) and visit multiple files. You can
1283 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1285 To visit a file without any kind of conversion and without
1296 "Edit file FILENAME, in another window.
1299 an existing one. See the function `display-buffer'.
1301 Interactively, the default if you just type RET is the current directory,
1302 but the visited file name is available through the minibuffer history:
1303 type M-n to pull it into the minibuffer.
1305 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1306 expand wildcards (if any) and visit multiple files."
1319 "Edit file FILENAME, in another frame.
1322 an existing one. See the function `display-buffer'.
1324 Interactively, the default if you just type RET is the current directory,
1325 but the visited file name is available through the minibuffer history:
1326 type M-n to pull it into the minibuffer.
1328 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1329 expand wildcards (if any) and visit multiple files."
1342 "Edit the existing file FILENAME.
1344 file names with wildcards."
1352 "Edit file FILENAME but don't allow changes.
1366 value))
1369 "Edit file FILENAME in another window but don't allow changes.
1383 value))
1386 "Edit file FILENAME in another frame but don't allow changes.
1400 value))
1403 "Find file FILENAME as a replacement for the file in the next window.
1404 This command does not select that window.
1408 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1409 expand wildcards (if any) and replace the file with multiple files."
1421 t))))
1429 "Find file FILENAME, select its buffer, kill previous buffer.
1430 If the current buffer now contains an empty file that you just visited
1431 \(presumably by mistake), use this command to visit the file you really want.
1435 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1436 expand wildcards (if any) and replace the file with multiple files.
1438 If the current buffer is an indirect buffer, or the base buffer
1439 for one or more indirect buffers, the other buffer(s) are not
1440 killed."
1450 t)))
1471 ;; This prevents us from finding the same buffer
1472 ;; if we specified the same file again.
1476 ;; Likewise for dired buffers.
1480 ;; This executes if find-file gets an error
1481 ;; and does not really find anything.
1482 ;; We put things back as they were.
1483 ;; If find-file actually finds something, we kill obuf below.
1492 ;; We already asked; don't ask again.
1495 \f
1497 "Create a suitably named buffer for visiting FILENAME, and return it.
1498 FILENAME (sans directory) is used unchanged if that name is free;
1499 otherwise a string <2> or <3> or ... is appended to get an unused name.
1500 Spaces at the start of FILENAME (sans directory) are removed."
1509 "Create and return a buffer with a name based on NAME.
1510 Choose the buffer's name using `generate-new-buffer-name'."
1514 "Regexp to match the automounter prefix in a directory name."
1522 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1524 home directory is a root directory) and removes automounter prefixes
1525 \(see the variable `automount-dir-prefix')."
1526 ;; Get rid of the prefixes added by the automounter.
1533 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1534 ;; To fix this right, we need a `file-name-case-sensitive-p'
1535 ;; function, but we don't have that yet, so just guess.
1538 ;; If any elt of directory-abbrev-alist matches this name,
1539 ;; abbreviate accordingly.
1545 ;; Compute and save the abbreviated homedir name.
1546 ;; We defer computing this until the first time it's needed, to
1547 ;; give time for directory-abbrev-alist to be set properly.
1548 ;; We include a slash at the end, to avoid spurious matches
1549 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1556 ;; If FILENAME starts with the abbreviated homedir,
1557 ;; make it start with `~' instead.
1559 ;; If the home dir is just /, don't change it.
1562 ;; MS-DOS root directories can come with a drive letter;
1563 ;; Novell Netware allows drive letters beyond `Z:'.
1573 filename)))
1576 "List of logical names for which visiting shouldn't save the true dirname."
1581 "Return the buffer visiting file FILENAME (a string).
1582 This is like `get-file-buffer', except that it checks for any buffer
1583 visiting the same file, possibly under a different name.
1584 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1585 and others are ignored.
1586 If there is no such live buffer, return nil."
1600 found)
1610 ;; Verify this buffer's file number
1611 ;; still belongs to its file.
1614 attributes)
1618 found))))
1619 \f
1621 "Non-nil means file-visiting commands should handle wildcards.
1622 For example, if you specify `*.c', that would visit all the files
1623 whose names match the pattern."
1629 "Non-nil means suppress warning messages for symlinked files.
1630 When nil, Emacs prints a warning when visiting a file that is already
1631 visited, but with a different name. Setting this option to t
1632 suppresses this warning."
1638 "Maximum size of file above which a confirmation is requested.
1639 When nil, never request confirmation."
1646 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1647 OP-TYPE specifies the file operation being performed (for message to user)."
1657 "Read file FILENAME into a buffer and return the buffer.
1658 If a buffer exists visiting FILENAME, return that one, but
1659 verify that the file has not changed since visited or saved.
1660 The buffer is not selected, just returned to the caller.
1661 Optional second arg NOWARN non-nil means suppress any warning messages.
1662 Optional third arg RAWFILE non-nil means the file is read literally.
1663 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1664 and visit all the matching files. When wildcards are actually
1665 used and expanded, return a list of buffers that are visiting
1666 the various files."
1673 'find-directory-functions
1676 filename)))
1679 find-file-wildcards
1693 ;; Find any buffer for a file which has same truename.
1695 ;; Let user know if there is a buffer with the same truename.
1699 find-file-suppress-same-file-warnings
1703 ;; Optionally also find that buffer.
1706 ;; Check to see if the file looks uncommonly large.
1710 ;; We are using an existing buffer.
1717 ;; Certain files should be reverted automatically
1718 ;; if they have changed on disk and not in the buffer.
1726 found))
1736 "File %s changed on disk. Discard your edits? "
1741 "File %s changed on disk. Discard your edits in %s? "
1749 ;; Check if a formerly read-only file has become
1750 ;; writable and vice versa, but if the buffer agrees
1751 ;; with the new state of the file, that is ok too.
1759 buffer-file-name
1768 ;; It is confusing to ask whether to visit
1769 ;; non-literally if they have the file in
1770 ;; hexl-mode.
1776 "The file %s is already visited normally,
1777 and you have edited the buffer. Now you have asked to visit it literally,
1778 meaning no coding system handling, format conversion, or local variables.
1779 Emacs can only visit a file in one way at a time.
1781 Do you want to save the file, and visit it literally instead? "
1782 "The file %s is already visited literally,
1783 meaning no coding system handling, format conversion, or local variables.
1784 You have edited the buffer. Now you have asked to visit the file normally,
1785 but Emacs can only visit a file in one way at a time.
1792 rawfile truename number))
1796 "\
1797 Do you want to discard your changes, and visit the file literally now? "
1798 "\
1801 rawfile truename number)
1807 "The file %s is already visited normally.
1808 You have asked to visit it literally,
1809 meaning no coding system decoding, format conversion, or local variables.
1810 But Emacs can only visit a file in one way at a time.
1812 Do you want to revisit the file literally now? "
1813 "The file %s is already visited literally,
1814 meaning no coding system decoding, format conversion, or local variables.
1815 You have asked to visit it normally,
1816 but Emacs can only visit a file in one way at a time.
1821 rawfile truename number)
1824 ;; Return the buffer we are using.
1825 buf)
1826 ;; Create a new buffer.
1828 ;; find-file-noselect-1 may use a different buffer.
1830 rawfile truename number))))))
1836 ;; Needed in case we are re-visiting the file with a different
1837 ;; text representation.
1854 filename)))
1855 ;; Unconditionally set error
1865 filename)))
1866 ;; Run find-file-not-found-functions until one returns non-nil.
1868 ;; If they fail too, set error.
1870 ;; Record the file's truename, and maybe use that as visited name.
1878 ;; Set buffer's default directory to that of the file.
1880 ;; Turn off backup files for certain file names. Since
1881 ;; this is a permanent local, the major mode won't eliminate it.
1896 \f
1898 "Like `insert-file-contents', but only reads in the file literally.
1899 A buffer may be modified in several ways after reading into the buffer,
1900 to Emacs features such as format decoding, character code
1901 conversion, `find-file-hook', automatic uncompression, etc.
1903 This function ensures that none of these modifications will take place."
1911 nil))
1914 inhibit-file-name-handlers))
1927 filename)))
1928 ;; Check whether the file is uncommonly large
1939 "Insert contents of file FILENAME into buffer after point with no conversion.
1941 This function is meant for the user to run interactively.
1942 Don't call it from programs! Use `insert-file-contents-literally' instead.
1943 \(Its calling sequence is different; see its documentation)."
1948 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1953 "Visit file FILENAME with no conversion of any kind.
1954 Format conversion and character code conversion are both disabled,
1955 and multibyte characters are disabled in the resulting buffer.
1956 The major mode used is Fundamental mode regardless of the file name,
1957 and local variable specifications in the file are ignored.
1958 Automatic uncompression and adding a newline at the end of the
1959 file due to `require-final-newline' is also disabled.
1961 You cannot absolutely rely on this function to result in
1962 visiting the file literally. If Emacs already has a buffer
1963 which is visiting the file, you get the existing buffer,
1964 regardless of whether it was created literally or not.
1966 In a Lisp program, if you want to be sure of accessing a file's
1967 contents literally, you should create a temporary buffer and then read
1968 the file contents into it using `insert-file-contents-literally'."
1971 \f
1975 after-find-file-from-revert-buffer
1976 nomodes)
1977 "Called after finding a file and by the default revert function.
1978 Sets buffer mode, parses local variables.
1979 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1980 error in reading the file. WARN non-nil means warn if there
1981 exists an auto-save file more recent than the visited file.
1982 NOAUTO means don't mess with auto-save mode.
1983 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1984 means this call was from `revert-buffer'.
1985 Fifth arg NOMODES non-nil means don't alter the file's modes.
1986 Finishes by calling the functions in `find-file-hook'
1987 unless NOMODES is non-nil."
1990 nil
2000 ;; No need to warn if buffer is auto-saved
2001 ;; under the name of the visited file.
2003 auto-save-visited-file-name))
2006 buffer-file-name))
2026 ;; Make people do a little extra work (C-x C-q)
2027 ;; before altering a backup file.
2030 ;; When a file is marked read-only,
2031 ;; make the buffer read-only even if root is looking at it.
2039 ;; If requested, add a newline at the end of the file.
2049 view-read-only
2055 "Eval BODY and turn any error into a FORMAT message.
2056 FORMAT can have a %s escape which will be replaced with the actual error.
2057 If `debug-on-error' is set, errors are not caught, so that you can
2058 debug them.
2059 Avoid using a large BODY since it is duplicated."
2068 "Choose the major mode for this buffer automatically.
2069 Also sets up any specified local variables of the file.
2070 Uses the visited file name, the -*- line, and the local variables spec.
2072 This function is called automatically from `find-file'. In that case,
2073 we may set up the file-specified mode and local variables,
2074 depending on the value of `enable-local-variables'.
2075 In addition, if `local-enable-local-variables' is nil, we do
2076 not set local variables (though we do notice a mode specified with -*-.)
2078 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2079 or from Lisp without specifying the optional argument FIND-FILE;
2080 in that case, this function acts as if `enable-local-variables' were t."
2088 ;; Turn font lock off and on, to make sure it takes account of
2089 ;; whatever file local variables are relevant to it.
2091 ;; Font-lock-mode (now in font-core.el) can be ON when
2092 ;; font-lock.el still hasn't been loaded.
2102 "Non-nil means to try second pass through `auto-mode-alist'.
2103 This means that if the first case-sensitive search through the alist fails
2104 to find a matching major mode, a second case-insensitive search is made.
2105 On systems with case-insensitive file names, this variable is ignored,
2106 since only a single case-insensitive search through the alist is made."
2112 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2113 ;; c++-mode, java-mode and more) are added through autoload
2114 ;; directives in that file. That way is discouraged since it
2115 ;; spreads out the definition of the initial value.
2148 ;; Less common extensions come here
2149 ;; so more common ones above are found faster.
2188 ;; The list of archive file extensions should be in sync with
2189 ;; `auto-coding-alist' with `no-conversion' coding system.
2195 ;; Mailer puts message to be edited in
2196 ;; /tmp/Re.... or Message
2200 ;; some news reader is reported to use this
2209 ;; .emacs or .gnus or .viper following a directory delimiter in
2210 ;; Unix, MSDOG or VMS syntax.
2213 ;; _emacs following a directory delimiter
2214 ;; in MsDos syntax
2218 ;; Common Lisp ASDF package system.
2237 ;; Windows candidates may be opened case sensitively on Unix
2243 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2245 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2246 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2247 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2248 ;; this has lower priority to avoid matching changelog.sgml etc.
2250 ;; either user's dot-files or under /etc or some such
2252 ;; alas not all ~/.*rc files are like this
2253 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2258 ;; this contains everything twice, with space and with colon :-(
2260 ;; Get rid of any trailing .n.m and try again.
2261 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2262 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2263 ;; Using mode nil rather than `ignore' would let the search continue
2264 ;; through this list (with the shortened name) rather than start over.
2266 ;; The following should come after the ChangeLog pattern
2267 ;; for the sake of ChangeLog.1, etc.
2268 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2271 "Alist of filename patterns vs corresponding major mode functions.
2272 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2273 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2274 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2275 mode function to use. FUNCTION will be called, unless it is nil.
2277 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2278 calling FUNCTION (if it's not nil), we delete the suffix that matched
2279 REGEXP and search the list again for another match.
2281 If the file name matches `inhibit-first-line-modes-regexps',
2282 then `auto-mode-alist' is not processed.
2284 The extensions whose FUNCTION is `archive-mode' should also
2285 appear in `auto-coding-alist' with `no-conversion' coding system.
2287 See also `interpreter-mode-alist', which detects executable script modes
2288 based on the interpreters they specify to run,
2292 "Select Conf mode or XML mode according to start of file."
2302 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2303 ;; and pike-mode) are added through autoload directives in that
2304 ;; file. That way is discouraged since it spreads out the
2305 ;; definition of the initial value.
2343 "Alist mapping interpreter names to major modes.
2344 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2345 Each element looks like (INTERPRETER . MODE).
2346 If INTERPRETER matches the name of the interpreter specified in the first line
2347 of a script, mode MODE is enabled.
2355 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2356 When checking `inhibit-first-line-modes-regexps', we first discard
2362 "Regexp matching interpreters, for file mode determination.
2363 This regular expression is matched against the first line of a file
2364 to determine the file's mode in `set-auto-mode'. If it matches, the file
2365 is assumed to be interpreted by the interpreter matched by the second group
2366 of the regular expression. The mode is then determined as the mode
2370 "Alist of buffer beginnings vs. corresponding major mode functions.
2371 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2372 After visiting a file, if REGEXP matches the text at the beginning of the
2373 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2374 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2375 major mode.
2377 If FUNCTION is nil, then it is not called. (That is a way of saying
2383 ;; The < comes before the groups (but the first) to reduce backtracking.
2384 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2385 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2389 comment-re "*"
2392 . html-mode)
2394 ;; These two must come after html, because they are more general:
2399 . sgml-mode)
2402 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2403 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2404 After visiting a file, if REGEXP matches the text at the beginning of the
2405 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2406 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2407 have not specified a mode for this file.
2413 "Upper limit on `magic-mode-alist' regexp matches.
2417 "Select major mode appropriate for current buffer.
2419 To find the right major mode, this function checks for a -*- mode tag,
2420 checks if it uses an interpreter listed in `interpreter-mode-alist',
2421 matches the buffer beginning against `magic-mode-alist',
2422 compares the filename against the entries in `auto-mode-alist',
2423 then matches the buffer beginning against `magic-fallback-mode-alist'.
2425 It does not check for the `mode:' local variable in the
2426 Local Variables section of the file; for that, use `hack-local-variables'.
2428 If `enable-local-variables' is nil, this function does not check for a
2429 -*- mode tag.
2431 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2432 set the major mode only if that would change it. In other words
2433 we don't actually set it to the same mode the buffer already has."
2434 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2436 ;; Find a -*- mode tag
2443 ;; Find all specifications for the `mode:' variable
2444 ;; and execute them left to right.
2456 modes)))
2457 ;; Simple -*-MODE-*- case.
2460 modes))))
2461 ;; If we found modes to use, invoke them now, outside the save-excursion.
2469 ;; continuing would call minor modes again, toggling them off
2471 ;; If we didn't, look for an interpreter specified in the first line.
2472 ;; As a special case, allow for things like "#!/bin/env perl", which
2473 ;; finds the interpreter anywhere in $PATH.
2480 ;; Map interpreter name to a mode, signalling we're done at the
2481 ;; same time.
2483 interpreter-mode-alist))
2484 ;; If we found an interpreter mode to use, invoke it now.
2487 ;; Next try matching the buffer beginning against magic-mode-alist.
2501 ;; Next compare the filename against the entries in auto-mode-alist.
2506 ;; Remove remote file name identification.
2510 ;; Remove backup-suffixes from file name.
2513 ;; Find first matching alist entry.
2516 ;; System is case-insensitive.
2520 ;; System is case-sensitive.
2522 ;; First match case-sensitively.
2526 ;; Fallback to case-insensitive match.
2540 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2555 ;; When `keep-mode-if-same' is set, we are working on behalf of
2556 ;; set-visited-file-name. In that case, if the major mode specified is the
2557 ;; same one we already have, don't actually reset it. We don't want to lose
2558 ;; minor modes such as Font Lock.
2560 "Apply MODE and return it.
2561 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2562 any aliases and compared to current major mode. If they are the
2563 same, do nothing and return nil."
2569 mode)))
2572 "Find the -*- spec in the buffer.
2573 Call with point at the place to start searching from.
2574 If one is found, set point to the beginning
2575 and return the position of the end.
2576 Otherwise, return nil; point may be changed."
2579 ;; Don't look for -*- if this file name matches any
2580 ;; of the regexps in inhibit-first-line-modes-regexps.
2588 sufs)
2596 ;; If the file begins with "#!"
2597 ;; (exec interpreter magic), look
2598 ;; for mode frobs in the first two
2599 ;; lines. You cannot necessarily
2600 ;; put them in the first line of
2601 ;; such a file without screwing up
2602 ;; the interpreter invocation.
2603 ;; The same holds for
2604 ;; '\"
2605 ;; in man pages (preprocessor
2606 ;; magic for the `man' program).
2617 end))))
2618 \f
2619 ;;; Handling file local variables
2623 file-local-variables-alist)
2627 "Normal hook run after processing a file's local variables specs.
2628 Major modes can use this to examine user-specified local variables
2632 "List variable-value pairs that are considered safe.
2633 Each element is a cons cell (VAR . VAL), where VAR is a variable
2634 symbol and VAL is a value that is considered safe."
2639 "Expressions that are considered safe in an `eval:' local variable.
2640 Add expressions to this list if you want Emacs to evaluate them, when
2641 they appear in an `eval' local variable specification, without first
2642 asking you for confirmation."
2647 ;; Risky local variables:
2650 auto-mode-alist
2651 buffer-auto-save-file-name
2652 buffer-file-name
2653 buffer-file-truename
2654 buffer-undo-list
2655 dabbrev-case-fold-search
2656 dabbrev-case-replace
2657 debugger
2658 default-text-properties
2659 display-time-string
2660 enable-local-eval
2661 enable-local-variables
2662 eval
2663 exec-directory
2664 exec-path
2665 file-name-handler-alist
2666 font-lock-defaults
2667 format-alist
2668 frame-title-format
2669 global-mode-string
2670 header-line-format
2671 icon-title-format
2672 ignored-local-variables
2673 imenu--index-alist
2674 imenu-generic-expression
2675 inhibit-quit
2676 input-method-alist
2677 load-path
2678 max-lisp-eval-depth
2679 max-specpdl-size
2680 minor-mode-alist
2681 minor-mode-map-alist
2682 minor-mode-overriding-map-alist
2683 mode-line-buffer-identification
2684 mode-line-format
2685 mode-line-client
2686 mode-line-modes
2687 mode-line-modified
2688 mode-line-mule-info
2689 mode-line-position
2690 mode-line-process
2691 mode-line-remote
2692 mode-name
2693 outline-level
2694 overriding-local-map
2695 overriding-terminal-local-map
2696 parse-time-rules
2697 process-environment
2698 rmail-output-file-alist
2699 safe-local-variable-values
2700 safe-local-eval-forms
2701 save-some-buffers-action-alist
2702 special-display-buffer-names
2703 standard-input
2704 standard-output
2705 unread-command-events
2706 vc-mode))
2708 ;; Safe local variables:
2709 ;;
2710 ;; For variables defined by major modes, the safety declarations can go into
2711 ;; the major mode's file, since that will be loaded before file variables are
2712 ;; processed.
2713 ;;
2714 ;; For variables defined by minor modes, put the safety declarations in the
2715 ;; file defining the minor mode after the defcustom/defvar using an autoload
2716 ;; cookie, e.g.:
2717 ;;
2718 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2719 ;;
2720 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2721 ;; minor mode file may not be loaded yet.
2722 ;;
2723 ;; For variables defined in the C source code the declaration should go here:
2739 "Alist of file-local variable settings in the current buffer.
2740 Each element in this list has the form (VAR . VALUE), where VAR
2741 is a file-local variable (a symbol) and VALUE is the value
2742 specified. The actual value in the buffer may differ from VALUE,
2747 "Normal hook run before setting file-local variables.
2748 It is called after checking for unsafe/risky variables and
2749 setting `file-local-variables-alist', and before applying the
2750 variables stored in `file-local-variables-alist'. A hook
2751 function is allowed to change the contents of this alist.
2753 This hook is called only if there is at least one file-local
2757 "Get confirmation before setting up local variable values.
2758 ALL-VARS is the list of all variables to be set up.
2759 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2760 RISKY-VARS is the list of those that are marked as risky.
2761 DIR-NAME is a directory name if these settings come from
2762 directory-local variables, or nil otherwise."
2764 nil
2770 prompt char)
2780 ", and variables that are risky (**)."
2787 y -- to apply the local variables list.
2791 ! -- to apply the local variables list, and permanently mark these
2803 ;; Make strings with embedded whitespace easier to read.
2811 ""
2818 done)
2827 ;; read-event returns -1 if we are in a kbd
2828 ;; macro and there are no more events in the
2829 ;; macro. In that case, attempt to get an
2830 ;; event interactively.
2838 ;; When this is called from desktop-restore-file-buffer,
2839 ;; coding-system-for-read may be non-nil. Reset it before
2840 ;; writing to .emacs.
2844 'safe-local-variable-values
2845 safe-local-variable-values))))
2852 "Return local variables specified in the -*- line.
2853 Ignore any specification for `mode:' and `coding:';
2854 `set-auto-mode' should already have handled `mode:',
2855 `set-auto-coding' should already have handled `coding:'.
2857 If MODE-ONLY is non-nil, all we do is check whether the major
2858 mode is specified, returning t if it is specified. Otherwise,
2859 return an alist of elements (VAR . VAL), where VAR is a variable
2860 and VAL is the specified value."
2864 result mode-specified)
2865 ;; Parse the -*- line into the RESULT alist.
2866 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2868 nil)
2870 ;; Simple form: "-*- MODENAME -*-". Already handled.
2872 nil)
2874 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2875 ;; (last ";" is optional).
2880 ;; There used to be a downcase here,
2881 ;; but the manual didn't say so,
2882 ;; and people want to set var names that aren't all lc.
2887 ;; It is traditional to ignore
2888 ;; case when checking for `mode' in set-auto-mode,
2889 ;; so we must do that here as well.
2890 ;; That is inconsistent, but we're stuck with it.
2891 ;; The same can be said for `coding' in set-auto-coding.
2897 'eval
2904 mode-specified
2905 result))))
2908 "Filter local variable settings, querying the user if necessary.
2909 VARIABLES is the alist of variable-value settings. This alist is
2910 filtered based on the values of `ignored-local-variables',
2911 `enable-local-eval', `enable-local-variables', and (if necessary)
2912 user interaction. The results are added to
2913 `file-local-variables-alist', without applying them.
2914 DIR-NAME is a directory name if these settings come from
2915 directory-local variables, or nil otherwise."
2916 ;; Strip any variables that are in `ignored-local-variables'.
2919 ;; If `enable-local-eval' is nil, strip eval "variables".
2924 ;; Find those variables that we may want to save to
2925 ;; `safe-local-variable-values'.
2930 ;; Don't query about the fake variables.
2941 ;; If caller wants only safe variables, store only these.
2946 ;; Query, unless all are known safe or the user wants no
2947 ;; querying.
2953 variables unsafe-vars risky-vars dir-name))
2958 "Parse and put into effect this buffer's local variables spec.
2959 If MODE-ONLY is non-nil, all we do is check whether the major mode
2960 is specified, returning t if it is specified."
2963 result)
2970 ;; Look for "Local variables:" line in last page.
2978 ;; suffix is what comes after "local variables:" in its line.
2979 ;; prefix is what comes before "local variables:" in its line.
2989 beg)
2993 endpos
2999 nil t))
3000 ;; This used to be an error, but really all it means is
3001 ;; that this may simply not be a local-variables section,
3002 ;; so just ignore it.
3012 ;; Discard the prefix.
3017 ;; Discard the suffix.
3025 ;; Find the variable name; strip whitespace.
3033 val)
3034 ;; Read the variable value.
3044 'eval
3049 ;; Now we've read all the local variables.
3050 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3052 ;; Otherwise, set the variables.
3064 "Non-nil if SYM is safe as a file-local variable with value VAL.
3065 It is safe if any of these conditions are met:
3067 * There is a matching entry (SYM . VAL) in the
3068 `safe-local-variable-values' user option.
3070 * The `safe-local-variable' property of SYM is a function that
3071 evaluates to a non-nil value with VAL as an argument."
3077 "Non-nil if SYM could be dangerous as a file-local variable.
3078 It is dangerous if either of these conditions are met:
3080 * Its `risky-local-variable' property is non-nil.
3086 ;; If this is an alias, check the base name.
3106 "Return t if it is safe to eval EXP when it is found in a file."
3108 ;; Detect certain `put' expressions.
3115 lisp-indent-function
3116 scheme-indent-function))
3117 ;; Only allow safe values (not functions).
3122 ;; Only allow indirect form specs.
3123 ;; During bootstrapping, edebug-basic-spec might not be
3124 ;; defined yet.
3128 ;; Allow expressions that the user requested.
3130 ;; Certain functions can be allowed with safe arguments
3131 ;; or can specify verification functions to try.
3139 ok))
3147 ok)))))))
3150 "Set local variable VAR with value VAL.
3151 If VAR is `mode', call `VAL-mode' as a function unless it's
3152 already the major mode."
3162 ;; Make sure the string has no text properties.
3163 ;; Some text properties can get evaluated in various ways,
3164 ;; so it is risky to put them on with a local variable list.
3168 \f
3169 ;;; Handling directory-local variables, aka project settings.
3178 "Return the variable list for CLASS."
3182 "Collect directory-local variables from MODE-VARIABLES.
3183 VARIABLES is the initial list of variables.
3184 Returns the new list."
3191 ;; Need a new cons in case we setcdr later.
3195 "Collect entries from CLASS-VARIABLES into VARIABLES.
3196 ROOT is the root directory of the project.
3197 Return the new variables list."
3205 ;; Don't include this in the previous condition, because we
3206 ;; want to filter all strings before the next condition.
3218 "Declare that the DIRECTORY root is an instance of CLASS.
3219 DIRECTORY is the name of a directory, a string.
3220 CLASS is the name of a project class, a symbol.
3222 When a file beneath DIRECTORY is visited, the mode-specific
3223 variables from CLASS will be applied to the buffer. The variables
3224 for a class are defined using `dir-locals-set-class-variables'."
3231 "Map the type CLASS to a list of variable settings.
3232 CLASS is the project class, a symbol. VARIABLES is a list
3233 that declares directory-local variables for the class.
3234 An element in VARIABLES is either of the form:
3235 (MAJOR-MODE . ALIST)
3236 or
3237 (DIRECTORY . LIST)
3239 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3240 whose elements are of the form (VARIABLE . VALUE).
3242 In the second form, DIRECTORY is a directory name (a string), and
3243 LIST is a list of the form accepted by the function.
3245 When a file is visited, the file's class is found. A directory
3246 may be assigned a class using `dir-locals-set-directory-class'.
3247 Then variables are set in the file's buffer according to the
3248 class' LIST. The list is processed in order.
3250 * If the element is of the form (MAJOR-MODE . ALIST), and the
3251 buffer's major mode is derived from MAJOR-MODE (as determined
3252 by `derived-mode-p'), then all the variables in ALIST are
3253 applied. A MAJOR-MODE of nil may be used to match any buffer.
3254 `make-local-variable' is called for each variable before it is
3255 set.
3257 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3258 is an initial substring of the file's directory, then LIST is
3259 applied by recursively following these rules."
3266 "File that contains directory-local variables.
3267 It has to be constant to enforce uniform values
3271 "Find the directory-local variables FILE.
3272 This searches upward in the directory tree.
3273 If a local variables file is found, the file name is returned.
3274 If the file is already registered, a cons from
3275 `dir-locals-directory-alist' is returned.
3276 Otherwise this returns nil."
3280 ;; `locate-dominating-file' may have abbreviated the name.
3291 locals-file
3292 dir-elt)
3296 "Load a variables FILE and register a new class and instance.
3297 FILE is the name of the file holding the variables to apply.
3298 The new class name is the same as the directory in which FILE
3299 is found. Returns the new class name."
3301 ;; We should probably store the modtime of FILE and then
3302 ;; reload it whenever it changes.
3309 class-name)))
3314 "Read per-directory local variables for the current buffer.
3315 Store the directory-local variables in `file-local-variables-alist',
3316 without applying them."
3320 ;; Find the variables file.
3338 \f
3341 However, the mode will not be changed if
3342 \(1) a local variables list or the `-*-' line specifies a major mode, or
3344 \ not suitable for ordinary files, or
3345 \(3) the new file name does not particularly specify any mode."
3350 "Change name of file visited in current buffer to FILENAME.
3351 This also renames the buffer to correspond to the new file.
3352 The next time the buffer is saved it will go in the newly specified file.
3353 FILENAME nil or an empty string means mark buffer as not visiting any file.
3354 Remember to delete the initial contents of the minibuffer
3355 if you wish to pass an empty string as the argument.
3357 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3358 confirmation in the case where another buffer is already visiting FILENAME.
3360 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3361 the old visited file has been renamed to the new name FILENAME."
3369 nil
3384 filename)))
3394 ;; If new-name == old-name, renaming would add a spurious <2>
3395 ;; and it's considered as a feature in rename-buffer.
3401 ;; Abbreviate the file names of the buffer.
3410 nil)))
3411 ;; write-file-functions is normally used for things like ftp-find-file
3412 ;; that visit things that are not local files as if they were files.
3413 ;; Changing to visit an ordinary local file instead should flush the hook.
3418 ;; If buffer was read-only because of version control,
3419 ;; that reason is gone now, so make it writable.
3423 ;; Turn off backup files for certain file names.
3424 ;; Since this is a permanent local, the major mode won't eliminate it.
3426 backup-enable-predicate
3432 ;; If auto-save was not already on, turn it on if appropriate.
3436 ;; If auto save is on, start using a new name.
3437 ;; We deliberately don't rename or delete the old auto save
3438 ;; for the old visited file name. This is because perhaps
3439 ;; the user wants to save the new state and then compare with the
3440 ;; previous state from the auto save file.
3443 ;; Rename the old auto save file if any.
3450 ;; Update the major mode, if the file name determines it.
3452 ;; Don't change the mode if it is special.
3455 ;; Don't change the mode if the local variable list specifies it.
3461 "Write current buffer into file FILENAME.
3462 This makes the buffer visit that file, and marks it as not modified.
3464 If you specify just a directory name as FILENAME, that means to use
3465 the default file name but in that directory. You can also yank
3466 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3468 If the buffer is not already visiting a file, the default file name
3469 for the output file is the buffer name.
3471 If optional second arg CONFIRM is non-nil, this function
3472 asks for confirmation before overwriting an existing file.
3473 Interactively, confirmation is required unless you supply a prefix argument."
3474 ;; (interactive "FWrite file: ")
3478 nil nil nil nil)
3482 default-directory)
3483 nil nil))
3487 ;; If arg is just a directory,
3488 ;; use the default file name, but in that directory.
3499 ;; Make buffer writable if file is writable.
3504 ;; It's likely that the VC status at the new location is different from
3505 ;; the one at the old location.
3507 \f
3509 "Make a backup of the disk file visited by the current buffer, if appropriate.
3510 This is normally done before saving the buffer the first time.
3512 A backup may be done by renaming or by copying; see documentation of
3513 variable `make-backup-files'. If it's done by renaming, then the file is
3514 no longer accessible under its old name.
3516 The value is non-nil after a backup was made by renaming.
3517 It has the form (MODES . BACKUPNAME).
3518 MODES is the result of `file-modes' on the original
3519 file; this means that the caller, after saving the buffer, should change
3520 the modes of the new file to agree with the old modes.
3521 BACKUPNAME is the backup file name, which is the old file renamed."
3528 backup-info backupname targets setmodes)
3529 ;; If specified name is a symbolic link, chase it to the target.
3530 ;; Thus we make the backups in the directory where the real file is.
3535 ;; (if (file-directory-p buffer-file-name)
3536 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3540 ;; If have old versions to maybe delete,
3541 ;; ask the user to confirm now, before doing anything.
3542 ;; But don't actually delete til later.
3547 real-file-name)))))
3549 ;; Actually write the back up file.
3552 ; (file-symlink-p buffer-file-name)
3553 backup-by-copying
3554 ;; Don't rename a suid or sgid file.
3569 ;; rename-file should delete old backup.
3573 ;; If trouble writing the backup, write it in ~.
3578 backupname)
3582 ;; Now delete the old versions, if desired.
3589 setmodes)
3596 ;; Create temp files with strict access rights. It's easy to
3597 ;; loosen them later, whereas it's impossible to close the
3598 ;; time-window of loose permissions otherwise.
3601 ;; Try to overwrite old backup first.
3609 nil)
3611 ;; The file was somehow created by someone else between
3612 ;; `delete-file' and `copy-file', so let's try again.
3613 ;; rms says "I think there is also a possible race
3614 ;; condition for making backup files" (emacs-devel 20070821).
3615 nil)))
3616 ;; Reset the umask.
3622 "Return file NAME sans backup versions or strings.
3623 This is a separate procedure so your site-init or startup file can
3624 redefine it.
3625 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3626 we do not remove backup version numbers, only true file version numbers."
3638 "Return t if deleting FILE and rewriting it would preserve the owner."
3643 ;; Return t if the file doesn't exist, since it's true that no
3644 ;; information would be lost by an (attempted) delete and create.
3650 The extension, in a file name, is the part that follows the last `.',
3651 except that a leading `.', if any, doesn't count."
3654 directory)
3658 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3659 ;; we don't want to expand it.
3662 filename))))
3666 The extension, in a file name, is the part that follows the last `.',
3667 excluding version numbers and backup suffixes,
3668 except that a leading `.', if any, doesn't count.
3669 Return nil for extensionless file names such as `foo'.
3670 Return the empty string for file names such as `foo.'.
3672 If PERIOD is non-nil, then the returned value includes the period
3673 that delimits the extension, and if FILENAME has no extension,
3684 "A function to use instead of the default `make-backup-file-name'.
3685 A value of nil gives the default `make-backup-file-name' behavior.
3687 This could be buffer-local to do something special for specific
3688 files. If you define it, you may need to change `backup-file-name-p'
3689 and `file-name-sans-versions' too.
3691 See also `backup-directory-alist'."
3697 "Alist of filename patterns and backup directory names.
3698 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3699 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3700 relative or absolute. If it is absolute, so that all matching files
3701 are backed up into the same directory, the file names in this
3702 directory will be the full name of the file backed up with all
3703 directory separators changed to `!' to prevent clashes. This will not
3704 work correctly if your filesystem truncates the resulting name.
3706 For the common case of all backups going into one directory, the alist
3708 directory name.
3710 If this variable is nil, or it fails to match a filename, the backup
3711 is made in the original file's directory.
3713 On MS-DOS filesystems without long names this variable is always
3714 ignored."
3720 "Default `backup-enable-predicate' function.
3721 Checks for files in `temporary-file-directory',
3722 `small-temporary-file-directory', and /tmp."
3725 ;; Directory is under temporary-file-directory.
3730 ;; Directory is under /tmp.
3735 0 nil
3737 ;; Directory is under small-temporary-file-directory.
3742 "Create the non-numeric backup file name for FILE.
3743 Normally this will just be the file's name with `~' appended.
3744 Customization hooks are provided as follows.
3746 If the variable `make-backup-file-name-function' is non-nil, its value
3747 should be a function which will be called with FILE as its argument;
3748 the resulting name is used.
3750 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3751 the documentation of that variable. If the directory for the backup
3752 doesn't exist, it is created."
3766 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3768 elt backup-directory abs-backup-directory)
3773 alist nil)))
3774 ;; If backup-directory is relative, it should be relative to the
3775 ;; file's directory. By expanding explicitly here, we avoid
3776 ;; depending on default-directory.
3785 abs-backup-directory nil))))
3787 file
3791 ;; Normalize DOSish file names: downcase the drive
3792 ;; letter, if any, and replace the leading "x:" with
3793 ;; "/drive_x".
3796 ;; Replace any invalid file-name characters (for the
3797 ;; case of backing up remote files).
3801 "drive_"
3804 ""
3807 ;; Make the name unique by substituting directory
3808 ;; separators. It may not really be worth bothering about
3809 ;; doubling `!'s in the original name...
3814 backup-directory))
3819 "Return non-nil if FILE is a backup file name (numeric or not).
3820 This is a separate function so you can redefine it for customization.
3821 You may need to redefine `file-name-sans-versions' as well."
3826 ;; This is used in various files.
3827 ;; The usage of backup-extract-version-start is not very clean,
3828 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3830 "Given the name of a numeric backup file, FN, return the backup number.
3831 Uses the free variable `backup-extract-version-start', whose value should be
3832 the index in the name where the version number begins."
3839 "Find a file name for a backup file FN, and suggestions for deletions.
3840 Value is a list whose car is the name for the backup file
3841 and whose cdr is a list of old versions to consider deleting now.
3842 If the value is nil, don't make a backup.
3843 Uses `backup-directory-alist' in the same way as does
3844 `make-backup-file-name'."
3846 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3850 ;; We don't support numbered backups on plain MS-DOS
3851 ;; when long file names are unavailable.
3861 possibilities deserve-versions-p versions)
3864 base-versions
3867 possibilities)
3868 #'<)
3873 kept-old-versions
3874 kept-new-versions
3881 ;; Delete nothing if there is overflow
3882 ;; in the number of versions to keep.
3888 v))))))))))
3891 "Return number of names file FILENAME has."
3894 ;; (defun file-relative-name (filename &optional directory)
3895 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3896 ;; This function returns a relative file name which is equivalent to FILENAME
3897 ;; when used with that default directory as the default.
3898 ;; If this is impossible (which can happen on MSDOS and Windows
3899 ;; when the file name and directory use different drive names)
3900 ;; then it returns FILENAME."
3901 ;; (save-match-data
3902 ;; (let ((fname (expand-file-name filename)))
3903 ;; (setq directory (file-name-as-directory
3904 ;; (expand-file-name (or directory default-directory))))
3905 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3906 ;; ;; drive names, they can't be relative, so return the absolute name.
3907 ;; (if (and (or (eq system-type 'ms-dos)
3908 ;; (eq system-type 'cygwin)
3909 ;; (eq system-type 'windows-nt))
3910 ;; (not (string-equal (substring fname 0 2)
3911 ;; (substring directory 0 2))))
3912 ;; filename
3913 ;; (let ((ancestor ".")
3914 ;; (fname-dir (file-name-as-directory fname)))
3915 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3916 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3917 ;; (setq directory (file-name-directory (substring directory 0 -1))
3918 ;; ancestor (if (equal ancestor ".")
3919 ;; ".."
3920 ;; (concat "../" ancestor))))
3921 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3922 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3923 ;; ;; We matched within FNAME's directory part.
3924 ;; ;; Add the rest of FNAME onto ANCESTOR.
3925 ;; (let ((rest (substring fname (match-end 0))))
3926 ;; (if (and (equal ancestor ".")
3927 ;; (not (equal rest "")))
3928 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3929 ;; rest
3930 ;; (concat (file-name-as-directory ancestor) rest)))
3931 ;; ;; We matched FNAME's directory equivalent.
3932 ;; ancestor))))))
3935 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3936 This function returns a relative file name which is equivalent to FILENAME
3937 when used with that default directory as the default.
3938 If FILENAME and DIRECTORY lie on different machines or on different drives
3939 on a DOS/Windows machine, it returns FILENAME in expanded form."
3943 default-directory))))
3949 ;; Test for different drives on DOS/Windows
3951 ;; Should `cygwin' really be included here? --stef
3954 ;; Test for different remote file system identification
3956 filename
3962 directory nil nil case-fold-search))
3964 directory nil nil case-fold-search))))
3967 ".."
3969 ;; Now ancestor is empty, or .., or ../.., etc.
3971 directory nil nil case-fold-search))
3972 ;; We matched within FILENAME's directory part.
3973 ;; Add the rest of FILENAME onto ANCESTOR.
3976 ;; But don't bother with ANCESTOR if it would give us `./'.
3977 rest
3979 ;; We matched FILENAME's directory equivalent.
3980 ancestor))))))
3981 \f
3983 "Save current buffer in visited file if modified.
3984 Variations are described below.
3986 By default, makes the previous version into a backup file
3987 if previously requested or if this is the first save.
3989 to become a backup when the next save is done.
3991 unconditionally makes the previous version into a backup file.
3993 to become a backup when the next save is done,
3994 and unconditionally makes the previous version into a backup file.
3996 With a numeric argument of 0, never make the previous version
3997 into a backup file.
3999 If a file's name is FOO, the names of its numbered backup versions are
4000 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4001 Numeric backups (rather than FOO~) will be made if value of
4002 `version-control' is not the atom `never' and either there are already
4003 numeric versions of the file being backed up, or `version-control' is
4004 non-nil.
4005 We don't want excessive versions piling up, so there are variables
4006 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4007 and `kept-new-versions', which tells how many newest versions to keep.
4008 Defaults are 2 old versions and 2 new.
4009 `dired-kept-versions' controls dired's clean-directory (.) command.
4010 If `delete-old-versions' is nil, system will query user
4011 before trimming versions. Otherwise it does it silently.
4013 If `vc-make-backup-files' is nil, which is the default,
4014 no backup files are made for files managed by version control.
4015 (This is because the version control system itself records previous versions.)
4017 See the subroutine `basic-save-buffer' for more information."
4030 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4031 Normally delete only if the file was written by this Emacs since
4032 the last real save, but optional arg FORCE non-nil means delete anyway."
4046 "Normal hook that is run before a buffer is saved to its file."
4052 "Normal hook that is run after a buffer is saved to its file."
4058 "If non-nil, use this coding system for saving the buffer.
4059 More precisely, use this coding system in place of the
4060 value of `buffer-file-coding-system', when saving the buffer.
4061 Calling `write-region' for any purpose other than saving the buffer
4062 will still use `buffer-file-coding-system'; this variable has no effect
4069 "Save the current buffer in its visited file, if it has been modified.
4070 The hooks `write-contents-functions' and `write-file-functions' get a chance
4071 to do the job of saving; if they do not, then the buffer is saved in
4072 the visited file in the usual way.
4073 Before and after saving the buffer, this function runs
4074 `before-save-hook' and `after-save-hook', respectively."
4077 ;; In an indirect buffer, save its base buffer instead.
4082 setmodes)
4083 ;; If buffer has no file name, ask user for one.
4090 ;; Signal an error if the user specified the name of an
4091 ;; existing directory.
4094 filename))
4096 ;; Signal an error if the specified name refers to a
4097 ;; non-existing directory.
4127 ;; Support VC version backups.
4133 ;; If a hook returned t, file is already "written".
4134 ;; Otherwise, write it the usual way now.
4136 ;; Now we have saved the current buffer. Let's make sure
4137 ;; that buffer-file-coding-system is fixed to what
4138 ;; actually used for saving by binding it locally.
4148 ;; If the auto-save file was recent before this command,
4149 ;; delete it now.
4151 ;; Support VC `implicit' locking.
4156 ;; This does the "real job" of writing a buffer into its visited file
4157 ;; and making a backup file. This is what is normally done
4158 ;; but inhibited if one of write-file-functions returns non-nil.
4159 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4168 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4182 buffer-file-name)))
4196 ;; Write temp name, then rename it.
4197 ;; This requires write access to the containing dir,
4198 ;; which is why we don't try it if we don't have that access.
4200 tempname succeed
4203 ;; Create temp files with strict access rights. It's easy to
4204 ;; loosen them later, whereas it's impossible to close the
4205 ;; time-window of loose permissions otherwise.
4210 ;; Try various temporary names.
4211 ;; This code follows the example of make-temp-file,
4212 ;; but it calls write-region in the appropriate way
4213 ;; for saving the buffer.
4219 ;; Pass in nil&nil rather than point-min&max
4220 ;; cause we're saving the whole buffer.
4221 ;; write-region-annotate-functions may use it.
4223 tempname nil realname
4225 nil)
4227 ;; The file was somehow created by someone else between
4228 ;; `make-temp-name' and `write-region', let's try again.
4229 nil)
4231 ;; Reset the umask.
4233 ;; If we failed, restore the buffer's modtime.
4236 ;; Since we have created an entirely new file,
4237 ;; make sure it gets the right permission bits set.
4241 buffer-file-name)))
4242 ;; We succeeded in writing the temp file,
4243 ;; so rename it.
4245 ;; If file not writable, see if we can make it writable
4246 ;; temporarily while we write it.
4247 ;; But no need to do so if we have just backed it up
4248 ;; (setmodes is set) because that says we're superseding.
4250 ;; Change the mode back, after writing.
4256 ;; Pass in nil&nil rather than point-min&max to indicate
4257 ;; we're saving the buffer rather than just a region.
4258 ;; write-region-annotate-functions may make us of it.
4260 buffer-file-name nil t buffer-file-truename)
4262 ;; If we get an error writing the new file, and we made
4263 ;; the backup by renaming, undo the backing-up.
4268 setmodes))
4271 "View the differences between BUFFER and its associated file.
4272 This requires the external program `diff' to be in your `exec-path'."
4286 ;; Display that message for 1 second so that user can read it
4287 ;; in the minibuffer.
4289 ;; return always nil, so that save-buffers-kill-emacs will not move
4290 ;; over to the next unsaved buffer when calling `d'.
4291 nil)
4294 `((?\C-r
4301 ;; Return nil to ask about BUF again.
4302 nil)
4314 ;; Return nil to ask about BUF again.
4315 nil)
4324 "Save some modified file-visiting buffers. Asks user about each one.
4325 You can answer `y' to save, `n' not to save, `C-r' to look at the
4326 buffer in question with `view-buffer' before deciding or `d' to
4327 view the differences using `diff-buffer-with-file'.
4329 Optional argument (the prefix) non-nil means save all with no questions.
4330 Optional second argument PRED determines which buffers are considered:
4331 If PRED is nil, all the file-visiting buffers are considered.
4332 If PRED is t, then certain non-file buffers will also be considered.
4333 If PRED is a zero-argument function, it indicates for each buffer whether
4334 to consider it or not when called with that buffer current.
4336 See `save-some-buffers-action-alist' if you want to
4337 change the additional actions you can take on files."
4341 files-done abbrevs-done)
4343 ;; First save any buffers that we're supposed to save unconditionally.
4344 ;; That way the following code won't ask about them.
4349 ;; Ask about those buffers that merit it,
4350 ;; and record the number thus saved.
4354 ;; Note that killing some buffers may kill others via
4355 ;; hooks (e.g. Rmail and its viewing buffer).
4368 t
4380 save-some-buffers-action-alist))
4381 ;; Maybe to save abbrevs, and record whether
4382 ;; we either saved them or asked to.
4388 abbrev-file-name)))
4390 ;; Don't keep bothering user if he says no.
4395 "(Some special files were saved without asking)"
4397 \f
4399 "Mark current buffer as unmodified, not needing to be saved.
4402 It is not a good idea to use this function in Lisp programs, because it
4403 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4410 "Change whether this buffer is read-only.
4411 With prefix argument ARG, make the buffer read-only if ARG is
4412 positive, otherwise make it writable. If buffer is read-only
4413 and `view-read-only' is non-nil, enter view mode."
4418 nil ; do nothing.
4419 ;; Toggle.
4426 ;; If view-mode is already active, `view-mode-enter' is a nop.
4438 "Insert contents of file FILENAME into buffer after point.
4439 Set mark after the inserted text.
4441 This function is meant for the user to run interactively.
4442 Don't call it from programs! Use `insert-file-contents' instead.
4443 \(Its calling sequence is different; see its documentation)."
4448 "Append the contents of the region to the end of file FILENAME.
4449 When called from a function, expects three arguments,
4450 START, END and FILENAME. START and END are buffer positions
4451 saying what text to write."
4456 "Return most recent backup file for FILENAME or nil if no backups exist."
4457 ;; `make-backup-file-name' will get us the right directory for
4458 ;; ordinary or numeric backups. It might create a directory for
4459 ;; backups as a side-effect, according to `backup-directory-alist'.
4466 tem)
4475 newest))
4478 "Rename current buffer to a similar name not already taken.
4479 This function is useful for creating multiple shell process buffers
4480 or multiple mail buffers, etc."
4488 ;; If the existing buffer name has a <NNN>,
4489 ;; which isn't part of the file name (if any),
4490 ;; then get rid of that.
4496 "Create the directory DIR and any nonexistent parent dirs.
4497 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4499 Interactively, the default choice of directory to create
4500 is the current default directory for file names.
4501 That is useful when you have visited a file in a nonexistent directory.
4503 Noninteractively, the second (optional) argument PARENTS says whether
4504 to create parent directories if they don't exist. Interactively,
4505 this happens by default."
4508 nil nil)
4509 t))
4510 ;; If default-directory is a remote directory,
4511 ;; make sure we find its make-directory handler.
4519 create-list)
4526 \f
4529 "Function to use to revert this buffer, or nil to do the default.
4530 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4535 "Function to use to insert contents when reverting this buffer.
4536 Gets two args, first the nominal file name to use,
4537 and second, t if reading the auto-save file.
4542 "Function to check whether a non-file buffer needs reverting.
4543 This should be a function with one optional argument NOCONFIRM.
4544 Auto Revert Mode passes t for NOCONFIRM. The function should return
4545 non-nil if the buffer should be reverted. A return value of
4546 `fast' means that the need for reverting was not checked, but
4547 that reverting the buffer is fast. The buffer is current when
4548 this function is called.
4550 The idea behind the NOCONFIRM argument is that it should be
4551 non-nil if the buffer is going to be reverted without asking the
4552 user. In such situations, one has to be careful with potentially
4553 time consuming operations.
4555 For more information on how this variable is used by Auto Revert mode,
4559 "Normal hook for `revert-buffer' to run before reverting.
4560 If `revert-buffer-function' is used to override the normal revert
4564 "Normal hook for `revert-buffer' to run after reverting.
4565 Note that the hook value that it runs is the value that was in effect
4566 before reverting; that makes a difference if you have buffer-local
4567 hook functions.
4569 If `revert-buffer-function' is used to override the normal revert
4575 "Replace current buffer text with the text of the visited file on disk.
4576 This undoes all changes since the file was visited or saved.
4577 With a prefix argument, offer to revert from latest auto-save file, if
4578 that is more recent than the visited file.
4580 This command also implements an interface for special buffers
4581 that contain text which doesn't come from a file, but reflects
4582 some other data instead (e.g. Dired buffers, `buffer-list'
4583 buffers). This is done via the variable `revert-buffer-function'.
4584 In these cases, it should reconstruct the buffer contents from the
4585 appropriate data.
4587 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4588 to revert from the auto-save file when this is nil. Note that the
4589 sense of this argument is the reverse of the prefix argument, for the
4590 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4591 to nil.
4593 Optional second argument NOCONFIRM means don't ask for confirmation
4594 at all. \(The variable `revert-without-query' offers another way to
4595 revert buffers without querying for confirmation.)
4597 Optional third argument PRESERVE-MODES non-nil means don't alter
4598 the files modes. Normally we reinitialize them using `normal-mode'.
4600 If the value of `revert-buffer-function' is non-nil, it is called to
4601 do all the work for this command. Otherwise, the hooks
4602 `before-revert-hook' and `after-revert-hook' are run at the beginning
4603 and the end, and if `revert-buffer-insert-file-contents-function' is
4604 non-nil, it is called instead of rereading visited file contents."
4606 ;; I admit it's odd to reverse the sense of the prefix argument, but
4607 ;; there is a lot of code out there which assumes that the first
4608 ;; argument should be t to avoid consulting the auto-save file, and
4609 ;; there's no straightforward way to encourage authors to notice a
4610 ;; reversal of the argument sense. So I'm just changing the user
4611 ;; interface, but leaving the programmatic interface the same.
4619 buffer-auto-save-file-name
4624 buffer-auto-save-file-name
4625 buffer-file-name)))
4635 file-name)))
4637 ;; If file was backed up but has changed since,
4638 ;; we shd make another backup.
4642 ;; Effectively copy the after-revert-hook status,
4643 ;; since after-find-file will clobber it.
4646 after-revert-hook))
4651 ;; Get rid of all undo records for this buffer.
4653 ;; Don't make undo records for the reversion.
4656 file-name auto-save-p)))
4659 "File %s no longer exists!"
4661 file-name))
4664 "File %s no longer readable!"
4666 file-name))
4668 ;; Bind buffer-file-name to nil
4669 ;; so that we don't try to lock the file.
4675 ;; Auto-saved file should be read by Emacs'
4676 ;; internal coding.
4679 buffer-file-coding-system-explicit))))
4681 coding-system-for-read
4683 coding-system-for-read)
4685 ;; As a coding system suitable for multibyte
4686 ;; buffer is specified, make the current
4687 ;; buffer multibyte.
4690 ;; This force after-insert-file-set-coding
4691 ;; (called from insert-file-contents) to set
4692 ;; buffer-file-coding-system to a proper value.
4695 ;; Note that this preserves point in an intelligent way.
4699 nil nil t))
4701 nil nil t)))))
4702 ;; Recompute the truename in case changes in symlinks
4703 ;; have changed the truename.
4707 ;; Run after-revert-hook as it was before we reverted.
4711 local-hook)
4714 t))))))
4717 "Recover the visited file--get contents from its last auto-save file."
4722 "Visit file FILE, but get contents from its last auto-save file."
4723 ;; Actually putting the file name in the minibuffer should be used
4724 ;; only rarely.
4725 ;; Not just because users often use the default.
4745 ;; Use insert-directory-safely, not insert-directory,
4746 ;; because these files might not exist. In particular,
4747 ;; FILE might not exist if the auto-save file was for
4748 ;; a buffer that didn't visit a file, such as "*mail*".
4749 ;; The code in v20.x called `ls' directly, so we need
4750 ;; to emulate what `ls' did in that case.
4756 ;; Keep the current buffer-file-coding-system.
4758 ;; Auto-saved file should be read with special coding.
4767 "Recover auto save files from a previous Emacs session.
4768 This command first displays a Dired buffer showing you the
4769 previous sessions that you could recover from.
4770 To choose one, move point to the proper line and then type C-c C-c.
4771 Then you'll be asked about a number of files to recover."
4781 auto-save-list-file-prefix)))
4782 t)
4791 ;; Each line starts with a space
4792 ;; so that Font Lock mode won't highlight the first character.
4801 "Choose one saved session to recover auto-save files from.
4802 This command is used in the special Dired buffer created by
4805 ;; Get the name of the session file to recover from.
4807 files
4813 ;; Read in the auto-save-list file.
4817 ;; Loop thru the text of that file
4818 ;; and get out the names of the files to recover.
4822 ;; This is a pair of lines for a non-file-visiting buffer.
4823 ;; Get the auto-save file name and manufacture
4824 ;; a "visited file name" from that.
4827 ;; If there is no auto-save file name, the
4828 ;; auto-save-list file is probably corrupted.
4841 ;; This pair of lines is a file-visiting
4842 ;; buffer. Use the visited file name.
4852 ;; Ignore a file if its auto-save file does not exist now.
4856 ;; The file contains a pair of line for each auto-saved buffer.
4857 ;; The first line of the pair contains the visited file name
4858 ;; or is empty if the buffer was not visiting a file.
4859 ;; The second line is the auto-save file name.
4867 files
4873 "Kill BUFFER if confirmed."
4881 "Kill some buffers. Asks the user whether to kill each one of them.
4882 Non-interactively, if optional argument LIST is non-nil, it
4883 specifies the list of buffers to kill, asking for approval for each one."
4891 ; if we killed the base buffer.
4898 "Kill buffers whose name matches the specified REGEXP.
4899 The optional second argument indicates whether to kill internal buffers too."
4908 \f
4910 "Toggle auto-saving of contents of current buffer.
4911 With prefix argument ARG, turn auto-saving on if positive, else off."
4916 ;; If auto-save is off because buffer has shrunk,
4917 ;; then toggling should turn it on.
4922 buffer-file-name
4924 ;; If -1 was stored here, to temporarily turn off saving,
4925 ;; turn it back on.
4931 buffer-auto-save-file-name)
4934 "Adjust current buffer's auto save file name for current conditions.
4935 Also rename any existing auto save file, if it was made in this session."
4947 "Return file name to use for auto-saves of current buffer.
4948 Does not consider `auto-save-visited-file-name' as that variable is checked
4949 before calling this function. You can redefine this for customization.
4950 See also `auto-save-file-name-p'."
4958 result uniq)
4959 ;; Apply user-specified translations
4960 ;; to the file name.
4964 filename)
4974 filename))))
4979 ;; We truncate the file name to DOS 8+3 limits
4980 ;; before doing anything else, because the regexp
4981 ;; passed to string-match below cannot handle
4982 ;; extensions longer than 3 characters, multiple
4983 ;; dots, and other atrocities.
4988 fn)
4993 "#"
4996 ;; Make sure auto-save file names don't contain characters
4997 ;; invalid for the underlying filesystem.
4999 ;; Don't modify remote (ange-ftp) filenames
5002 result))))
5004 ;; Deal with buffers that don't have any associated files. (Mail
5005 ;; mode tends to create a good number of these.)
5009 file-name)
5010 ;; Restrict the characters used in the file name to those which
5011 ;; are known to be safe on all filesystems, url-encoding the
5012 ;; rest.
5013 ;; We do this on all platforms, because even if we are not
5014 ;; running on DOS/Windows, the current directory may be on a
5015 ;; mounted VFAT filesystem, such as a USB memory stick.
5019 ;; For multibyte characters, this will produce more than
5020 ;; 2 hex digits, so is not true URL encoding.
5024 ;; Generate the file name.
5030 ;; Try a few alternative directories, to get one we can
5031 ;; write it.
5037 ;; Don't modify remote (ange-ftp) filenames
5039 ;; The call to convert-standard-filename is in case
5040 ;; buffer-name includes characters not allowed by the
5041 ;; DOS/Windows filesystems. make-temp-file writes to the
5042 ;; file it creates, so we must fix the file name _before_
5043 ;; make-temp-file is called.
5045 fname))
5047 ;; make-temp-file creates the file,
5048 ;; but we don't want it to exist until we do an auto-save.
5052 file-name)))
5055 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5056 FILENAME should lack slashes. You can redefine this for customization."
5058 \f
5060 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5061 The generated regexp will match a filename only if the filename
5062 matches that wildcard according to shell rules. Only wildcards known
5063 by `sh' are supported."
5065 ;; Copy the initial run of non-special characters.
5068 ;; If no special characters, we're almost done.
5072 j)
5074 result
5095 ;; Found "[^". Insert a `\0' character
5096 ;; (which cannot happen in a filename)
5097 ;; into the character class, so that `^'
5098 ;; is not the first character after `[',
5099 ;; and thus non-special in a regexp.
5104 ;; I don't think `]' can appear in a
5105 ;; character class in a wildcard, but
5106 ;; let's be general here.
5113 i
5126 ;; Shell wildcards should match the entire filename,
5127 ;; not its part. Make the regexp say so.
5129 \f
5131 "-CF"
5132 "Switches for `list-directory' to pass to `ls' for brief listing."
5137 "-l"
5138 "Switches for `list-directory' to pass to `ls' for verbose listing."
5143 "Expand wildcard pattern PATTERN.
5144 This returns a list of file names which match the pattern.
5146 If PATTERN is written as an absolute file name,
5147 the values are absolute also.
5149 If PATTERN is written as a relative file name, it is interpreted
5150 relative to the current default directory, `default-directory'.
5151 The file names returned are normally also relative to the current
5152 default directory. However, if FULL is non-nil, they are absolute."
5156 ;; A list of all dirs that DIRPART specifies.
5157 ;; This can be more than one dir
5158 ;; if DIRPART contains wildcards.
5163 contents)
5168 ;; Filter out "." and ".."
5173 name))
5180 this-dir-contents)
5181 this-dir-contents)
5182 contents))))
5184 contents)))
5187 "Display a list of files in or matching DIRNAME, a la `ls'.
5188 DIRNAME is globbed by the shell if necessary.
5189 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5190 Actions controlled by variables `list-directory-brief-switches'
5191 and `list-directory-verbose-switches'."
5195 nil default-directory nil)
5196 pfx)))
5198 list-directory-brief-switches))
5199 buffer)
5212 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5220 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5222 PATTERN is assumed to represent a file-name wildcard suitable for the
5223 underlying filesystem. For Unix and GNU/Linux, the characters from the
5225 the parts of the pattern which don't include wildcard characters are
5226 quoted with double quotes.
5227 Existing quote characters in PATTERN are left alone, so you can pass
5228 PATTERN that already quotes some of the special characters."
5232 ;; DOS/Windows don't allow `"' in file names. So if the
5233 ;; argument has quotes, we can safely assume it is already
5234 ;; quoted by the caller.
5236 ;; We quote [&()#$'] in case their shell is a port of a
5237 ;; Unixy shell. We quote [,=+] because stock DOS and
5238 ;; Windows shells require that in some cases, such as
5239 ;; passing arguments to batch files that use positional
5240 ;; arguments like %1.
5242 pattern
5245 end)
5262 pattern))))
5269 "Program to get the amount of free space on a file system.
5270 We assume the output has the format of `df'.
5271 The value of this variable must be just a command name or file name;
5272 if you want to specify options, use `directory-free-space-args'.
5274 A value of nil disables this feature.
5276 If the function `file-system-info' is defined, it is always used in
5277 preference to the program given by this variable."
5283 "Options to use when running `directory-free-space-program'."
5288 "Return the amount of free space on directory DIR's file system.
5289 The result is a string that gives the number of free 1KB blocks,
5290 or nil if the system call or the program which retrieve the information
5291 fail. It returns also nil when DIR is a remote directory.
5293 This function calls `file-system-info' if it is available, or invokes the
5294 program specified by `directory-free-space-program' if that is non-nil."
5296 ;; Try to find the number of free blocks. Non-Posix systems don't
5297 ;; always have df, but might have an equivalent system call.
5306 nil t nil
5307 directory-free-space-args
5308 dir)))
5309 ;; Usual format is a header line followed by a line of
5310 ;; numbers.
5315 ;; Move to the end of the "available blocks" number.
5318 ;; Copy it into AVAILABLE.
5323 ;; The following expression replaces `dired-move-to-filename-regexp'.
5327 ;; In some locales, month abbreviations are as short as 2 letters,
5328 ;; and they can be followed by ".".
5329 ;; In Breton, a month name can include a quote character.
5342 s "+"
5345 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5346 ;; omits the Kanji characters after month and day-of-month.
5347 ;; On Mac OS X 10.3, the date format in East Asian locales is
5348 ;; day-of-month digits followed by month digits.
5354 ;; The "[0-9]" below requires the previous column to end in a digit.
5355 ;; This avoids recognizing `1 may 1997' as a date in the line:
5356 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5358 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5359 ;; The ".*" below finds the last match if there are multiple matches.
5360 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5361 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5363 ;; vc dired listings provide the state or blanks between file
5364 ;; permissions and date. The state is always surrounded by
5365 ;; parantheses:
5366 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5367 ;; This is not supported yet.
5371 "Regular expression to match up to the file name in a directory listing.
5372 The default value is designed to recognize dates and times
5377 ;; insert-directory
5378 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5379 ;; FULL-DIRECTORY-P is nil.
5380 ;; The single line of output must display FILE's name as it was
5381 ;; given, namely, an absolute path name.
5382 ;; - must insert exactly one line for each file if WILDCARD or
5383 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5384 ;; before the file lines, plus optional text after the file lines.
5385 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5386 ;; allowed.
5387 ;; File lines should display the basename.
5388 ;; - must be consistent with
5389 ;; - functions dired-move-to-filename, (these two define what a file line is)
5390 ;; dired-move-to-end-of-filename,
5391 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5392 ;; dired-insert-headerline
5393 ;; dired-after-subdir-garbage (defines what a "total" line is)
5394 ;; - variable dired-subdir-regexp
5395 ;; - may be passed "--dired" as the first argument in SWITCHES.
5396 ;; Filename handlers might have to remove this switch if their
5397 ;; "ls" command does not support it.
5399 "Insert directory listing for FILE, formatted according to SWITCHES.
5400 Leaves point after the inserted text.
5401 SWITCHES may be a string of options, or a list of strings
5402 representing individual options.
5403 Optional third arg WILDCARD means treat FILE as shell wildcard.
5404 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5405 switches do not contain `d', so that a full listing is expected.
5407 This works by running a directory listing program
5408 whose name is in the variable `insert-directory-program'.
5409 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5411 When SWITCHES contains the long `--dired' option, this function
5412 treats it specially, for the sake of dired. However, the
5413 normally equivalent short `-D' option is just passed on to
5414 `insert-directory-program', as any other option."
5415 ;; We need the directory in order to find the right handler.
5420 wildcard full-directory-p)
5423 ;; Read the actual directory using `insert-directory-program'.
5424 ;; RESULT gets the status code.
5426 ;; putting text property `dired-filename, decode one
5427 ;; bunch by one to preserve that property.
5429 ;; This is to control encoding the arguments in call-process.
5433 default-file-name-coding-system))))
5436 ;; Run ls in the directory part of the file pattern
5437 ;; using the last component as argument.
5444 shell-file-name nil t nil
5445 "-c"
5447 ""
5449 insert-directory-program
5450 " -d "
5452 switches
5454 " -- "
5455 ;; Quote some characters that have
5456 ;; special meanings in shells; but
5457 ;; don't quote the wildcards--we want
5458 ;; them to be special. We also
5459 ;; currently don't quote the quoting
5460 ;; characters in case people want to
5461 ;; use them explicitly to quote
5462 ;; wildcard characters.
5464 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5465 ;; directory if FILE is a symbolic link.
5467 insert-directory-program nil t nil
5471 ;; Split the switches at any spaces so we can
5472 ;; pass separate options as separate args.
5474 ;; Avoid lossage if FILE starts with `-'.
5482 file))))))))
5484 ;; If we got "//DIRED//" in the output, it means we got a real
5485 ;; directory listing, even if `ls' returned nonzero.
5486 ;; So ignore any errors.
5499 ;; The first time ls returns an error,
5500 ;; find the version numbers of ls,
5501 ;; and set insert-directory-ls-version
5502 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5503 ;; is equal or if the info cannot be obtained.
5504 ;; (That can mean it isn't GNU ls.)
5514 comparison)
5530 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5534 ;; If `insert-directory-program' failed, signal an error.
5536 ;; Delete the error message it may have output.
5538 ;; On non-Posix systems, we cannot open a directory, so
5539 ;; don't even try, because that will always result in
5540 ;; the ubiquitous "Access denied". Instead, show the
5541 ;; command line so the user can try to guess what went wrong.
5546 insert-directory-program
5548 file result)
5549 ;; Unix. Access the file to get a suitable error.
5556 ;; The following overshoots by one line for an empty
5557 ;; directory listed with "--dired", but without "-a"
5558 ;; switch, where the ls output contains a
5559 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5560 ;; We take care of that case later.
5568 error-lines)
5569 ;; Find all the lines that are error messages,
5570 ;; and record the bounds of each one.
5577 ;; Now read the numeric positions of file names.
5584 error-lines))
5587 error-lines)))
5589 ;; End is followed by \n or by " -> ".
5591 ;; It seems that we can't trust ls's output as to
5592 ;; byte positions of filenames.
5598 ;; Take care of the case where the ls output contains a
5599 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5600 ;; and we went one line too far back (see above).
5605 ;; Now decode what read if necessary.
5607 file-name-coding-system
5608 default-file-name-coding-system
5610 coding-no-eol
5611 val pos)
5615 ;; If no coding system is specified or detection is
5616 ;; requested, detect the coding.
5630 ;; Force no eol conversion on a file name, so
5631 ;; that CR is preserved.
5639 ;; Try to insert the amount of free space.
5642 ;; First find the line to put it on.
5646 ;; Replace "total" with "used", to avoid confusion.
5652 "Convert `ls --dired' file name position value POS to a buffer position.
5653 File name position values returned in ls --dired output
5654 count only stdout; they don't count the error messages sent to stderr.
5655 So this function converts to them to real buffer positions.
5656 ERROR-LINES is a list of buffer positions of error message lines,
5657 of the form (START END)."
5661 pos)
5665 "Insert directory listing for FILE, formatted according to SWITCHES.
5667 Like `insert-directory', but if FILE does not exist, it inserts a
5668 message to that effect instead of signaling an error."
5671 ;; Simulate the message printed by `ls'.
5675 "Functions to call with no arguments to query about killing Emacs.
5676 If any of these functions returns nil, killing Emacs is cancelled.
5677 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5681 "How to ask for confirmation when leaving Emacs.
5682 If nil, the default, don't ask at all. If the value is non-nil, it should
5683 be a predicate function such as `yes-or-no-p'."
5691 "Offer to save each buffer, then kill this Emacs process.
5692 With prefix ARG, silently save all file-visiting buffers, then kill."
5701 ;; process-list is not defined on MSDOS.
5703 active)
5712 ;; Query the user for other things, perhaps.
5719 "Offer to save each buffer, then kill the current connection.
5720 If the current frame has no client, kill Emacs itself.
5722 With prefix ARG, silently save all file-visiting buffers, then kill.
5724 If emacsclient was started with a list of filenames to edit, then
5725 only these files will be asked to be saved."
5733 \f
5734 ;; We use /: as a prefix to "quote" a file name
5735 ;; so that magic file name handlers will not apply to it.
5739 file-name-handler-alist))
5741 ;; We depend on being the last handler on the list,
5742 ;; so that anything else which does need handling
5743 ;; has been handled already.
5744 ;; So it is safe for us to inhibit *all* magic file name handlers.
5753 default-directory))
5754 ;; Get a list of the indices of the args which are file names.
5757 ;; The first six are special because they
5758 ;; return a file name. We want to include the /:
5759 ;; in the return value.
5760 ;; So just avoid stripping it in the first place.
5767 ;; `identity' means just return the first arg
5768 ;; not stripped of its quoting.
5770 ;; `add' means add "/:" to the result.
5772 ;; `quote' means add "/:" to buffer-file-name.
5774 ;; `unquote-then-quote' means set buffer-file-name
5775 ;; temporarily to unquoted filename.
5777 ;; List the arguments which are filenames.
5785 ;; For all other operations, treat the first argument only
5786 ;; as the file name.
5788 method
5789 ;; Copy ARGUMENTS so we can replace elements in it.
5793 ;; Strip off the /: from the file names that have it.
5801 "/"
5817 res))
5820 \f
5821 ;; Symbolic modes and read-file-modes.
5824 "Convert CHAR to a numeric bit-mask for extracting mode bits.
5825 CHAR is in [ugoa] and represents the category of users (Owner, Group,
5826 Others, or All) for whom to produce the mask.
5827 The bit-mask that is returned extracts from mode bits the access rights
5828 for the specified category of users."
5836 "Convert CHAR to a numeric value of mode bits.
5837 CHAR is in [rwxXstugo] and represents symbolic access permissions.
5838 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
5845 ;; Rights relative to the previous file modes.
5856 "Convert a symbolic mode string specification to an equivalent number.
5858 WHO-MASK is the bit-mask specifying the category of users to which to
5859 apply the access permissions. See `file-modes-char-to-who'.
5860 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5861 RIGHTS request to add, remove, or set permissions based on existing ones,
5868 char-right)
5875 num-rights
5879 op char-right)))
5880 num-rights))
5883 "Convert symbolic file modes to numeric file modes.
5884 MODES is the string to convert, it should match
5887 notation.
5888 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5889 MODES request to add, remove, or set permissions based on existing ones,
5903 num-who num-modes)
5906 num-modes)))
5909 "Read file modes in octal or symbolic notation and return its numeric value.
5910 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5911 ORIG-FILE is the name of a file on whose mode bits to base returned
5912 permissions if what user types requests to add, remove, or set permissions
5928 nil nil default)))
5934 \f
5935 ;; Trashcan handling.
5937 "Directory for `move-file-to-trash' to move files and directories to.
5938 This directory is only used when the function `system-move-file-to-trash' is
5939 not defined. Relative paths are interpreted relative to `default-directory'.
5940 See also `delete-by-moving-to-trash'."
5948 "Move file (or directory) name FILENAME to the trash.
5949 This function is called by `delete-file' and `delete-directory' when
5950 `delete-by-moving-to-trash' is non-nil. On platforms that define
5951 `system-move-file-to-trash', that function is used to move FILENAME to the
5952 system trash, otherwise FILENAME is moved to `trash-directory'.
5953 Returns nil on success."
5966 ;; make new-fn unique.
5967 ;; example: "~/.Trash/abc.txt" -> "~/.Trash/abc.txt.~1~"
5970 ;; stop processing if fn is same or parent directory of trash-dir.
5973 filename))
5977 \f
6002 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6003 ;;; files.el ends here