| blob | 4983e0f4a7d72a9c5a47d1d0c27ae5f7f6944283 |
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.)
233 "Non-nil means protect against I/O errors while saving files.
234 Some modes set this non-nil in particular buffers.
236 This feature works by writing the new contents into a temporary file
237 and then renaming the temporary file to replace the original.
238 In this way, any I/O error in writing leaves the original untouched,
239 and there is never any instant where the file is nonexistent.
241 Note that this feature forces backups to be made by copying.
242 Yet, at the same time, saving a precious file
243 breaks any hard links between it and other files.
245 This feature is advisory: for example, if the directory in which the
246 file is being saved is not writable, Emacs may ignore a non-nil value
247 of `file-precious-flag' and write directly into the file.
249 See also: `break-hardlink-on-save'."
254 "Non-nil means when saving a file that exists under several names
255 \(i.e., has multiple hardlinks), break the hardlink associated with
256 `buffer-file-name' and write to a new file, so that the other
257 instances of the file are not affected by the save.
259 If `buffer-file-name' refers to a symlink, do not break the symlink.
261 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
262 For example, if the directory in which a file is being saved is not
263 itself writable, then error instead of saving in some
264 hardlink-nonbreaking way.
266 See also `backup-by-copying' and `backup-by-copying-when-linked'."
272 "Control use of version numbers for backup files.
273 When t, make numeric backup versions unconditionally.
274 When nil, make them for files that have some already.
275 The value `never' means do not make them."
285 "When cleaning directory, number of versions to keep."
291 "If t, delete excess backup versions silently.
292 If nil, ask confirmation. Any other value prevents any trimming."
299 "Number of oldest versions to keep when a new numbered backup is made."
305 "Number of newest versions to keep when a new numbered backup is made.
306 Includes the new backup. Must be > 0"
312 "Whether to add a newline automatically at the end of the file.
314 A value of t means do this only when the file is about to be saved.
315 A value of `visit' means do this right after the file is visited.
316 A value of `visit-save' means do it at both of those times.
317 Any other non-nil value means ask user whether to add a newline, when saving.
318 A value of nil means don't add newlines.
320 Certain major modes set this locally to the value obtained
321 from `mode-require-final-newline'."
330 "Whether to add a newline at end of file, in certain major modes.
331 Those modes set `require-final-newline' to this value when you enable them.
332 They do so because they are often used for files that are supposed
333 to end in newlines, and the question is how to arrange that.
335 A value of t means do this only when the file is about to be saved.
336 A value of `visit' means do this right after the file is visited.
337 A value of `visit-save' means do it at both of those times.
338 Any other non-nil value means ask user whether to add a newline, when saving.
340 A value of nil means do not add newlines. That is a risky choice in this
341 variable since this value is used for modes for files that ought to have
342 final newlines. So if you set this to nil, you must explicitly check and
343 add a final newline, whenever you save a file that really needs one."
353 "Non-nil says by default do auto-saving of every file-visiting buffer."
359 ;; Don't put "\\2" inside expand-file-name, since it will be
360 ;; transformed to "/2" on DOS/Windows.
362 "Transforms to apply to buffer file name before making auto-save file name.
363 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
364 REGEXP is a regular expression to match against the file name.
365 If it matches, `replace-match' is used to replace the
366 matching part with REPLACEMENT.
367 If the optional element UNIQUIFY is non-nil, the auto-save file name is
368 constructed by taking the directory part of the replaced file-name,
369 concatenated with the buffer file name with all directory separators
370 changed to `!' to prevent clashes. This will not work
371 correctly if your filesystem truncates the resulting name.
373 All the transforms in the list are tried, in the order they are listed.
374 When one transform applies, its result is final;
375 no further transforms are tried.
377 The default value is set up to put the auto-save file into the
378 temporary directory (see the variable `temporary-file-directory') for
379 editing a remote file.
381 On MS-DOS filesystems without long names this variable is always
382 ignored."
389 "Non-nil means save word abbrevs too when files are saved.
390 If `silently', don't ask the user before saving."
395 "Non-nil means allow `find-file' to visit directories.
396 To visit the directory, `find-file' runs `find-directory-functions'."
401 "List of functions to try in sequence to visit a directory.
402 Each function is called with the directory name as the sole argument
403 and should return either a buffer or nil."
407 ;;;It is not useful to make this a local variable.
408 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
410 "List of functions to be called for `find-file' on nonexistent file.
411 These functions are called as soon as the error is detected.
412 Variable `buffer-file-name' is already set up.
417 ;;;It is not useful to make this a local variable.
418 ;;;(put 'find-file-hooks 'permanent-local t)
421 "List of functions to be called after a buffer is loaded from a file.
422 The buffer's local variables (if any) will have been processed before the
423 functions are called."
430 "List of functions to be called before writing out a buffer to a file.
431 If one of them returns non-nil, the file is considered already written
432 and the rest are not called.
433 These hooks are considered to pertain to the visited file.
434 So any buffer-local binding of this variable is discarded if you change
436 change the major mode.
438 This hook is not run if any of the functions in
439 `write-contents-functions' returns non-nil. Both hooks pertain
440 to how to save a buffer to file, for instance, choosing a suitable
441 coding system and setting mode bits. (See Info
442 node `(elisp)Saving Buffers'.) To perform various checks or
453 "List of functions to be called before writing out a buffer to a file.
454 If one of them returns non-nil, the file is considered already written
455 and the rest are not called and neither are the functions in
456 `write-file-functions'.
458 This variable is meant to be used for hooks that pertain to the
459 buffer's contents, not to the particular visited file; thus,
460 `set-visited-file-name' does not clear this variable; but changing the
461 major mode does clear it.
463 For hooks that _do_ pertain to the particular visited file, use
464 `write-file-functions'. Both this variable and
465 `write-file-functions' relate to how a buffer is saved to file.
466 To perform various checks or updates before the buffer is saved,
473 "Control use of local variables in files you visit.
474 The value can be t, nil, :safe, :all, or something else.
476 A value of t means file local variables specifications are obeyed
477 if all the specified variable values are safe; if any values are
478 not safe, Emacs queries you, once, whether to set them all.
479 \(When you say yes to certain values, they are remembered as safe.)
481 :safe means set the safe variables, and ignore the rest.
482 :all means set all variables, whether safe or not.
483 (Don't set it permanently to :all.)
484 A value of nil means always ignore the file local variables.
486 Any other value means always query you once whether to set them all.
487 \(When you say yes to certain values, they are remembered as safe, but
490 This variable also controls use of major modes specified in
491 a -*- line.
494 always obeys file local variable specifications and the -*- line,
495 and ignores this variable."
504 "Like `enable-local-variables' but meant for buffer-local bindings.
505 The meaningful values are nil and non-nil. The default is non-nil.
506 If a major mode sets this to nil, buffer-locally, then any local
507 variables list in the file will be ignored.
509 This variable does not affect the use of major modes
514 The value can be t, nil or something else.
515 A value of t means obey `eval' variables.
516 A value of nil means ignore them; anything else means query."
522 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
531 "Non-nil means buffers visiting files read-only do so in view mode.
532 In fact, this means that all read-only buffers normally have
533 View mode enabled, including buffers that are read-only because
534 you visit a file you cannot alter, and buffers you make read-only
540 "History list of file names entered in the minibuffer.
542 Maximum length of the history list is determined by the value
544 \f
547 "Provides support for ange-ftp host name completion.
548 Runs the usual ange-ftp hook, but only for completion operations."
549 ;; Having this here avoids the need to load ange-ftp when it's not
550 ;; really in use.
556 inhibit-file-name-handlers)))
561 "Convert a standard file's name to something suitable for the OS.
562 This means to guarantee valid names and perhaps to canonicalize
563 certain patterns.
565 FILENAME should be an absolute file name since the conversion rules
566 sometimes vary depending on the position in the file name. E.g. c:/foo
567 is a valid DOS file name, but c:/bar/c:/foo is not.
569 This function's standard definition is trivial; it just returns
570 the argument. However, on Windows and DOS, replace invalid
571 characters. On DOS, make sure to obey the 8.3 limitations.
572 In the native Windows build, turn Cygwin names into native names,
573 and also turn slashes into backslashes if the shell requires it (see
574 `w32-shell-dos-semantics').
576 See Info node `(elisp)Standard File Names' for more details."
580 ;; Replace invalid filename characters with !
584 name)
585 filename))
588 "Read directory name, prompting with PROMPT and completing in directory DIR.
589 Value is not expanded---you must call `expand-file-name' yourself.
590 Default name to DEFAULT-DIRNAME if user exits with the same
591 non-empty string that was inserted by this function.
592 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
593 or just DIR if INITIAL is nil.)
594 If the user exits with an empty minibuffer, this function returns
595 an empty string. (This can only happen if the user erased the
596 pre-inserted contents or if `insert-default-directory' is nil.)
597 Fourth arg MUSTMATCH non-nil means require existing directory's name.
598 Non-nil and non-t means also require confirmation after completion.
599 Fifth arg INITIAL specifies text to start with.
600 DIR should be an absolute directory name. It defaults to
601 the value of `default-directory'."
606 dir))
607 mustmatch initial
610 \f
612 "Show the current default directory."
617 "Value of the CDPATH environment variable, as a list.
621 "Explode a search path into a list of directory names.
622 Directories are separated by occurrences of `path-separator'
623 \(which is colon in GNU and GNU-like systems)."
624 ;; We could use split-string here.
632 nil
637 cd-list)))
640 "Change current directory to given absolute file name DIR."
641 ;; Put the name into directory syntax now,
642 ;; because otherwise expand-file-name may give some bad results.
655 "Make DIR become the current buffer's default directory.
656 If your environment includes a `CDPATH' variable, try each one of
657 that list of directories (separated by occurrences of
658 `path-separator') when resolving a relative directory name.
659 The path separator is colon in GNU and GNU-like systems."
662 default-directory default-directory
678 cd-path)
679 nil))
683 "Load the Lisp file named FILE."
684 ;; This is a case where .elc makes a lot of sense.
691 "Search for FILENAME through PATH.
692 If found, return the absolute file name of FILENAME, with its suffixes;
693 otherwise return nil.
694 PATH should be a list of directories to look in, like the lists in
695 `exec-path' or `load-path'.
696 If SUFFIXES is non-nil, it should be a list of suffixes to append to
699 If non-nil, PREDICATE is used instead of `file-readable-p'.
700 PREDICATE can also be an integer to pass to the `access' system call,
701 in which case file-name handlers are ignored. This usage is deprecated.
703 For compatibility, PREDICATE can also be one of the symbols
704 `executable', `readable', `writable', or `exists', or a list of
705 one or more of those symbols."
716 "Do completion for file names passed to `locate-file'."
737 "Do completion for file names passed to `locate-file'.
738 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
741 string nil action))
746 "Regexp of directory names which stop the search in `locate-dominating-file'.
747 Any directory whose name matches this regexp will be treated like
748 a kind of root directory by `locate-dominating-file' which will stop its search
749 when it bumps into it.
750 The default regexp prevents fruitless and time-consuming attempts to find
753 ;; (defun locate-dominating-files (file regexp)
754 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
755 ;; Stop at the first parent where a matching file is found and return the list
756 ;; of files that that match in this directory."
757 ;; (catch 'found
758 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
759 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
760 ;; (let ((user nil)
761 ;; ;; Abbreviate, so as to stop when we cross ~/.
762 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
763 ;; files)
764 ;; (while (and dir
765 ;; ;; As a heuristic, we stop looking up the hierarchy of
766 ;; ;; directories as soon as we find a directory belonging to
767 ;; ;; another user. This should save us from looking in
768 ;; ;; things like /net and /afs. This assumes that all the
769 ;; ;; files inside a project belong to the same user.
770 ;; (let ((prev-user user))
771 ;; (setq user (nth 2 (file-attributes dir)))
772 ;; (or (null prev-user) (equal user prev-user))))
773 ;; (if (setq files (condition-case nil
774 ;; (directory-files dir 'full regexp 'nosort)
775 ;; (error nil)))
776 ;; (throw 'found files)
777 ;; (if (equal dir
778 ;; (setq dir (file-name-directory
779 ;; (directory-file-name dir))))
780 ;; (setq dir nil))))
781 ;; nil)))
784 "Look up the directory hierarchy from FILE for a file named NAME.
785 Stop at the first parent directory containing a file NAME,
786 and return the directory. Return nil if not found."
787 ;; We used to use the above locate-dominating-files code, but the
788 ;; directory-files call is very costly, so we're much better off doing
789 ;; multiple calls using the code in here.
790 ;;
791 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
792 ;; `name' in /home or in /.
796 ;; `user' is not initialized outside the loop because
797 ;; `file' may not exist, so we may have to walk up part of the
798 ;; hierarchy before we find the "initial UID".
800 try)
803 ;; FIXME: Disabled this heuristic because it is sometimes
804 ;; inappropriate.
805 ;; As a heuristic, we stop looking up the hierarchy of
806 ;; directories as soon as we find a directory belonging
807 ;; to another user. This should save us from looking in
808 ;; things like /net and /afs. This assumes that all the
809 ;; files inside a project belong to the same user.
810 ;; (let ((prev-user user))
811 ;; (setq user (nth 2 (file-attributes file)))
812 ;; (and prev-user (not (equal user prev-user))))
820 root))
824 "Search for COMMAND in `exec-path' and return the absolute file name.
825 Return nil if COMMAND is not found anywhere in `exec-path'."
826 ;; Use 1 rather than file-executable-p to better match the behavior of
827 ;; call-process.
831 "Load the library named LIBRARY.
832 This is an interface to the function `load'."
836 load-path
841 "Test whether FILE specifies a location on a remote system.
842 Returns nil or a string identifying the remote connection (ideally
843 a prefix of FILE). For example, the remote identification for filename
846 less reliable than accessing local files.
847 Furthermore, relative file names do not work across remote connections.
849 IDENTIFICATION specifies which part of the identification shall
850 be returned as string. IDENTIFICATION can be the symbol
851 `method', `user', `host' or `localname'; any other value is
852 handled like nil and means to return the complete identification
853 string.
855 If CONNECTED is non-nil, the function returns an identification only
856 if FILE is located on a remote system, and a connection is established
857 to that remote system.
859 `file-remote-p' will never open a connection on its own."
863 nil)))
866 "Copy the file FILE into a temporary file on this machine.
867 Returns the name of the local copy, or nil, if FILE is directly
868 accessible."
869 ;; This formerly had an optional BUFFER argument that wasn't used by
870 ;; anything.
874 nil)))
877 "Return the truename of FILENAME, which should be absolute.
878 The truename of a file name is found by chasing symbolic links
879 both at the level of the file and at the level of the directories
880 containing it, until no links are left at any level.
883 ;; COUNTER and PREV-DIRS are only used in recursive calls.
884 ;; COUNTER can be a cons cell whose car is the count of how many
885 ;; more links to chase before getting an error.
886 ;; PREV-DIRS can be a cons cell whose car is an alist
887 ;; of truenames we've just recently computed.
901 ;; For speed, remove the ange-ftp completion handler from the list.
902 ;; We know it's not needed here.
903 ;; For even more speed, do this only on the outermost call.
910 ;; andrewi@harlequin.co.uk - none of the following code (except for
911 ;; invoking the file-name handler) currently applies on Windows
912 ;; (ie. there are no native symlinks), but there is an issue with
913 ;; case differences being ignored by the OS, and short "8.3 DOS"
914 ;; name aliases existing for all files. (The short names are not
915 ;; reported by directory-files, but can be used to refer to files.)
916 ;; It seems appropriate for file-truename to resolve these issues in
917 ;; the most natural way, which on Windows is to call the function
918 ;; `w32-long-file-name' - this returns the exact name of a file as
919 ;; it is stored on disk (expanding short name aliases with the full
920 ;; name in the process).
923 ;; For file name that has a special handler, call handler.
924 ;; This is so that ange-ftp can save time by doing a no-op.
927 ;; If filename contains a wildcard, newname will be the old name.
929 ;; If filename exists, use the long name. If it doesn't exist,
930 ;; drill down until we find a directory that exists, and use
931 ;; the long name of that, with the extra non-existent path
932 ;; components concatenated.
934 missing rest)
937 ;; Include the preceding directory separator in the missing
938 ;; part so subsequent recursion on the rest works.
943 ""
948 ;; If this file directly leads to a link, process that iteratively
949 ;; so that we don't use lots of stack.
955 ;; For file name that has a special handler, call handler.
956 ;; This is so that ange-ftp can save time by doing a no-op.
959 done t)
961 target dirfile)
962 ;; Get the truename of the directory.
964 ;; If these are equal, we have the (or a) root directory.
966 ;; If this is the same dir we last got the truename for,
967 ;; save time--don't recalculate.
977 done t)
980 done t)
981 ;; Put it back on the file name.
983 ;; Is the file name the name of a link?
986 ;; Yes => chase that link, then start all over
987 ;; since the link may point to a directory name that uses links.
988 ;; We can't safely use expand-file-name here
989 ;; since target might look like foo/../bar where foo
990 ;; is itself a link. Instead, we handle . and .. above.
993 target
995 done nil)
996 ;; No, we are done!
998 filename))
1001 "Chase links in FILENAME until a name that is not a link.
1002 Unlike `file-truename', this does not check whether a parent
1003 directory name is a symbolic link.
1004 If the optional argument LIMIT is a number,
1005 it means chase no more than that many links and then stop."
1013 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1016 ;; Handle `..' by hand, since it needs to work in the
1017 ;; target of any directory symlink.
1018 ;; This code is not quite complete; it does not handle
1019 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1023 ;; Chase links in the default dir of the symlink.
1027 ;; Now find the parent of that dir.
1031 newname))
1034 "Create a temporary file.
1035 The returned file name (created by appending some random characters at the end
1036 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1037 is guaranteed to point to a newly created empty file.
1038 You can then use `write-region' to write new data into the file.
1040 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1042 If SUFFIX is non-nil, add that at the end of the file name."
1044 file)
1047 ;; Create temp files with strict access rights. It's easy to
1048 ;; loosen them later, whereas it's impossible to close the
1049 ;; time-window of loose permissions otherwise.
1057 temporary-file-directory)
1059 temporary-file-directory))))
1065 nil)
1067 ;; the file was somehow created by someone else between
1068 ;; `make-temp-name' and `write-region', let's try again.
1069 nil)
1070 file)
1071 ;; Reset the umask.
1075 "Change the encoding of FILE's name from CODING to NEW-CODING.
1076 The value is a new name of FILE.
1077 Signals a `file-already-exists' error if a file of the new name
1078 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1079 is non-nil. A number as fourth arg means request confirmation if
1080 the new name already exists. This is what happens in interactive
1081 use with M-x."
1084 default-file-name-coding-system))
1086 from-coding to-coding)
1088 ;; We provide the default coding only when it seems that
1089 ;; the filename is correctly decoded by the default
1090 ;; coding.
1096 filename default-coding)
1097 default-coding))
1101 ;; We provide the default coding only when a user is going to
1102 ;; change the encoding not from the default coding.
1106 filename from-coding)))
1109 filename from-coding default-coding)
1110 default-coding)))
1114 default-file-name-coding-system))
1115 ;; FILE should have been decoded by DEFAULT-CODING.
1119 ;; Suppress further encoding.
1124 newname))
1125 \f
1127 "Whether confirmation is requested before visiting a new file or buffer.
1128 If nil, confirmation is not requested.
1129 If the value is `after-completion', confirmation is only
1130 requested if the user called `minibuffer-complete' right before
1131 `minibuffer-complete-and-exit'.
1132 Any other non-nil value means to request confirmation.
1134 This affects commands like `switch-to-buffer' and `find-file'."
1142 "Whether to request confirmation before visiting a new file or buffer.
1143 The variable `confirm-nonexistent-file-or-buffer' determines the
1144 return value, which may be passed as the REQUIRE-MATCH arg to
1145 `read-buffer' or `find-file-read-args'."
1153 "Read the name of a buffer to switch to and return as a string.
1154 It is intended for `switch-to-buffer' family of commands since they
1155 need to omit the name of current buffer from the list of completions
1156 and default values."
1164 "Select the buffer specified by BUFFER-OR-NAME in another window.
1165 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1166 nil. Return the buffer switched to.
1168 If called interactively, prompt for the buffer name using the
1169 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1170 determines whether to request confirmation before creating a new
1171 buffer.
1173 If BUFFER-OR-NAME is a string and does not identify an existing
1174 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1175 nil, switch to the buffer returned by `other-buffer'.
1177 Optional second argument NORECORD non-nil means do not put this
1178 buffer at the front of the list of recently selected ones.
1180 This uses the function `display-buffer' as a subroutine; see its
1181 documentation for additional customization information."
1185 same-window-buffer-names same-window-regexps)
1189 "Switch to buffer BUFFER-OR-NAME in another frame.
1190 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1191 nil. Return the buffer switched to.
1193 If called interactively, prompt for the buffer name using the
1194 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1195 determines whether to request confirmation before creating a new
1196 buffer.
1198 If BUFFER-OR-NAME is a string and does not identify an existing
1199 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1200 nil, switch to the buffer returned by `other-buffer'.
1202 Optional second arg NORECORD non-nil means do not put this
1203 buffer at the front of the list of recently selected ones.
1205 This uses the function `display-buffer' as a subroutine; see its
1206 documentation for additional customization information."
1210 same-window-buffer-names same-window-regexps)
1214 "Display buffer BUFFER in another frame.
1215 This uses the function `display-buffer' as a subroutine; see
1216 its documentation for additional customization information."
1219 same-window-buffer-names same-window-regexps
1221 new-window)
1223 ;; This may have been here in order to prevent the new frame from hiding
1224 ;; the old frame. But it does more harm than good.
1225 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1226 ;;(lower-frame (window-frame new-window))
1228 ;; This may have been here in order to make sure the old-frame gets the
1229 ;; focus. But not only can it cause an annoying flicker, with some
1230 ;; window-managers it just makes the window invisible, with no easy
1231 ;; way to recover it. --Stef
1232 ;;(make-frame-invisible (window-frame old-window))
1233 ;;(make-frame-visible (window-frame old-window))
1234 ))
1240 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1241 BODY should use the minibuffer at most once.
1242 Recursive uses of the minibuffer will not be affected."
1248 ;; Clear out this hook so it does not interfere
1249 ;; with any recursive minibuffer usage.
1265 t))
1268 "Edit file FILENAME.
1269 Switch to a buffer visiting file FILENAME,
1270 creating one if none already exists.
1271 Interactively, the default if you just type RET is the current directory,
1272 but the visited file name is available through the minibuffer history:
1273 type M-n to pull it into the minibuffer.
1275 You can visit files on remote machines by specifying something
1276 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1277 also visit local files as a different user by specifying
1278 /sudo::FILE for the file name.
1279 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1280 manual, for more about this.
1282 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1283 expand wildcards (if any) and visit multiple files. You can
1284 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1286 To visit a file without any kind of conversion and without
1297 "Edit file FILENAME, in another window.
1300 an existing one. See the function `display-buffer'.
1302 Interactively, the default if you just type RET is the current directory,
1303 but the visited file name is available through the minibuffer history:
1304 type M-n to pull it into the minibuffer.
1306 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1307 expand wildcards (if any) and visit multiple files."
1320 "Edit file FILENAME, in another frame.
1323 an existing one. See the function `display-buffer'.
1325 Interactively, the default if you just type RET is the current directory,
1326 but the visited file name is available through the minibuffer history:
1327 type M-n to pull it into the minibuffer.
1329 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1330 expand wildcards (if any) and visit multiple files."
1343 "Edit the existing file FILENAME.
1345 file names with wildcards."
1353 "Edit file FILENAME but don't allow changes.
1367 value))
1370 "Edit file FILENAME in another window but don't allow changes.
1384 value))
1387 "Edit file FILENAME in another frame but don't allow changes.
1401 value))
1404 "Find file FILENAME as a replacement for the file in the next window.
1405 This command does not select that window.
1409 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1410 expand wildcards (if any) and replace the file with multiple files."
1422 t))))
1430 "Find file FILENAME, select its buffer, kill previous buffer.
1431 If the current buffer now contains an empty file that you just visited
1432 \(presumably by mistake), use this command to visit the file you really want.
1436 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1437 expand wildcards (if any) and replace the file with multiple files.
1439 If the current buffer is an indirect buffer, or the base buffer
1440 for one or more indirect buffers, the other buffer(s) are not
1441 killed."
1451 t)))
1472 ;; This prevents us from finding the same buffer
1473 ;; if we specified the same file again.
1477 ;; Likewise for dired buffers.
1481 ;; This executes if find-file gets an error
1482 ;; and does not really find anything.
1483 ;; We put things back as they were.
1484 ;; If find-file actually finds something, we kill obuf below.
1493 ;; We already asked; don't ask again.
1496 \f
1498 "Create a suitably named buffer for visiting FILENAME, and return it.
1499 FILENAME (sans directory) is used unchanged if that name is free;
1500 otherwise a string <2> or <3> or ... is appended to get an unused name.
1501 Spaces at the start of FILENAME (sans directory) are removed."
1510 "Create and return a buffer with a name based on NAME.
1511 Choose the buffer's name using `generate-new-buffer-name'."
1515 "Regexp to match the automounter prefix in a directory name."
1523 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1525 home directory is a root directory) and removes automounter prefixes
1526 \(see the variable `automount-dir-prefix')."
1527 ;; Get rid of the prefixes added by the automounter.
1534 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1535 ;; To fix this right, we need a `file-name-case-sensitive-p'
1536 ;; function, but we don't have that yet, so just guess.
1539 ;; If any elt of directory-abbrev-alist matches this name,
1540 ;; abbreviate accordingly.
1546 ;; Compute and save the abbreviated homedir name.
1547 ;; We defer computing this until the first time it's needed, to
1548 ;; give time for directory-abbrev-alist to be set properly.
1549 ;; We include a slash at the end, to avoid spurious matches
1550 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1557 ;; If FILENAME starts with the abbreviated homedir,
1558 ;; make it start with `~' instead.
1560 ;; If the home dir is just /, don't change it.
1563 ;; MS-DOS root directories can come with a drive letter;
1564 ;; Novell Netware allows drive letters beyond `Z:'.
1574 filename)))
1577 "List of logical names for which visiting shouldn't save the true dirname."
1582 "Return the buffer visiting file FILENAME (a string).
1583 This is like `get-file-buffer', except that it checks for any buffer
1584 visiting the same file, possibly under a different name.
1585 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1586 and others are ignored.
1587 If there is no such live buffer, return nil."
1601 found)
1611 ;; Verify this buffer's file number
1612 ;; still belongs to its file.
1615 attributes)
1619 found))))
1620 \f
1622 "Non-nil means file-visiting commands should handle wildcards.
1623 For example, if you specify `*.c', that would visit all the files
1624 whose names match the pattern."
1630 "Non-nil means suppress warning messages for symlinked files.
1631 When nil, Emacs prints a warning when visiting a file that is already
1632 visited, but with a different name. Setting this option to t
1633 suppresses this warning."
1639 "Maximum size of file above which a confirmation is requested.
1640 When nil, never request confirmation."
1647 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1648 OP-TYPE specifies the file operation being performed (for message to user)."
1658 "Read file FILENAME into a buffer and return the buffer.
1659 If a buffer exists visiting FILENAME, return that one, but
1660 verify that the file has not changed since visited or saved.
1661 The buffer is not selected, just returned to the caller.
1662 Optional second arg NOWARN non-nil means suppress any warning messages.
1663 Optional third arg RAWFILE non-nil means the file is read literally.
1664 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1665 and visit all the matching files. When wildcards are actually
1666 used and expanded, return a list of buffers that are visiting
1667 the various files."
1674 'find-directory-functions
1677 filename)))
1680 find-file-wildcards
1694 ;; Find any buffer for a file which has same truename.
1696 ;; Let user know if there is a buffer with the same truename.
1700 find-file-suppress-same-file-warnings
1704 ;; Optionally also find that buffer.
1707 ;; Check to see if the file looks uncommonly large.
1711 ;; We are using an existing buffer.
1718 ;; Certain files should be reverted automatically
1719 ;; if they have changed on disk and not in the buffer.
1727 found))
1737 "File %s changed on disk. Discard your edits? "
1742 "File %s changed on disk. Discard your edits in %s? "
1750 ;; Check if a formerly read-only file has become
1751 ;; writable and vice versa, but if the buffer agrees
1752 ;; with the new state of the file, that is ok too.
1760 buffer-file-name
1769 ;; It is confusing to ask whether to visit
1770 ;; non-literally if they have the file in
1771 ;; hexl-mode.
1777 "The file %s is already visited normally,
1778 and you have edited the buffer. Now you have asked to visit it literally,
1779 meaning no coding system handling, format conversion, or local variables.
1780 Emacs can only visit a file in one way at a time.
1782 Do you want to save the file, and visit it literally instead? "
1783 "The file %s is already visited literally,
1784 meaning no coding system handling, format conversion, or local variables.
1785 You have edited the buffer. Now you have asked to visit the file normally,
1786 but Emacs can only visit a file in one way at a time.
1793 rawfile truename number))
1797 "\
1798 Do you want to discard your changes, and visit the file literally now? "
1799 "\
1802 rawfile truename number)
1808 "The file %s is already visited normally.
1809 You have asked to visit it literally,
1810 meaning no coding system decoding, format conversion, or local variables.
1811 But Emacs can only visit a file in one way at a time.
1813 Do you want to revisit the file literally now? "
1814 "The file %s is already visited literally,
1815 meaning no coding system decoding, format conversion, or local variables.
1816 You have asked to visit it normally,
1817 but Emacs can only visit a file in one way at a time.
1822 rawfile truename number)
1825 ;; Return the buffer we are using.
1826 buf)
1827 ;; Create a new buffer.
1829 ;; find-file-noselect-1 may use a different buffer.
1831 rawfile truename number))))))
1837 ;; Needed in case we are re-visiting the file with a different
1838 ;; text representation.
1855 filename)))
1856 ;; Unconditionally set error
1866 filename)))
1867 ;; Run find-file-not-found-functions until one returns non-nil.
1869 ;; If they fail too, set error.
1871 ;; Record the file's truename, and maybe use that as visited name.
1879 ;; Set buffer's default directory to that of the file.
1881 ;; Turn off backup files for certain file names. Since
1882 ;; this is a permanent local, the major mode won't eliminate it.
1897 \f
1899 "Like `insert-file-contents', but only reads in the file literally.
1900 A buffer may be modified in several ways after reading into the buffer,
1901 to Emacs features such as format decoding, character code
1902 conversion, `find-file-hook', automatic uncompression, etc.
1904 This function ensures that none of these modifications will take place."
1912 nil))
1915 inhibit-file-name-handlers))
1928 filename)))
1929 ;; Check whether the file is uncommonly large
1940 "Insert contents of file FILENAME into buffer after point with no conversion.
1942 This function is meant for the user to run interactively.
1943 Don't call it from programs! Use `insert-file-contents-literally' instead.
1944 \(Its calling sequence is different; see its documentation)."
1949 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1954 "Visit file FILENAME with no conversion of any kind.
1955 Format conversion and character code conversion are both disabled,
1956 and multibyte characters are disabled in the resulting buffer.
1957 The major mode used is Fundamental mode regardless of the file name,
1958 and local variable specifications in the file are ignored.
1959 Automatic uncompression and adding a newline at the end of the
1960 file due to `require-final-newline' is also disabled.
1962 You cannot absolutely rely on this function to result in
1963 visiting the file literally. If Emacs already has a buffer
1964 which is visiting the file, you get the existing buffer,
1965 regardless of whether it was created literally or not.
1967 In a Lisp program, if you want to be sure of accessing a file's
1968 contents literally, you should create a temporary buffer and then read
1969 the file contents into it using `insert-file-contents-literally'."
1972 \f
1976 after-find-file-from-revert-buffer
1977 nomodes)
1978 "Called after finding a file and by the default revert function.
1979 Sets buffer mode, parses local variables.
1980 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1981 error in reading the file. WARN non-nil means warn if there
1982 exists an auto-save file more recent than the visited file.
1983 NOAUTO means don't mess with auto-save mode.
1984 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1985 means this call was from `revert-buffer'.
1986 Fifth arg NOMODES non-nil means don't alter the file's modes.
1987 Finishes by calling the functions in `find-file-hook'
1988 unless NOMODES is non-nil."
1991 nil
2001 ;; No need to warn if buffer is auto-saved
2002 ;; under the name of the visited file.
2004 auto-save-visited-file-name))
2007 buffer-file-name))
2027 ;; Make people do a little extra work (C-x C-q)
2028 ;; before altering a backup file.
2031 ;; When a file is marked read-only,
2032 ;; make the buffer read-only even if root is looking at it.
2040 ;; If requested, add a newline at the end of the file.
2050 view-read-only
2056 "Eval BODY and turn any error into a FORMAT message.
2057 FORMAT can have a %s escape which will be replaced with the actual error.
2058 If `debug-on-error' is set, errors are not caught, so that you can
2059 debug them.
2060 Avoid using a large BODY since it is duplicated."
2069 "Choose the major mode for this buffer automatically.
2070 Also sets up any specified local variables of the file.
2071 Uses the visited file name, the -*- line, and the local variables spec.
2073 This function is called automatically from `find-file'. In that case,
2074 we may set up the file-specified mode and local variables,
2075 depending on the value of `enable-local-variables'.
2076 In addition, if `local-enable-local-variables' is nil, we do
2077 not set local variables (though we do notice a mode specified with -*-.)
2079 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2080 or from Lisp without specifying the optional argument FIND-FILE;
2081 in that case, this function acts as if `enable-local-variables' were t."
2089 ;; Turn font lock off and on, to make sure it takes account of
2090 ;; whatever file local variables are relevant to it.
2092 ;; Font-lock-mode (now in font-core.el) can be ON when
2093 ;; font-lock.el still hasn't been loaded.
2103 "Non-nil means to try second pass through `auto-mode-alist'.
2104 This means that if the first case-sensitive search through the alist fails
2105 to find a matching major mode, a second case-insensitive search is made.
2106 On systems with case-insensitive file names, this variable is ignored,
2107 since only a single case-insensitive search through the alist is made."
2113 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2114 ;; c++-mode, java-mode and more) are added through autoload
2115 ;; directives in that file. That way is discouraged since it
2116 ;; spreads out the definition of the initial value.
2149 ;; Less common extensions come here
2150 ;; so more common ones above are found faster.
2189 ;; The list of archive file extensions should be in sync with
2190 ;; `auto-coding-alist' with `no-conversion' coding system.
2196 ;; Mailer puts message to be edited in
2197 ;; /tmp/Re.... or Message
2201 ;; some news reader is reported to use this
2210 ;; .emacs or .gnus or .viper following a directory delimiter in
2211 ;; Unix, MSDOG or VMS syntax.
2214 ;; _emacs following a directory delimiter
2215 ;; in MsDos syntax
2219 ;; Common Lisp ASDF package system.
2238 ;; Windows candidates may be opened case sensitively on Unix
2244 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2246 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2247 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2248 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2249 ;; this has lower priority to avoid matching changelog.sgml etc.
2251 ;; either user's dot-files or under /etc or some such
2253 ;; alas not all ~/.*rc files are like this
2254 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2259 ;; this contains everything twice, with space and with colon :-(
2261 ;; Get rid of any trailing .n.m and try again.
2262 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2263 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2264 ;; Using mode nil rather than `ignore' would let the search continue
2265 ;; through this list (with the shortened name) rather than start over.
2267 ;; The following should come after the ChangeLog pattern
2268 ;; for the sake of ChangeLog.1, etc.
2269 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2272 "Alist of filename patterns vs corresponding major mode functions.
2273 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2274 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2275 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2276 mode function to use. FUNCTION will be called, unless it is nil.
2278 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2279 calling FUNCTION (if it's not nil), we delete the suffix that matched
2280 REGEXP and search the list again for another match.
2282 If the file name matches `inhibit-first-line-modes-regexps',
2283 then `auto-mode-alist' is not processed.
2285 The extensions whose FUNCTION is `archive-mode' should also
2286 appear in `auto-coding-alist' with `no-conversion' coding system.
2288 See also `interpreter-mode-alist', which detects executable script modes
2289 based on the interpreters they specify to run,
2293 "Select Conf mode or XML mode according to start of file."
2303 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2304 ;; and pike-mode) are added through autoload directives in that
2305 ;; file. That way is discouraged since it spreads out the
2306 ;; definition of the initial value.
2344 "Alist mapping interpreter names to major modes.
2345 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2346 Each element looks like (INTERPRETER . MODE).
2347 If INTERPRETER matches the name of the interpreter specified in the first line
2348 of a script, mode MODE is enabled.
2356 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2357 When checking `inhibit-first-line-modes-regexps', we first discard
2363 "Regexp matching interpreters, for file mode determination.
2364 This regular expression is matched against the first line of a file
2365 to determine the file's mode in `set-auto-mode'. If it matches, the file
2366 is assumed to be interpreted by the interpreter matched by the second group
2367 of the regular expression. The mode is then determined as the mode
2371 "Alist of buffer beginnings vs. corresponding major mode functions.
2372 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2373 After visiting a file, if REGEXP matches the text at the beginning of the
2374 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2375 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2376 major mode.
2378 If FUNCTION is nil, then it is not called. (That is a way of saying
2384 ;; The < comes before the groups (but the first) to reduce backtracking.
2385 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2386 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2390 comment-re "*"
2393 . html-mode)
2395 ;; These two must come after html, because they are more general:
2400 . sgml-mode)
2403 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2404 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2405 After visiting a file, if REGEXP matches the text at the beginning of the
2406 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2407 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2408 have not specified a mode for this file.
2414 "Upper limit on `magic-mode-alist' regexp matches.
2418 "Select major mode appropriate for current buffer.
2420 To find the right major mode, this function checks for a -*- mode tag,
2421 checks if it uses an interpreter listed in `interpreter-mode-alist',
2422 matches the buffer beginning against `magic-mode-alist',
2423 compares the filename against the entries in `auto-mode-alist',
2424 then matches the buffer beginning against `magic-fallback-mode-alist'.
2426 It does not check for the `mode:' local variable in the
2427 Local Variables section of the file; for that, use `hack-local-variables'.
2429 If `enable-local-variables' is nil, this function does not check for a
2430 -*- mode tag.
2432 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2433 set the major mode only if that would change it. In other words
2434 we don't actually set it to the same mode the buffer already has."
2435 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2437 ;; Find a -*- mode tag
2444 ;; Find all specifications for the `mode:' variable
2445 ;; and execute them left to right.
2457 modes)))
2458 ;; Simple -*-MODE-*- case.
2461 modes))))
2462 ;; If we found modes to use, invoke them now, outside the save-excursion.
2470 ;; continuing would call minor modes again, toggling them off
2472 ;; If we didn't, look for an interpreter specified in the first line.
2473 ;; As a special case, allow for things like "#!/bin/env perl", which
2474 ;; finds the interpreter anywhere in $PATH.
2481 ;; Map interpreter name to a mode, signalling we're done at the
2482 ;; same time.
2484 interpreter-mode-alist))
2485 ;; If we found an interpreter mode to use, invoke it now.
2488 ;; Next try matching the buffer beginning against magic-mode-alist.
2502 ;; Next compare the filename against the entries in auto-mode-alist.
2507 ;; Remove remote file name identification.
2511 ;; Remove backup-suffixes from file name.
2514 ;; Find first matching alist entry.
2517 ;; System is case-insensitive.
2521 ;; System is case-sensitive.
2523 ;; First match case-sensitively.
2527 ;; Fallback to case-insensitive match.
2541 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2556 ;; When `keep-mode-if-same' is set, we are working on behalf of
2557 ;; set-visited-file-name. In that case, if the major mode specified is the
2558 ;; same one we already have, don't actually reset it. We don't want to lose
2559 ;; minor modes such as Font Lock.
2561 "Apply MODE and return it.
2562 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2563 any aliases and compared to current major mode. If they are the
2564 same, do nothing and return nil."
2570 mode)))
2573 "Find the -*- spec in the buffer.
2574 Call with point at the place to start searching from.
2575 If one is found, set point to the beginning
2576 and return the position of the end.
2577 Otherwise, return nil; point may be changed."
2580 ;; Don't look for -*- if this file name matches any
2581 ;; of the regexps in inhibit-first-line-modes-regexps.
2589 sufs)
2597 ;; If the file begins with "#!"
2598 ;; (exec interpreter magic), look
2599 ;; for mode frobs in the first two
2600 ;; lines. You cannot necessarily
2601 ;; put them in the first line of
2602 ;; such a file without screwing up
2603 ;; the interpreter invocation.
2604 ;; The same holds for
2605 ;; '\"
2606 ;; in man pages (preprocessor
2607 ;; magic for the `man' program).
2618 end))))
2619 \f
2620 ;;; Handling file local variables
2624 file-local-variables-alist)
2628 "Normal hook run after processing a file's local variables specs.
2629 Major modes can use this to examine user-specified local variables
2633 "List variable-value pairs that are considered safe.
2634 Each element is a cons cell (VAR . VAL), where VAR is a variable
2635 symbol and VAL is a value that is considered safe."
2640 "Expressions that are considered safe in an `eval:' local variable.
2641 Add expressions to this list if you want Emacs to evaluate them, when
2642 they appear in an `eval' local variable specification, without first
2643 asking you for confirmation."
2648 ;; Risky local variables:
2651 auto-mode-alist
2652 buffer-auto-save-file-name
2653 buffer-file-name
2654 buffer-file-truename
2655 buffer-undo-list
2656 dabbrev-case-fold-search
2657 dabbrev-case-replace
2658 debugger
2659 default-text-properties
2660 display-time-string
2661 enable-local-eval
2662 enable-local-variables
2663 eval
2664 exec-directory
2665 exec-path
2666 file-name-handler-alist
2667 font-lock-defaults
2668 format-alist
2669 frame-title-format
2670 global-mode-string
2671 header-line-format
2672 icon-title-format
2673 ignored-local-variables
2674 imenu--index-alist
2675 imenu-generic-expression
2676 inhibit-quit
2677 input-method-alist
2678 load-path
2679 max-lisp-eval-depth
2680 max-specpdl-size
2681 minor-mode-alist
2682 minor-mode-map-alist
2683 minor-mode-overriding-map-alist
2684 mode-line-buffer-identification
2685 mode-line-format
2686 mode-line-client
2687 mode-line-modes
2688 mode-line-modified
2689 mode-line-mule-info
2690 mode-line-position
2691 mode-line-process
2692 mode-line-remote
2693 mode-name
2694 outline-level
2695 overriding-local-map
2696 overriding-terminal-local-map
2697 parse-time-rules
2698 process-environment
2699 rmail-output-file-alist
2700 safe-local-variable-values
2701 safe-local-eval-forms
2702 save-some-buffers-action-alist
2703 special-display-buffer-names
2704 standard-input
2705 standard-output
2706 unread-command-events
2707 vc-mode))
2709 ;; Safe local variables:
2710 ;;
2711 ;; For variables defined by major modes, the safety declarations can go into
2712 ;; the major mode's file, since that will be loaded before file variables are
2713 ;; processed.
2714 ;;
2715 ;; For variables defined by minor modes, put the safety declarations in the
2716 ;; file defining the minor mode after the defcustom/defvar using an autoload
2717 ;; cookie, e.g.:
2718 ;;
2719 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2720 ;;
2721 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2722 ;; minor mode file may not be loaded yet.
2723 ;;
2724 ;; For variables defined in the C source code the declaration should go here:
2740 "Alist of file-local variable settings in the current buffer.
2741 Each element in this list has the form (VAR . VALUE), where VAR
2742 is a file-local variable (a symbol) and VALUE is the value
2743 specified. The actual value in the buffer may differ from VALUE,
2748 "Normal hook run before setting file-local variables.
2749 It is called after checking for unsafe/risky variables and
2750 setting `file-local-variables-alist', and before applying the
2751 variables stored in `file-local-variables-alist'. A hook
2752 function is allowed to change the contents of this alist.
2754 This hook is called only if there is at least one file-local
2758 "Get confirmation before setting up local variable values.
2759 ALL-VARS is the list of all variables to be set up.
2760 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2761 RISKY-VARS is the list of those that are marked as risky.
2762 DIR-NAME is a directory name if these settings come from
2763 directory-local variables, or nil otherwise."
2765 nil
2771 prompt char)
2781 ", and variables that are risky (**)."
2788 y -- to apply the local variables list.
2792 ! -- to apply the local variables list, and permanently mark these
2804 ;; Make strings with embedded whitespace easier to read.
2812 ""
2819 done)
2828 ;; read-event returns -1 if we are in a kbd
2829 ;; macro and there are no more events in the
2830 ;; macro. In that case, attempt to get an
2831 ;; event interactively.
2839 ;; When this is called from desktop-restore-file-buffer,
2840 ;; coding-system-for-read may be non-nil. Reset it before
2841 ;; writing to .emacs.
2845 'safe-local-variable-values
2846 safe-local-variable-values))))
2853 "Return local variables specified in the -*- line.
2854 Ignore any specification for `mode:' and `coding:';
2855 `set-auto-mode' should already have handled `mode:',
2856 `set-auto-coding' should already have handled `coding:'.
2858 If MODE-ONLY is non-nil, all we do is check whether the major
2859 mode is specified, returning t if it is specified. Otherwise,
2860 return an alist of elements (VAR . VAL), where VAR is a variable
2861 and VAL is the specified value."
2865 result mode-specified)
2866 ;; Parse the -*- line into the RESULT alist.
2867 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2869 nil)
2871 ;; Simple form: "-*- MODENAME -*-". Already handled.
2873 nil)
2875 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2876 ;; (last ";" is optional).
2881 ;; There used to be a downcase here,
2882 ;; but the manual didn't say so,
2883 ;; and people want to set var names that aren't all lc.
2888 ;; It is traditional to ignore
2889 ;; case when checking for `mode' in set-auto-mode,
2890 ;; so we must do that here as well.
2891 ;; That is inconsistent, but we're stuck with it.
2892 ;; The same can be said for `coding' in set-auto-coding.
2898 'eval
2905 mode-specified
2906 result))))
2909 "Filter local variable settings, querying the user if necessary.
2910 VARIABLES is the alist of variable-value settings. This alist is
2911 filtered based on the values of `ignored-local-variables',
2912 `enable-local-eval', `enable-local-variables', and (if necessary)
2913 user interaction. The results are added to
2914 `file-local-variables-alist', without applying them.
2915 DIR-NAME is a directory name if these settings come from
2916 directory-local variables, or nil otherwise."
2917 ;; Strip any variables that are in `ignored-local-variables'.
2920 ;; If `enable-local-eval' is nil, strip eval "variables".
2925 ;; Find those variables that we may want to save to
2926 ;; `safe-local-variable-values'.
2931 ;; Don't query about the fake variables.
2942 ;; If caller wants only safe variables, store only these.
2947 ;; Query, unless all are known safe or the user wants no
2948 ;; querying.
2954 variables unsafe-vars risky-vars dir-name))
2959 "Parse and put into effect this buffer's local variables spec.
2960 If MODE-ONLY is non-nil, all we do is check whether the major mode
2961 is specified, returning t if it is specified."
2964 result)
2971 ;; Look for "Local variables:" line in last page.
2979 ;; suffix is what comes after "local variables:" in its line.
2980 ;; prefix is what comes before "local variables:" in its line.
2990 beg)
2994 endpos
3000 nil t))
3001 ;; This used to be an error, but really all it means is
3002 ;; that this may simply not be a local-variables section,
3003 ;; so just ignore it.
3013 ;; Discard the prefix.
3018 ;; Discard the suffix.
3026 ;; Find the variable name; strip whitespace.
3034 val)
3035 ;; Read the variable value.
3045 'eval
3050 ;; Now we've read all the local variables.
3051 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3053 ;; Otherwise, set the variables.
3065 "Non-nil if SYM is safe as a file-local variable with value VAL.
3066 It is safe if any of these conditions are met:
3068 * There is a matching entry (SYM . VAL) in the
3069 `safe-local-variable-values' user option.
3071 * The `safe-local-variable' property of SYM is a function that
3072 evaluates to a non-nil value with VAL as an argument."
3078 "Non-nil if SYM could be dangerous as a file-local variable.
3079 It is dangerous if either of these conditions are met:
3081 * Its `risky-local-variable' property is non-nil.
3087 ;; If this is an alias, check the base name.
3107 "Return t if it is safe to eval EXP when it is found in a file."
3109 ;; Detect certain `put' expressions.
3116 lisp-indent-function
3117 scheme-indent-function))
3118 ;; Only allow safe values (not functions).
3123 ;; Only allow indirect form specs.
3124 ;; During bootstrapping, edebug-basic-spec might not be
3125 ;; defined yet.
3129 ;; Allow expressions that the user requested.
3131 ;; Certain functions can be allowed with safe arguments
3132 ;; or can specify verification functions to try.
3140 ok))
3148 ok)))))))
3151 "Set local variable VAR with value VAL.
3152 If VAR is `mode', call `VAL-mode' as a function unless it's
3153 already the major mode."
3163 ;; Make sure the string has no text properties.
3164 ;; Some text properties can get evaluated in various ways,
3165 ;; so it is risky to put them on with a local variable list.
3169 \f
3170 ;;; Handling directory-local variables, aka project settings.
3179 "Return the variable list for CLASS."
3183 "Collect directory-local variables from MODE-VARIABLES.
3184 VARIABLES is the initial list of variables.
3185 Returns the new list."
3192 ;; Need a new cons in case we setcdr later.
3196 "Collect entries from CLASS-VARIABLES into VARIABLES.
3197 ROOT is the root directory of the project.
3198 Return the new variables list."
3206 ;; Don't include this in the previous condition, because we
3207 ;; want to filter all strings before the next condition.
3219 "Declare that the DIRECTORY root is an instance of CLASS.
3220 DIRECTORY is the name of a directory, a string.
3221 CLASS is the name of a project class, a symbol.
3223 When a file beneath DIRECTORY is visited, the mode-specific
3224 variables from CLASS will be applied to the buffer. The variables
3225 for a class are defined using `dir-locals-set-class-variables'."
3232 "Map the type CLASS to a list of variable settings.
3233 CLASS is the project class, a symbol. VARIABLES is a list
3234 that declares directory-local variables for the class.
3235 An element in VARIABLES is either of the form:
3236 (MAJOR-MODE . ALIST)
3237 or
3238 (DIRECTORY . LIST)
3240 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3241 whose elements are of the form (VARIABLE . VALUE).
3243 In the second form, DIRECTORY is a directory name (a string), and
3244 LIST is a list of the form accepted by the function.
3246 When a file is visited, the file's class is found. A directory
3247 may be assigned a class using `dir-locals-set-directory-class'.
3248 Then variables are set in the file's buffer according to the
3249 class' LIST. The list is processed in order.
3251 * If the element is of the form (MAJOR-MODE . ALIST), and the
3252 buffer's major mode is derived from MAJOR-MODE (as determined
3253 by `derived-mode-p'), then all the variables in ALIST are
3254 applied. A MAJOR-MODE of nil may be used to match any buffer.
3255 `make-local-variable' is called for each variable before it is
3256 set.
3258 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3259 is an initial substring of the file's directory, then LIST is
3260 applied by recursively following these rules."
3267 "File that contains directory-local variables.
3268 It has to be constant to enforce uniform values
3272 "Find the directory-local variables FILE.
3273 This searches upward in the directory tree.
3274 If a local variables file is found, the file name is returned.
3275 If the file is already registered, a cons from
3276 `dir-locals-directory-alist' is returned.
3277 Otherwise this returns nil."
3282 dir-locals-file))
3285 ;; `locate-dominating-file' may have abbreviated the name.
3298 locals-file
3299 dir-elt)
3303 "Load a variables FILE and register a new class and instance.
3304 FILE is the name of the file holding the variables to apply.
3305 The new class name is the same as the directory in which FILE
3306 is found. Returns the new class name."
3308 ;; We should probably store the modtime of FILE and then
3309 ;; reload it whenever it changes.
3316 class-name)))
3321 "Read per-directory local variables for the current buffer.
3322 Store the directory-local variables in `file-local-variables-alist',
3323 without applying them."
3327 ;; Find the variables file.
3345 \f
3348 However, the mode will not be changed if
3349 \(1) a local variables list or the `-*-' line specifies a major mode, or
3351 \ not suitable for ordinary files, or
3352 \(3) the new file name does not particularly specify any mode."
3357 "Change name of file visited in current buffer to FILENAME.
3358 This also renames the buffer to correspond to the new file.
3359 The next time the buffer is saved it will go in the newly specified file.
3360 FILENAME nil or an empty string means mark buffer as not visiting any file.
3361 Remember to delete the initial contents of the minibuffer
3362 if you wish to pass an empty string as the argument.
3364 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3365 confirmation in the case where another buffer is already visiting FILENAME.
3367 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3368 the old visited file has been renamed to the new name FILENAME."
3376 nil
3391 filename)))
3401 ;; If new-name == old-name, renaming would add a spurious <2>
3402 ;; and it's considered as a feature in rename-buffer.
3408 ;; Abbreviate the file names of the buffer.
3417 nil)))
3418 ;; write-file-functions is normally used for things like ftp-find-file
3419 ;; that visit things that are not local files as if they were files.
3420 ;; Changing to visit an ordinary local file instead should flush the hook.
3425 ;; If buffer was read-only because of version control,
3426 ;; that reason is gone now, so make it writable.
3430 ;; Turn off backup files for certain file names.
3431 ;; Since this is a permanent local, the major mode won't eliminate it.
3433 backup-enable-predicate
3439 ;; If auto-save was not already on, turn it on if appropriate.
3443 ;; If auto save is on, start using a new name.
3444 ;; We deliberately don't rename or delete the old auto save
3445 ;; for the old visited file name. This is because perhaps
3446 ;; the user wants to save the new state and then compare with the
3447 ;; previous state from the auto save file.
3450 ;; Rename the old auto save file if any.
3457 ;; Update the major mode, if the file name determines it.
3459 ;; Don't change the mode if it is special.
3462 ;; Don't change the mode if the local variable list specifies it.
3468 "Write current buffer into file FILENAME.
3469 This makes the buffer visit that file, and marks it as not modified.
3471 If you specify just a directory name as FILENAME, that means to use
3472 the default file name but in that directory. You can also yank
3473 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3475 If the buffer is not already visiting a file, the default file name
3476 for the output file is the buffer name.
3478 If optional second arg CONFIRM is non-nil, this function
3479 asks for confirmation before overwriting an existing file.
3480 Interactively, confirmation is required unless you supply a prefix argument."
3481 ;; (interactive "FWrite file: ")
3485 nil nil nil nil)
3489 default-directory)
3490 nil nil))
3494 ;; If arg is just a directory,
3495 ;; use the default file name, but in that directory.
3506 ;; Make buffer writable if file is writable.
3511 ;; It's likely that the VC status at the new location is different from
3512 ;; the one at the old location.
3514 \f
3516 "Make a backup of the disk file visited by the current buffer, if appropriate.
3517 This is normally done before saving the buffer the first time.
3519 A backup may be done by renaming or by copying; see documentation of
3520 variable `make-backup-files'. If it's done by renaming, then the file is
3521 no longer accessible under its old name.
3523 The value is non-nil after a backup was made by renaming.
3524 It has the form (MODES . BACKUPNAME).
3525 MODES is the result of `file-modes' on the original
3526 file; this means that the caller, after saving the buffer, should change
3527 the modes of the new file to agree with the old modes.
3528 BACKUPNAME is the backup file name, which is the old file renamed."
3535 backup-info backupname targets setmodes)
3536 ;; If specified name is a symbolic link, chase it to the target.
3537 ;; Thus we make the backups in the directory where the real file is.
3542 ;; (if (file-directory-p buffer-file-name)
3543 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3547 ;; If have old versions to maybe delete,
3548 ;; ask the user to confirm now, before doing anything.
3549 ;; But don't actually delete til later.
3554 real-file-name)))))
3556 ;; Actually write the back up file.
3559 ; (file-symlink-p buffer-file-name)
3560 backup-by-copying
3561 ;; Don't rename a suid or sgid file.
3576 ;; rename-file should delete old backup.
3580 ;; If trouble writing the backup, write it in ~.
3585 backupname)
3589 ;; Now delete the old versions, if desired.
3596 setmodes)
3603 ;; Create temp files with strict access rights. It's easy to
3604 ;; loosen them later, whereas it's impossible to close the
3605 ;; time-window of loose permissions otherwise.
3608 ;; Try to overwrite old backup first.
3616 nil)
3618 ;; The file was somehow created by someone else between
3619 ;; `delete-file' and `copy-file', so let's try again.
3620 ;; rms says "I think there is also a possible race
3621 ;; condition for making backup files" (emacs-devel 20070821).
3622 nil)))
3623 ;; Reset the umask.
3629 "Return file NAME sans backup versions or strings.
3630 This is a separate procedure so your site-init or startup file can
3631 redefine it.
3632 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3633 we do not remove backup version numbers, only true file version numbers."
3645 "Return t if deleting FILE and rewriting it would preserve the owner."
3650 ;; Return t if the file doesn't exist, since it's true that no
3651 ;; information would be lost by an (attempted) delete and create.
3657 The extension, in a file name, is the part that follows the last `.',
3658 except that a leading `.', if any, doesn't count."
3661 directory)
3665 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3666 ;; we don't want to expand it.
3669 filename))))
3673 The extension, in a file name, is the part that follows the last `.',
3674 excluding version numbers and backup suffixes,
3675 except that a leading `.', if any, doesn't count.
3676 Return nil for extensionless file names such as `foo'.
3677 Return the empty string for file names such as `foo.'.
3679 If PERIOD is non-nil, then the returned value includes the period
3680 that delimits the extension, and if FILENAME has no extension,
3691 "A function to use instead of the default `make-backup-file-name'.
3692 A value of nil gives the default `make-backup-file-name' behavior.
3694 This could be buffer-local to do something special for specific
3695 files. If you define it, you may need to change `backup-file-name-p'
3696 and `file-name-sans-versions' too.
3698 See also `backup-directory-alist'."
3704 "Alist of filename patterns and backup directory names.
3705 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3706 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3707 relative or absolute. If it is absolute, so that all matching files
3708 are backed up into the same directory, the file names in this
3709 directory will be the full name of the file backed up with all
3710 directory separators changed to `!' to prevent clashes. This will not
3711 work correctly if your filesystem truncates the resulting name.
3713 For the common case of all backups going into one directory, the alist
3715 directory name.
3717 If this variable is nil, or it fails to match a filename, the backup
3718 is made in the original file's directory.
3720 On MS-DOS filesystems without long names this variable is always
3721 ignored."
3727 "Default `backup-enable-predicate' function.
3728 Checks for files in `temporary-file-directory',
3729 `small-temporary-file-directory', and /tmp."
3732 ;; Directory is under temporary-file-directory.
3737 ;; Directory is under /tmp.
3742 0 nil
3744 ;; Directory is under small-temporary-file-directory.
3749 "Create the non-numeric backup file name for FILE.
3750 Normally this will just be the file's name with `~' appended.
3751 Customization hooks are provided as follows.
3753 If the variable `make-backup-file-name-function' is non-nil, its value
3754 should be a function which will be called with FILE as its argument;
3755 the resulting name is used.
3757 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3758 the documentation of that variable. If the directory for the backup
3759 doesn't exist, it is created."
3773 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3775 elt backup-directory abs-backup-directory)
3780 alist nil)))
3781 ;; If backup-directory is relative, it should be relative to the
3782 ;; file's directory. By expanding explicitly here, we avoid
3783 ;; depending on default-directory.
3792 abs-backup-directory nil))))
3794 file
3798 ;; Normalize DOSish file names: downcase the drive
3799 ;; letter, if any, and replace the leading "x:" with
3800 ;; "/drive_x".
3803 ;; Replace any invalid file-name characters (for the
3804 ;; case of backing up remote files).
3808 "drive_"
3811 ""
3814 ;; Make the name unique by substituting directory
3815 ;; separators. It may not really be worth bothering about
3816 ;; doubling `!'s in the original name...
3821 backup-directory))
3826 "Return non-nil if FILE is a backup file name (numeric or not).
3827 This is a separate function so you can redefine it for customization.
3828 You may need to redefine `file-name-sans-versions' as well."
3833 ;; This is used in various files.
3834 ;; The usage of backup-extract-version-start is not very clean,
3835 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3837 "Given the name of a numeric backup file, FN, return the backup number.
3838 Uses the free variable `backup-extract-version-start', whose value should be
3839 the index in the name where the version number begins."
3846 "Find a file name for a backup file FN, and suggestions for deletions.
3847 Value is a list whose car is the name for the backup file
3848 and whose cdr is a list of old versions to consider deleting now.
3849 If the value is nil, don't make a backup.
3850 Uses `backup-directory-alist' in the same way as does
3851 `make-backup-file-name'."
3853 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3857 ;; We don't support numbered backups on plain MS-DOS
3858 ;; when long file names are unavailable.
3868 possibilities deserve-versions-p versions)
3871 base-versions
3874 possibilities)
3875 #'<)
3880 kept-old-versions
3881 kept-new-versions
3888 ;; Delete nothing if there is overflow
3889 ;; in the number of versions to keep.
3895 v))))))))))
3898 "Return number of names file FILENAME has."
3901 ;; (defun file-relative-name (filename &optional directory)
3902 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3903 ;; This function returns a relative file name which is equivalent to FILENAME
3904 ;; when used with that default directory as the default.
3905 ;; If this is impossible (which can happen on MSDOS and Windows
3906 ;; when the file name and directory use different drive names)
3907 ;; then it returns FILENAME."
3908 ;; (save-match-data
3909 ;; (let ((fname (expand-file-name filename)))
3910 ;; (setq directory (file-name-as-directory
3911 ;; (expand-file-name (or directory default-directory))))
3912 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3913 ;; ;; drive names, they can't be relative, so return the absolute name.
3914 ;; (if (and (or (eq system-type 'ms-dos)
3915 ;; (eq system-type 'cygwin)
3916 ;; (eq system-type 'windows-nt))
3917 ;; (not (string-equal (substring fname 0 2)
3918 ;; (substring directory 0 2))))
3919 ;; filename
3920 ;; (let ((ancestor ".")
3921 ;; (fname-dir (file-name-as-directory fname)))
3922 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3923 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3924 ;; (setq directory (file-name-directory (substring directory 0 -1))
3925 ;; ancestor (if (equal ancestor ".")
3926 ;; ".."
3927 ;; (concat "../" ancestor))))
3928 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3929 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3930 ;; ;; We matched within FNAME's directory part.
3931 ;; ;; Add the rest of FNAME onto ANCESTOR.
3932 ;; (let ((rest (substring fname (match-end 0))))
3933 ;; (if (and (equal ancestor ".")
3934 ;; (not (equal rest "")))
3935 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3936 ;; rest
3937 ;; (concat (file-name-as-directory ancestor) rest)))
3938 ;; ;; We matched FNAME's directory equivalent.
3939 ;; ancestor))))))
3942 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3943 This function returns a relative file name which is equivalent to FILENAME
3944 when used with that default directory as the default.
3945 If FILENAME and DIRECTORY lie on different machines or on different drives
3946 on a DOS/Windows machine, it returns FILENAME in expanded form."
3950 default-directory))))
3956 ;; Test for different drives on DOS/Windows
3958 ;; Should `cygwin' really be included here? --stef
3961 ;; Test for different remote file system identification
3963 filename
3969 directory nil nil case-fold-search))
3971 directory nil nil case-fold-search))))
3974 ".."
3976 ;; Now ancestor is empty, or .., or ../.., etc.
3978 directory nil nil case-fold-search))
3979 ;; We matched within FILENAME's directory part.
3980 ;; Add the rest of FILENAME onto ANCESTOR.
3983 ;; But don't bother with ANCESTOR if it would give us `./'.
3984 rest
3986 ;; We matched FILENAME's directory equivalent.
3987 ancestor))))))
3988 \f
3990 "Save current buffer in visited file if modified.
3991 Variations are described below.
3993 By default, makes the previous version into a backup file
3994 if previously requested or if this is the first save.
3996 to become a backup when the next save is done.
3998 unconditionally makes the previous version into a backup file.
4000 to become a backup when the next save is done,
4001 and unconditionally makes the previous version into a backup file.
4003 With a numeric argument of 0, never make the previous version
4004 into a backup file.
4006 If a file's name is FOO, the names of its numbered backup versions are
4007 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4008 Numeric backups (rather than FOO~) will be made if value of
4009 `version-control' is not the atom `never' and either there are already
4010 numeric versions of the file being backed up, or `version-control' is
4011 non-nil.
4012 We don't want excessive versions piling up, so there are variables
4013 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4014 and `kept-new-versions', which tells how many newest versions to keep.
4015 Defaults are 2 old versions and 2 new.
4016 `dired-kept-versions' controls dired's clean-directory (.) command.
4017 If `delete-old-versions' is nil, system will query user
4018 before trimming versions. Otherwise it does it silently.
4020 If `vc-make-backup-files' is nil, which is the default,
4021 no backup files are made for files managed by version control.
4022 (This is because the version control system itself records previous versions.)
4024 See the subroutine `basic-save-buffer' for more information."
4037 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4038 Normally delete only if the file was written by this Emacs since
4039 the last real save, but optional arg FORCE non-nil means delete anyway."
4053 "Normal hook that is run before a buffer is saved to its file."
4059 "Normal hook that is run after a buffer is saved to its file."
4065 "If non-nil, use this coding system for saving the buffer.
4066 More precisely, use this coding system in place of the
4067 value of `buffer-file-coding-system', when saving the buffer.
4068 Calling `write-region' for any purpose other than saving the buffer
4069 will still use `buffer-file-coding-system'; this variable has no effect
4076 "Save the current buffer in its visited file, if it has been modified.
4077 The hooks `write-contents-functions' and `write-file-functions' get a chance
4078 to do the job of saving; if they do not, then the buffer is saved in
4079 the visited file in the usual way.
4080 Before and after saving the buffer, this function runs
4081 `before-save-hook' and `after-save-hook', respectively."
4084 ;; In an indirect buffer, save its base buffer instead.
4089 setmodes)
4090 ;; If buffer has no file name, ask user for one.
4097 ;; Signal an error if the user specified the name of an
4098 ;; existing directory.
4101 filename))
4103 ;; Signal an error if the specified name refers to a
4104 ;; non-existing directory.
4134 ;; Support VC version backups.
4140 ;; If a hook returned t, file is already "written".
4141 ;; Otherwise, write it the usual way now.
4143 ;; Now we have saved the current buffer. Let's make sure
4144 ;; that buffer-file-coding-system is fixed to what
4145 ;; actually used for saving by binding it locally.
4155 ;; If the auto-save file was recent before this command,
4156 ;; delete it now.
4158 ;; Support VC `implicit' locking.
4163 ;; This does the "real job" of writing a buffer into its visited file
4164 ;; and making a backup file. This is what is normally done
4165 ;; but inhibited if one of write-file-functions returns non-nil.
4166 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4175 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4189 buffer-file-name)))
4203 ;; Write temp name, then rename it.
4204 ;; This requires write access to the containing dir,
4205 ;; which is why we don't try it if we don't have that access.
4207 tempname succeed
4210 ;; Create temp files with strict access rights. It's easy to
4211 ;; loosen them later, whereas it's impossible to close the
4212 ;; time-window of loose permissions otherwise.
4217 ;; Try various temporary names.
4218 ;; This code follows the example of make-temp-file,
4219 ;; but it calls write-region in the appropriate way
4220 ;; for saving the buffer.
4226 ;; Pass in nil&nil rather than point-min&max
4227 ;; cause we're saving the whole buffer.
4228 ;; write-region-annotate-functions may use it.
4230 tempname nil realname
4232 nil)
4234 ;; The file was somehow created by someone else between
4235 ;; `make-temp-name' and `write-region', let's try again.
4236 nil)
4238 ;; Reset the umask.
4240 ;; If we failed, restore the buffer's modtime.
4243 ;; Since we have created an entirely new file,
4244 ;; make sure it gets the right permission bits set.
4248 buffer-file-name)))
4249 ;; We succeeded in writing the temp file,
4250 ;; so rename it.
4252 ;; If file not writable, see if we can make it writable
4253 ;; temporarily while we write it.
4254 ;; But no need to do so if we have just backed it up
4255 ;; (setmodes is set) because that says we're superseding.
4257 ;; Change the mode back, after writing.
4263 ;; Pass in nil&nil rather than point-min&max to indicate
4264 ;; we're saving the buffer rather than just a region.
4265 ;; write-region-annotate-functions may make us of it.
4267 buffer-file-name nil t buffer-file-truename)
4269 ;; If we get an error writing the new file, and we made
4270 ;; the backup by renaming, undo the backing-up.
4275 setmodes))
4278 "View the differences between BUFFER and its associated file.
4279 This requires the external program `diff' to be in your `exec-path'."
4293 ;; Display that message for 1 second so that user can read it
4294 ;; in the minibuffer.
4296 ;; return always nil, so that save-buffers-kill-emacs will not move
4297 ;; over to the next unsaved buffer when calling `d'.
4298 nil)
4301 `((?\C-r
4308 ;; Return nil to ask about BUF again.
4309 nil)
4321 ;; Return nil to ask about BUF again.
4322 nil)
4331 "Save some modified file-visiting buffers. Asks user about each one.
4332 You can answer `y' to save, `n' not to save, `C-r' to look at the
4333 buffer in question with `view-buffer' before deciding or `d' to
4334 view the differences using `diff-buffer-with-file'.
4336 Optional argument (the prefix) non-nil means save all with no questions.
4337 Optional second argument PRED determines which buffers are considered:
4338 If PRED is nil, all the file-visiting buffers are considered.
4339 If PRED is t, then certain non-file buffers will also be considered.
4340 If PRED is a zero-argument function, it indicates for each buffer whether
4341 to consider it or not when called with that buffer current.
4343 See `save-some-buffers-action-alist' if you want to
4344 change the additional actions you can take on files."
4348 files-done abbrevs-done)
4350 ;; First save any buffers that we're supposed to save unconditionally.
4351 ;; That way the following code won't ask about them.
4356 ;; Ask about those buffers that merit it,
4357 ;; and record the number thus saved.
4361 ;; Note that killing some buffers may kill others via
4362 ;; hooks (e.g. Rmail and its viewing buffer).
4375 t
4387 save-some-buffers-action-alist))
4388 ;; Maybe to save abbrevs, and record whether
4389 ;; we either saved them or asked to.
4395 abbrev-file-name)))
4397 ;; Don't keep bothering user if he says no.
4402 "(Some special files were saved without asking)"
4404 \f
4406 "Mark current buffer as unmodified, not needing to be saved.
4409 It is not a good idea to use this function in Lisp programs, because it
4410 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4417 "Change whether this buffer is read-only.
4418 With prefix argument ARG, make the buffer read-only if ARG is
4419 positive, otherwise make it writable. If buffer is read-only
4420 and `view-read-only' is non-nil, enter view mode."
4425 nil ; do nothing.
4426 ;; Toggle.
4433 ;; If view-mode is already active, `view-mode-enter' is a nop.
4445 "Insert contents of file FILENAME into buffer after point.
4446 Set mark after the inserted text.
4448 This function is meant for the user to run interactively.
4449 Don't call it from programs! Use `insert-file-contents' instead.
4450 \(Its calling sequence is different; see its documentation)."
4455 "Append the contents of the region to the end of file FILENAME.
4456 When called from a function, expects three arguments,
4457 START, END and FILENAME. START and END are buffer positions
4458 saying what text to write."
4463 "Return most recent backup file for FILENAME or nil if no backups exist."
4464 ;; `make-backup-file-name' will get us the right directory for
4465 ;; ordinary or numeric backups. It might create a directory for
4466 ;; backups as a side-effect, according to `backup-directory-alist'.
4473 tem)
4482 newest))
4485 "Rename current buffer to a similar name not already taken.
4486 This function is useful for creating multiple shell process buffers
4487 or multiple mail buffers, etc."
4495 ;; If the existing buffer name has a <NNN>,
4496 ;; which isn't part of the file name (if any),
4497 ;; then get rid of that.
4503 "Create the directory DIR and any nonexistent parent dirs.
4504 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4506 Interactively, the default choice of directory to create
4507 is the current default directory for file names.
4508 That is useful when you have visited a file in a nonexistent directory.
4510 Noninteractively, the second (optional) argument PARENTS says whether
4511 to create parent directories if they don't exist. Interactively,
4512 this happens by default."
4515 nil nil)
4516 t))
4517 ;; If default-directory is a remote directory,
4518 ;; make sure we find its make-directory handler.
4526 create-list)
4533 \f
4536 "Function to use to revert this buffer, or nil to do the default.
4537 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4542 "Function to use to insert contents when reverting this buffer.
4543 Gets two args, first the nominal file name to use,
4544 and second, t if reading the auto-save file.
4549 "Function to check whether a non-file buffer needs reverting.
4550 This should be a function with one optional argument NOCONFIRM.
4551 Auto Revert Mode passes t for NOCONFIRM. The function should return
4552 non-nil if the buffer should be reverted. A return value of
4553 `fast' means that the need for reverting was not checked, but
4554 that reverting the buffer is fast. The buffer is current when
4555 this function is called.
4557 The idea behind the NOCONFIRM argument is that it should be
4558 non-nil if the buffer is going to be reverted without asking the
4559 user. In such situations, one has to be careful with potentially
4560 time consuming operations.
4562 For more information on how this variable is used by Auto Revert mode,
4566 "Normal hook for `revert-buffer' to run before reverting.
4567 If `revert-buffer-function' is used to override the normal revert
4571 "Normal hook for `revert-buffer' to run after reverting.
4572 Note that the hook value that it runs is the value that was in effect
4573 before reverting; that makes a difference if you have buffer-local
4574 hook functions.
4576 If `revert-buffer-function' is used to override the normal revert
4582 "Replace current buffer text with the text of the visited file on disk.
4583 This undoes all changes since the file was visited or saved.
4584 With a prefix argument, offer to revert from latest auto-save file, if
4585 that is more recent than the visited file.
4587 This command also implements an interface for special buffers
4588 that contain text which doesn't come from a file, but reflects
4589 some other data instead (e.g. Dired buffers, `buffer-list'
4590 buffers). This is done via the variable `revert-buffer-function'.
4591 In these cases, it should reconstruct the buffer contents from the
4592 appropriate data.
4594 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4595 to revert from the auto-save file when this is nil. Note that the
4596 sense of this argument is the reverse of the prefix argument, for the
4597 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4598 to nil.
4600 Optional second argument NOCONFIRM means don't ask for confirmation
4601 at all. \(The variable `revert-without-query' offers another way to
4602 revert buffers without querying for confirmation.)
4604 Optional third argument PRESERVE-MODES non-nil means don't alter
4605 the files modes. Normally we reinitialize them using `normal-mode'.
4607 If the value of `revert-buffer-function' is non-nil, it is called to
4608 do all the work for this command. Otherwise, the hooks
4609 `before-revert-hook' and `after-revert-hook' are run at the beginning
4610 and the end, and if `revert-buffer-insert-file-contents-function' is
4611 non-nil, it is called instead of rereading visited file contents."
4613 ;; I admit it's odd to reverse the sense of the prefix argument, but
4614 ;; there is a lot of code out there which assumes that the first
4615 ;; argument should be t to avoid consulting the auto-save file, and
4616 ;; there's no straightforward way to encourage authors to notice a
4617 ;; reversal of the argument sense. So I'm just changing the user
4618 ;; interface, but leaving the programmatic interface the same.
4626 buffer-auto-save-file-name
4631 buffer-auto-save-file-name
4632 buffer-file-name)))
4642 file-name)))
4644 ;; If file was backed up but has changed since,
4645 ;; we shd make another backup.
4649 ;; Effectively copy the after-revert-hook status,
4650 ;; since after-find-file will clobber it.
4653 after-revert-hook))
4658 ;; Get rid of all undo records for this buffer.
4660 ;; Don't make undo records for the reversion.
4663 file-name auto-save-p)))
4666 "File %s no longer exists!"
4668 file-name))
4671 "File %s no longer readable!"
4673 file-name))
4675 ;; Bind buffer-file-name to nil
4676 ;; so that we don't try to lock the file.
4682 ;; Auto-saved file should be read by Emacs'
4683 ;; internal coding.
4686 buffer-file-coding-system-explicit))))
4688 coding-system-for-read
4690 coding-system-for-read)
4692 ;; As a coding system suitable for multibyte
4693 ;; buffer is specified, make the current
4694 ;; buffer multibyte.
4697 ;; This force after-insert-file-set-coding
4698 ;; (called from insert-file-contents) to set
4699 ;; buffer-file-coding-system to a proper value.
4702 ;; Note that this preserves point in an intelligent way.
4706 nil nil t))
4708 nil nil t)))))
4709 ;; Recompute the truename in case changes in symlinks
4710 ;; have changed the truename.
4714 ;; Run after-revert-hook as it was before we reverted.
4718 local-hook)
4721 t))))))
4724 "Recover the visited file--get contents from its last auto-save file."
4729 "Visit file FILE, but get contents from its last auto-save file."
4730 ;; Actually putting the file name in the minibuffer should be used
4731 ;; only rarely.
4732 ;; Not just because users often use the default.
4752 ;; Use insert-directory-safely, not insert-directory,
4753 ;; because these files might not exist. In particular,
4754 ;; FILE might not exist if the auto-save file was for
4755 ;; a buffer that didn't visit a file, such as "*mail*".
4756 ;; The code in v20.x called `ls' directly, so we need
4757 ;; to emulate what `ls' did in that case.
4763 ;; Keep the current buffer-file-coding-system.
4765 ;; Auto-saved file should be read with special coding.
4774 "Recover auto save files from a previous Emacs session.
4775 This command first displays a Dired buffer showing you the
4776 previous sessions that you could recover from.
4777 To choose one, move point to the proper line and then type C-c C-c.
4778 Then you'll be asked about a number of files to recover."
4788 auto-save-list-file-prefix)))
4789 t)
4798 ;; Each line starts with a space
4799 ;; so that Font Lock mode won't highlight the first character.
4808 "Choose one saved session to recover auto-save files from.
4809 This command is used in the special Dired buffer created by
4812 ;; Get the name of the session file to recover from.
4814 files
4820 ;; Read in the auto-save-list file.
4824 ;; Loop thru the text of that file
4825 ;; and get out the names of the files to recover.
4829 ;; This is a pair of lines for a non-file-visiting buffer.
4830 ;; Get the auto-save file name and manufacture
4831 ;; a "visited file name" from that.
4834 ;; If there is no auto-save file name, the
4835 ;; auto-save-list file is probably corrupted.
4848 ;; This pair of lines is a file-visiting
4849 ;; buffer. Use the visited file name.
4859 ;; Ignore a file if its auto-save file does not exist now.
4863 ;; The file contains a pair of line for each auto-saved buffer.
4864 ;; The first line of the pair contains the visited file name
4865 ;; or is empty if the buffer was not visiting a file.
4866 ;; The second line is the auto-save file name.
4874 files
4880 "Kill BUFFER if confirmed."
4888 "Kill some buffers. Asks the user whether to kill each one of them.
4889 Non-interactively, if optional argument LIST is non-nil, it
4890 specifies the list of buffers to kill, asking for approval for each one."
4898 ; if we killed the base buffer.
4905 "Kill buffers whose name matches the specified REGEXP.
4906 The optional second argument indicates whether to kill internal buffers too."
4915 \f
4917 "Toggle auto-saving of contents of current buffer.
4918 With prefix argument ARG, turn auto-saving on if positive, else off."
4923 ;; If auto-save is off because buffer has shrunk,
4924 ;; then toggling should turn it on.
4929 buffer-file-name
4931 ;; If -1 was stored here, to temporarily turn off saving,
4932 ;; turn it back on.
4938 buffer-auto-save-file-name)
4941 "Adjust current buffer's auto save file name for current conditions.
4942 Also rename any existing auto save file, if it was made in this session."
4954 "Return file name to use for auto-saves of current buffer.
4955 Does not consider `auto-save-visited-file-name' as that variable is checked
4956 before calling this function. You can redefine this for customization.
4957 See also `auto-save-file-name-p'."
4965 result uniq)
4966 ;; Apply user-specified translations
4967 ;; to the file name.
4971 filename)
4981 filename))))
4986 ;; We truncate the file name to DOS 8+3 limits
4987 ;; before doing anything else, because the regexp
4988 ;; passed to string-match below cannot handle
4989 ;; extensions longer than 3 characters, multiple
4990 ;; dots, and other atrocities.
4995 fn)
5000 "#"
5003 ;; Make sure auto-save file names don't contain characters
5004 ;; invalid for the underlying filesystem.
5006 ;; Don't modify remote (ange-ftp) filenames
5009 result))))
5011 ;; Deal with buffers that don't have any associated files. (Mail
5012 ;; mode tends to create a good number of these.)
5016 file-name)
5017 ;; Restrict the characters used in the file name to those which
5018 ;; are known to be safe on all filesystems, url-encoding the
5019 ;; rest.
5020 ;; We do this on all platforms, because even if we are not
5021 ;; running on DOS/Windows, the current directory may be on a
5022 ;; mounted VFAT filesystem, such as a USB memory stick.
5026 ;; For multibyte characters, this will produce more than
5027 ;; 2 hex digits, so is not true URL encoding.
5031 ;; Generate the file name.
5037 ;; Try a few alternative directories, to get one we can
5038 ;; write it.
5044 ;; Don't modify remote (ange-ftp) filenames
5046 ;; The call to convert-standard-filename is in case
5047 ;; buffer-name includes characters not allowed by the
5048 ;; DOS/Windows filesystems. make-temp-file writes to the
5049 ;; file it creates, so we must fix the file name _before_
5050 ;; make-temp-file is called.
5052 fname))
5054 ;; make-temp-file creates the file,
5055 ;; but we don't want it to exist until we do an auto-save.
5059 file-name)))
5062 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5063 FILENAME should lack slashes. You can redefine this for customization."
5065 \f
5067 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5068 The generated regexp will match a filename only if the filename
5069 matches that wildcard according to shell rules. Only wildcards known
5070 by `sh' are supported."
5072 ;; Copy the initial run of non-special characters.
5075 ;; If no special characters, we're almost done.
5079 j)
5081 result
5102 ;; Found "[^". Insert a `\0' character
5103 ;; (which cannot happen in a filename)
5104 ;; into the character class, so that `^'
5105 ;; is not the first character after `[',
5106 ;; and thus non-special in a regexp.
5111 ;; I don't think `]' can appear in a
5112 ;; character class in a wildcard, but
5113 ;; let's be general here.
5120 i
5133 ;; Shell wildcards should match the entire filename,
5134 ;; not its part. Make the regexp say so.
5136 \f
5138 "-CF"
5139 "Switches for `list-directory' to pass to `ls' for brief listing."
5144 "-l"
5145 "Switches for `list-directory' to pass to `ls' for verbose listing."
5150 "Expand wildcard pattern PATTERN.
5151 This returns a list of file names which match the pattern.
5153 If PATTERN is written as an absolute file name,
5154 the values are absolute also.
5156 If PATTERN is written as a relative file name, it is interpreted
5157 relative to the current default directory, `default-directory'.
5158 The file names returned are normally also relative to the current
5159 default directory. However, if FULL is non-nil, they are absolute."
5163 ;; A list of all dirs that DIRPART specifies.
5164 ;; This can be more than one dir
5165 ;; if DIRPART contains wildcards.
5170 contents)
5175 ;; Filter out "." and ".."
5180 name))
5187 this-dir-contents)
5188 this-dir-contents)
5189 contents))))
5191 contents)))
5194 "Display a list of files in or matching DIRNAME, a la `ls'.
5195 DIRNAME is globbed by the shell if necessary.
5196 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5197 Actions controlled by variables `list-directory-brief-switches'
5198 and `list-directory-verbose-switches'."
5202 nil default-directory nil)
5203 pfx)))
5205 list-directory-brief-switches))
5206 buffer)
5219 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5227 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5229 PATTERN is assumed to represent a file-name wildcard suitable for the
5230 underlying filesystem. For Unix and GNU/Linux, the characters from the
5232 the parts of the pattern which don't include wildcard characters are
5233 quoted with double quotes.
5234 Existing quote characters in PATTERN are left alone, so you can pass
5235 PATTERN that already quotes some of the special characters."
5239 ;; DOS/Windows don't allow `"' in file names. So if the
5240 ;; argument has quotes, we can safely assume it is already
5241 ;; quoted by the caller.
5243 ;; We quote [&()#$'] in case their shell is a port of a
5244 ;; Unixy shell. We quote [,=+] because stock DOS and
5245 ;; Windows shells require that in some cases, such as
5246 ;; passing arguments to batch files that use positional
5247 ;; arguments like %1.
5249 pattern
5252 end)
5269 pattern))))
5276 "Program to get the amount of free space on a file system.
5277 We assume the output has the format of `df'.
5278 The value of this variable must be just a command name or file name;
5279 if you want to specify options, use `directory-free-space-args'.
5281 A value of nil disables this feature.
5283 If the function `file-system-info' is defined, it is always used in
5284 preference to the program given by this variable."
5290 "Options to use when running `directory-free-space-program'."
5295 "Return the amount of free space on directory DIR's file system.
5296 The result is a string that gives the number of free 1KB blocks,
5297 or nil if the system call or the program which retrieve the information
5298 fail. It returns also nil when DIR is a remote directory.
5300 This function calls `file-system-info' if it is available, or invokes the
5301 program specified by `directory-free-space-program' if that is non-nil."
5303 ;; Try to find the number of free blocks. Non-Posix systems don't
5304 ;; always have df, but might have an equivalent system call.
5313 nil t nil
5314 directory-free-space-args
5315 dir)))
5316 ;; Usual format is a header line followed by a line of
5317 ;; numbers.
5322 ;; Move to the end of the "available blocks" number.
5325 ;; Copy it into AVAILABLE.
5330 ;; The following expression replaces `dired-move-to-filename-regexp'.
5334 ;; In some locales, month abbreviations are as short as 2 letters,
5335 ;; and they can be followed by ".".
5336 ;; In Breton, a month name can include a quote character.
5349 s "+"
5352 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5353 ;; omits the Kanji characters after month and day-of-month.
5354 ;; On Mac OS X 10.3, the date format in East Asian locales is
5355 ;; day-of-month digits followed by month digits.
5361 ;; The "[0-9]" below requires the previous column to end in a digit.
5362 ;; This avoids recognizing `1 may 1997' as a date in the line:
5363 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5365 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5366 ;; The ".*" below finds the last match if there are multiple matches.
5367 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5368 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5370 ;; vc dired listings provide the state or blanks between file
5371 ;; permissions and date. The state is always surrounded by
5372 ;; parantheses:
5373 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5374 ;; This is not supported yet.
5378 "Regular expression to match up to the file name in a directory listing.
5379 The default value is designed to recognize dates and times
5384 ;; insert-directory
5385 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5386 ;; FULL-DIRECTORY-P is nil.
5387 ;; The single line of output must display FILE's name as it was
5388 ;; given, namely, an absolute path name.
5389 ;; - must insert exactly one line for each file if WILDCARD or
5390 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5391 ;; before the file lines, plus optional text after the file lines.
5392 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5393 ;; allowed.
5394 ;; File lines should display the basename.
5395 ;; - must be consistent with
5396 ;; - functions dired-move-to-filename, (these two define what a file line is)
5397 ;; dired-move-to-end-of-filename,
5398 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5399 ;; dired-insert-headerline
5400 ;; dired-after-subdir-garbage (defines what a "total" line is)
5401 ;; - variable dired-subdir-regexp
5402 ;; - may be passed "--dired" as the first argument in SWITCHES.
5403 ;; Filename handlers might have to remove this switch if their
5404 ;; "ls" command does not support it.
5406 "Insert directory listing for FILE, formatted according to SWITCHES.
5407 Leaves point after the inserted text.
5408 SWITCHES may be a string of options, or a list of strings
5409 representing individual options.
5410 Optional third arg WILDCARD means treat FILE as shell wildcard.
5411 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5412 switches do not contain `d', so that a full listing is expected.
5414 This works by running a directory listing program
5415 whose name is in the variable `insert-directory-program'.
5416 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5418 When SWITCHES contains the long `--dired' option, this function
5419 treats it specially, for the sake of dired. However, the
5420 normally equivalent short `-D' option is just passed on to
5421 `insert-directory-program', as any other option."
5422 ;; We need the directory in order to find the right handler.
5427 wildcard full-directory-p)
5430 ;; Read the actual directory using `insert-directory-program'.
5431 ;; RESULT gets the status code.
5433 ;; putting text property `dired-filename, decode one
5434 ;; bunch by one to preserve that property.
5436 ;; This is to control encoding the arguments in call-process.
5440 default-file-name-coding-system))))
5443 ;; Run ls in the directory part of the file pattern
5444 ;; using the last component as argument.
5451 shell-file-name nil t nil
5452 "-c"
5454 ""
5456 insert-directory-program
5457 " -d "
5459 switches
5461 " -- "
5462 ;; Quote some characters that have
5463 ;; special meanings in shells; but
5464 ;; don't quote the wildcards--we want
5465 ;; them to be special. We also
5466 ;; currently don't quote the quoting
5467 ;; characters in case people want to
5468 ;; use them explicitly to quote
5469 ;; wildcard characters.
5471 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5472 ;; directory if FILE is a symbolic link.
5474 insert-directory-program nil t nil
5478 ;; Split the switches at any spaces so we can
5479 ;; pass separate options as separate args.
5481 ;; Avoid lossage if FILE starts with `-'.
5489 file))))))))
5491 ;; If we got "//DIRED//" in the output, it means we got a real
5492 ;; directory listing, even if `ls' returned nonzero.
5493 ;; So ignore any errors.
5506 ;; The first time ls returns an error,
5507 ;; find the version numbers of ls,
5508 ;; and set insert-directory-ls-version
5509 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5510 ;; is equal or if the info cannot be obtained.
5511 ;; (That can mean it isn't GNU ls.)
5521 comparison)
5537 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5541 ;; If `insert-directory-program' failed, signal an error.
5543 ;; Delete the error message it may have output.
5545 ;; On non-Posix systems, we cannot open a directory, so
5546 ;; don't even try, because that will always result in
5547 ;; the ubiquitous "Access denied". Instead, show the
5548 ;; command line so the user can try to guess what went wrong.
5553 insert-directory-program
5555 file result)
5556 ;; Unix. Access the file to get a suitable error.
5563 ;; The following overshoots by one line for an empty
5564 ;; directory listed with "--dired", but without "-a"
5565 ;; switch, where the ls output contains a
5566 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5567 ;; We take care of that case later.
5575 error-lines)
5576 ;; Find all the lines that are error messages,
5577 ;; and record the bounds of each one.
5584 ;; Now read the numeric positions of file names.
5591 error-lines))
5594 error-lines)))
5596 ;; End is followed by \n or by " -> ".
5598 ;; It seems that we can't trust ls's output as to
5599 ;; byte positions of filenames.
5605 ;; Take care of the case where the ls output contains a
5606 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5607 ;; and we went one line too far back (see above).
5612 ;; Now decode what read if necessary.
5614 file-name-coding-system
5615 default-file-name-coding-system
5617 coding-no-eol
5618 val pos)
5622 ;; If no coding system is specified or detection is
5623 ;; requested, detect the coding.
5637 ;; Force no eol conversion on a file name, so
5638 ;; that CR is preserved.
5646 ;; Try to insert the amount of free space.
5649 ;; First find the line to put it on.
5653 ;; Replace "total" with "used", to avoid confusion.
5659 "Convert `ls --dired' file name position value POS to a buffer position.
5660 File name position values returned in ls --dired output
5661 count only stdout; they don't count the error messages sent to stderr.
5662 So this function converts to them to real buffer positions.
5663 ERROR-LINES is a list of buffer positions of error message lines,
5664 of the form (START END)."
5668 pos)
5672 "Insert directory listing for FILE, formatted according to SWITCHES.
5674 Like `insert-directory', but if FILE does not exist, it inserts a
5675 message to that effect instead of signaling an error."
5678 ;; Simulate the message printed by `ls'.
5682 "Functions to call with no arguments to query about killing Emacs.
5683 If any of these functions returns nil, killing Emacs is cancelled.
5684 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5688 "How to ask for confirmation when leaving Emacs.
5689 If nil, the default, don't ask at all. If the value is non-nil, it should
5690 be a predicate function such as `yes-or-no-p'."
5698 "Offer to save each buffer, then kill this Emacs process.
5699 With prefix ARG, silently save all file-visiting buffers, then kill."
5708 ;; process-list is not defined on MSDOS.
5710 active)
5719 ;; Query the user for other things, perhaps.
5726 "Offer to save each buffer, then kill the current connection.
5727 If the current frame has no client, kill Emacs itself.
5729 With prefix ARG, silently save all file-visiting buffers, then kill.
5731 If emacsclient was started with a list of filenames to edit, then
5732 only these files will be asked to be saved."
5740 \f
5741 ;; We use /: as a prefix to "quote" a file name
5742 ;; so that magic file name handlers will not apply to it.
5746 file-name-handler-alist))
5748 ;; We depend on being the last handler on the list,
5749 ;; so that anything else which does need handling
5750 ;; has been handled already.
5751 ;; So it is safe for us to inhibit *all* magic file name handlers.
5760 default-directory))
5761 ;; Get a list of the indices of the args which are file names.
5764 ;; The first six are special because they
5765 ;; return a file name. We want to include the /:
5766 ;; in the return value.
5767 ;; So just avoid stripping it in the first place.
5774 ;; `identity' means just return the first arg
5775 ;; not stripped of its quoting.
5777 ;; `add' means add "/:" to the result.
5779 ;; `quote' means add "/:" to buffer-file-name.
5781 ;; `unquote-then-quote' means set buffer-file-name
5782 ;; temporarily to unquoted filename.
5784 ;; List the arguments which are filenames.
5792 ;; For all other operations, treat the first argument only
5793 ;; as the file name.
5795 method
5796 ;; Copy ARGUMENTS so we can replace elements in it.
5800 ;; Strip off the /: from the file names that have it.
5808 "/"
5824 res))
5827 \f
5828 ;; Symbolic modes and read-file-modes.
5831 "Convert CHAR to a numeric bit-mask for extracting mode bits.
5832 CHAR is in [ugoa] and represents the category of users (Owner, Group,
5833 Others, or All) for whom to produce the mask.
5834 The bit-mask that is returned extracts from mode bits the access rights
5835 for the specified category of users."
5843 "Convert CHAR to a numeric value of mode bits.
5844 CHAR is in [rwxXstugo] and represents symbolic access permissions.
5845 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
5852 ;; Rights relative to the previous file modes.
5863 "Convert a symbolic mode string specification to an equivalent number.
5865 WHO-MASK is the bit-mask specifying the category of users to which to
5866 apply the access permissions. See `file-modes-char-to-who'.
5867 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5868 RIGHTS request to add, remove, or set permissions based on existing ones,
5875 char-right)
5882 num-rights
5886 op char-right)))
5887 num-rights))
5890 "Convert symbolic file modes to numeric file modes.
5891 MODES is the string to convert, it should match
5894 notation.
5895 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5896 MODES request to add, remove, or set permissions based on existing ones,
5910 num-who num-modes)
5913 num-modes)))
5916 "Read file modes in octal or symbolic notation and return its numeric value.
5917 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5918 ORIG-FILE is the name of a file on whose mode bits to base returned
5919 permissions if what user types requests to add, remove, or set permissions
5935 nil nil default)))
5941 \f
5942 ;; Trashcan handling.
5944 "Directory for `move-file-to-trash' to move files and directories to.
5945 This directory is only used when the function `system-move-file-to-trash' is
5946 not defined. Relative paths are interpreted relative to `default-directory'.
5947 See also `delete-by-moving-to-trash'."
5955 "Move file (or directory) name FILENAME to the trash.
5956 This function is called by `delete-file' and `delete-directory' when
5957 `delete-by-moving-to-trash' is non-nil. On platforms that define
5958 `system-move-file-to-trash', that function is used to move FILENAME to the
5959 system trash, otherwise FILENAME is moved to `trash-directory'.
5960 Returns nil on success."
5973 ;; make new-fn unique.
5974 ;; example: "~/.Trash/abc.txt" -> "~/.Trash/abc.txt.~1~"
5978 ;; stop processing if fn is same or parent directory of trash-dir.
5981 filename))
5985 \f
6010 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6011 ;;; files.el ends here