| blob | ac058efde084a116938b5c53eda6fee508a38cd6 |
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, 2009 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:
37 "Backups of edited data files."
41 "Finding files."
46 "Non-nil means delete auto-save file when a buffer is saved or killed.
48 Note that the auto-save file will not be deleted if the buffer is killed
49 when it has unsaved changes."
54 nil
55 "Alist of abbreviations for file directories.
56 A list of elements of the form (FROM . TO), each meaning to replace
57 FROM with TO when it appears in a directory name. This replacement is
58 done when setting up the default directory of a newly visited file.
59 *Every* FROM string should start with `^'.
61 FROM and TO should be equivalent names, which refer to the
62 same directory. Do not use `~' in the TO strings;
63 they should be ordinary absolute directory names.
65 Use this feature when you have directories which you normally refer to
66 via absolute symbolic links. Make TO the name of the link, and FROM
67 the name it is linked to."
76 "Non-nil means make a backup of a file the first time it is saved.
77 This can be done by renaming the file or by copying.
79 Renaming means that Emacs renames the existing file so that it is a
80 backup file, then writes the buffer into a new file. Any other names
81 that the old file had will now refer to the backup file. The new file
82 is owned by you and its group is defaulted.
84 Copying means that Emacs copies the existing file into the backup
85 file, then writes the buffer on top of the existing file. Any other
86 names that the old file had will now refer to the new (edited) file.
87 The file's owner and group are unchanged.
89 The choice of renaming or copying is controlled by the variables
90 `backup-by-copying', `backup-by-copying-when-linked',
91 `backup-by-copying-when-mismatch' and
92 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
96 ;; Do this so that local variables based on the file name
97 ;; are not overridden by the major mode.
99 "Non-nil means don't make a backup, regardless of the other parameters.
100 This variable is intended for use by making it local to a buffer.
105 "Non-nil means always use copying to create backup files.
106 See documentation of variable `make-backup-files'."
111 "Non-nil means use copying to create backups for files with multiple names.
112 This causes the alternate names to refer to the latest version as edited.
113 This variable is relevant only if `backup-by-copying' is nil."
118 "Non-nil means create backups by copying if this preserves owner or group.
119 Renaming may still be used (subject to control of other variables)
120 when it would not result in changing the owner or group of the file;
121 that is, for files which are owned by you and whose group matches
122 the default for a new file created there by you.
123 This variable is relevant only if `backup-by-copying' is nil."
128 "Non-nil means create backups by copying to preserve a privileged owner.
129 Renaming may still be used (subject to control of other variables)
130 when it would not result in changing the owner of the file or if the owner
131 has a user id greater than the value of this variable. This is useful
132 when low-numbered uid's are used for special system users (such as root)
133 that must maintain ownership of certain files.
134 This variable is relevant only if `backup-by-copying' and
135 `backup-by-copying-when-mismatch' are nil."
140 "Predicate that looks at a file name and decides whether to make backups.
144 "Non-nil in a buffer means always offer to save buffer on exit.
145 Do so even if the buffer is not visiting a file.
146 Automatically local in all buffers."
152 "Non-nil means find a file under alternative names, in existing buffers.
153 This means if any existing buffer is visiting the file you want
154 under another name, you get the existing buffer instead of a new buffer."
159 "Non-nil means visit a file under its truename.
160 The truename of a file is found by chasing all links
161 both at the file level and at the levels of the containing directories."
167 "Specify which files should be reverted without query.
168 The value is a list of regular expressions.
169 If the file name matches one of these regular expressions,
170 then `revert-buffer' reverts the file without querying
171 if the file has changed on disk and you have not edited the buffer."
176 "The device number and file number of the file visited in the current buffer.
177 The value is a list of the form (FILENUM DEVNUM).
178 This pair of numbers uniquely identifies the file.
196 "The directory for writing temporary files."
203 "The directory for writing small temporary files.
204 If non-nil, this directory is used instead of `temporary-file-directory'
205 by programs that create small temporary files. This is for systems that
206 have fast storage with limited space, such as a RAM disk."
211 ;; The system null device. (Should reference NULL_DEVICE from C.)
237 "Non-nil means protect against I/O errors while saving files.
238 Some modes set this non-nil in particular buffers.
240 This feature works by writing the new contents into a temporary file
241 and then renaming the temporary file to replace the original.
242 In this way, any I/O error in writing leaves the original untouched,
243 and there is never any instant where the file is nonexistent.
245 Note that this feature forces backups to be made by copying.
246 Yet, at the same time, saving a precious file
247 breaks any hard links between it and other files.
249 This feature is advisory: for example, if the directory in which the
250 file is being saved is not writable, Emacs may ignore a non-nil value
251 of `file-precious-flag' and write directly into the file.
253 See also: `break-hardlink-on-save'."
258 "Non-nil means when saving a file that exists under several names
259 \(i.e., has multiple hardlinks), break the hardlink associated with
260 `buffer-file-name' and write to a new file, so that the other
261 instances of the file are not affected by the save.
263 If `buffer-file-name' refers to a symlink, do not break the symlink.
265 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
266 For example, if the directory in which a file is being saved is not
267 itself writable, then error instead of saving in some
268 hardlink-nonbreaking way.
270 See also `backup-by-copying' and `backup-by-copying-when-linked'."
276 "Control use of version numbers for backup files.
277 When t, make numeric backup versions unconditionally.
278 When nil, make them for files that have some already.
279 The value `never' means do not make them."
289 "When cleaning directory, number of versions to keep."
295 "If t, delete excess backup versions silently.
296 If nil, ask confirmation. Any other value prevents any trimming."
303 "Number of oldest versions to keep when a new numbered backup is made."
309 "Number of newest versions to keep when a new numbered backup is made.
310 Includes the new backup. Must be > 0"
316 "Whether to add a newline automatically at the end of the file.
318 A value of t means do this only when the file is about to be saved.
319 A value of `visit' means do this right after the file is visited.
320 A value of `visit-save' means do it at both of those times.
321 Any other non-nil value means ask user whether to add a newline, when saving.
322 A value of nil means don't add newlines.
324 Certain major modes set this locally to the value obtained
325 from `mode-require-final-newline'."
334 "Whether to add a newline at end of file, in certain major modes.
335 Those modes set `require-final-newline' to this value when you enable them.
336 They do so because they are often used for files that are supposed
337 to end in newlines, and the question is how to arrange that.
339 A value of t means do this only when the file is about to be saved.
340 A value of `visit' means do this right after the file is visited.
341 A value of `visit-save' means do it at both of those times.
342 Any other non-nil value means ask user whether to add a newline, when saving.
344 A value of nil means do not add newlines. That is a risky choice in this
345 variable since this value is used for modes for files that ought to have
346 final newlines. So if you set this to nil, you must explicitly check and
347 add a final newline, whenever you save a file that really needs one."
357 "Non-nil says by default do auto-saving of every file-visiting buffer."
363 ;; Don't put "\\2" inside expand-file-name, since it will be
364 ;; transformed to "/2" on DOS/Windows.
366 "Transforms to apply to buffer file name before making auto-save file name.
367 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
368 REGEXP is a regular expression to match against the file name.
369 If it matches, `replace-match' is used to replace the
370 matching part with REPLACEMENT.
371 If the optional element UNIQUIFY is non-nil, the auto-save file name is
372 constructed by taking the directory part of the replaced file-name,
373 concatenated with the buffer file name with all directory separators
374 changed to `!' to prevent clashes. This will not work
375 correctly if your filesystem truncates the resulting name.
377 All the transforms in the list are tried, in the order they are listed.
378 When one transform applies, its result is final;
379 no further transforms are tried.
381 The default value is set up to put the auto-save file into the
382 temporary directory (see the variable `temporary-file-directory') for
383 editing a remote file.
385 On MS-DOS filesystems without long names this variable is always
386 ignored."
394 "Non-nil means save word abbrevs too when files are saved.
395 If `silently', don't ask the user before saving."
400 "Non-nil means allow `find-file' to visit directories.
401 To visit the directory, `find-file' runs `find-directory-functions'."
406 "List of functions to try in sequence to visit a directory.
407 Each function is called with the directory name as the sole argument
408 and should return either a buffer or nil."
412 ;;;It is not useful to make this a local variable.
413 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
415 "List of functions to be called for `find-file' on nonexistent file.
416 These functions are called as soon as the error is detected.
417 Variable `buffer-file-name' is already set up.
422 ;;;It is not useful to make this a local variable.
423 ;;;(put 'find-file-hooks 'permanent-local t)
426 "List of functions to be called after a buffer is loaded from a file.
427 The buffer's local variables (if any) will have been processed before the
428 functions are called."
435 "List of functions to be called before writing out a buffer to a file.
436 If one of them returns non-nil, the file is considered already written
437 and the rest are not called.
438 These hooks are considered to pertain to the visited file.
439 So any buffer-local binding of this variable is discarded if you change
441 change the major mode.
443 This hook is not run if any of the functions in
444 `write-contents-functions' returns non-nil. Both hooks pertain
445 to how to save a buffer to file, for instance, choosing a suitable
446 coding system and setting mode bits. (See Info
447 node `(elisp)Saving Buffers'.) To perform various checks or
458 "List of functions to be called before writing out a buffer to a file.
459 If one of them returns non-nil, the file is considered already written
460 and the rest are not called and neither are the functions in
461 `write-file-functions'.
463 This variable is meant to be used for hooks that pertain to the
464 buffer's contents, not to the particular visited file; thus,
465 `set-visited-file-name' does not clear this variable; but changing the
466 major mode does clear it.
468 For hooks that _do_ pertain to the particular visited file, use
469 `write-file-functions'. Both this variable and
470 `write-file-functions' relate to how a buffer is saved to file.
471 To perform various checks or updates before the buffer is saved,
478 "Control use of local variables in files you visit.
479 The value can be t, nil, :safe, :all, or something else.
481 A value of t means file local variables specifications are obeyed
482 if all the specified variable values are safe; if any values are
483 not safe, Emacs queries you, once, whether to set them all.
484 \(When you say yes to certain values, they are remembered as safe.)
486 :safe means set the safe variables, and ignore the rest.
487 :all means set all variables, whether safe or not.
488 (Don't set it permanently to :all.)
489 A value of nil means always ignore the file local variables.
491 Any other value means always query you once whether to set them all.
492 \(When you say yes to certain values, they are remembered as safe, but
495 This variable also controls use of major modes specified in
496 a -*- line.
499 always obeys file local variable specifications and the -*- line,
500 and ignores this variable."
501 :risky t
510 "Like `enable-local-variables' but meant for buffer-local bindings.
511 The meaningful values are nil and non-nil. The default is non-nil.
512 If a major mode sets this to nil, buffer-locally, then any local
513 variables list in the file will be ignored.
515 This variable does not affect the use of major modes
520 The value can be t, nil or something else.
521 A value of t means obey `eval' variables.
522 A value of nil means ignore them; anything else means query."
523 :risky t
529 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
538 "Non-nil means buffers visiting files read-only do so in view mode.
539 In fact, this means that all read-only buffers normally have
540 View mode enabled, including buffers that are read-only because
541 you visit a file you cannot alter, and buffers you make read-only
547 "History list of file names entered in the minibuffer.
549 Maximum length of the history list is determined by the value
551 \f
554 "Provides support for ange-ftp host name completion.
555 Runs the usual ange-ftp hook, but only for completion operations."
556 ;; Having this here avoids the need to load ange-ftp when it's not
557 ;; really in use.
563 inhibit-file-name-handlers)))
568 "Convert a standard file's name to something suitable for the OS.
569 This means to guarantee valid names and perhaps to canonicalize
570 certain patterns.
572 FILENAME should be an absolute file name since the conversion rules
573 sometimes vary depending on the position in the file name. E.g. c:/foo
574 is a valid DOS file name, but c:/bar/c:/foo is not.
576 This function's standard definition is trivial; it just returns
577 the argument. However, on Windows and DOS, replace invalid
578 characters. On DOS, make sure to obey the 8.3 limitations.
579 In the native Windows build, turn Cygwin names into native names,
580 and also turn slashes into backslashes if the shell requires it (see
581 `w32-shell-dos-semantics').
583 See Info node `(elisp)Standard File Names' for more details."
587 ;; Replace invalid filename characters with !
591 name)
592 filename))
595 "Read directory name, prompting with PROMPT and completing in directory DIR.
596 Value is not expanded---you must call `expand-file-name' yourself.
597 Default name to DEFAULT-DIRNAME if user exits with the same
598 non-empty string that was inserted by this function.
599 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
600 or just DIR if INITIAL is nil.)
601 If the user exits with an empty minibuffer, this function returns
602 an empty string. (This can only happen if the user erased the
603 pre-inserted contents or if `insert-default-directory' is nil.)
604 Fourth arg MUSTMATCH non-nil means require existing directory's name.
605 Non-nil and non-t means also require confirmation after completion.
606 Fifth arg INITIAL specifies text to start with.
607 DIR should be an absolute directory name. It defaults to
608 the value of `default-directory'."
613 dir))
614 mustmatch initial
617 \f
619 "Show the current default directory."
624 "Value of the CDPATH environment variable, as a list.
628 "Explode a search path into a list of directory names.
629 Directories are separated by occurrences of `path-separator'
630 \(which is colon in GNU and GNU-like systems)."
631 ;; We could use split-string here.
639 nil
644 cd-list)))
647 "Change current directory to given absolute file name DIR."
648 ;; Put the name into directory syntax now,
649 ;; because otherwise expand-file-name may give some bad results.
651 ;; We used to additionally call abbreviate-file-name here, for an
652 ;; unknown reason. Problem is that most buffers are setup
653 ;; without going through cd-absolute and don't call
654 ;; abbreviate-file-name on their default-directory, so the few that
655 ;; do end up using a superficially different directory.
667 "Make DIR become the current buffer's default directory.
668 If your environment includes a `CDPATH' variable, try each one of
669 that list of directories (separated by occurrences of
670 `path-separator') when resolving a relative directory name.
671 The path separator is colon in GNU and GNU-like systems."
674 default-directory default-directory
690 cd-path)
691 nil))
695 "Load the Lisp file named FILE."
696 ;; This is a case where .elc makes a lot of sense.
703 "Search for FILENAME through PATH.
704 If found, return the absolute file name of FILENAME, with its suffixes;
705 otherwise return nil.
706 PATH should be a list of directories to look in, like the lists in
707 `exec-path' or `load-path'.
708 If SUFFIXES is non-nil, it should be a list of suffixes to append to
711 If non-nil, PREDICATE is used instead of `file-readable-p'.
712 PREDICATE can also be an integer to pass to the `access' system call,
713 in which case file-name handlers are ignored. This usage is deprecated.
715 For compatibility, PREDICATE can also be one of the symbols
716 `executable', `readable', `writable', or `exists', or a list of
717 one or more of those symbols."
728 "Do completion for file names passed to `locate-file'."
750 string-file dir))
756 string-dir names string-file pred action)))))
759 "Do completion for file names passed to `locate-file'.
760 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
763 string nil action))
768 "Regexp of directory names which stop the search in `locate-dominating-file'.
769 Any directory whose name matches this regexp will be treated like
770 a kind of root directory by `locate-dominating-file' which will stop its search
771 when it bumps into it.
772 The default regexp prevents fruitless and time-consuming attempts to find
773 special files in directories in which filenames are interpreted as hostnames,
776 ;; (defun locate-dominating-files (file regexp)
777 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
778 ;; Stop at the first parent where a matching file is found and return the list
779 ;; of files that that match in this directory."
780 ;; (catch 'found
781 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
782 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
783 ;; (let ((user nil)
784 ;; ;; Abbreviate, so as to stop when we cross ~/.
785 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
786 ;; files)
787 ;; (while (and dir
788 ;; ;; As a heuristic, we stop looking up the hierarchy of
789 ;; ;; directories as soon as we find a directory belonging to
790 ;; ;; another user. This should save us from looking in
791 ;; ;; things like /net and /afs. This assumes that all the
792 ;; ;; files inside a project belong to the same user.
793 ;; (let ((prev-user user))
794 ;; (setq user (nth 2 (file-attributes dir)))
795 ;; (or (null prev-user) (equal user prev-user))))
796 ;; (if (setq files (condition-case nil
797 ;; (directory-files dir 'full regexp 'nosort)
798 ;; (error nil)))
799 ;; (throw 'found files)
800 ;; (if (equal dir
801 ;; (setq dir (file-name-directory
802 ;; (directory-file-name dir))))
803 ;; (setq dir nil))))
804 ;; nil)))
807 "Look up the directory hierarchy from FILE for a file named NAME.
808 Stop at the first parent directory containing a file NAME,
809 and return the directory. Return nil if not found."
810 ;; We used to use the above locate-dominating-files code, but the
811 ;; directory-files call is very costly, so we're much better off doing
812 ;; multiple calls using the code in here.
813 ;;
814 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
815 ;; `name' in /home or in /.
819 ;; `user' is not initialized outside the loop because
820 ;; `file' may not exist, so we may have to walk up part of the
821 ;; hierarchy before we find the "initial UID".
823 try)
826 ;; FIXME: Disabled this heuristic because it is sometimes
827 ;; inappropriate.
828 ;; As a heuristic, we stop looking up the hierarchy of
829 ;; directories as soon as we find a directory belonging
830 ;; to another user. This should save us from looking in
831 ;; things like /net and /afs. This assumes that all the
832 ;; files inside a project belong to the same user.
833 ;; (let ((prev-user user))
834 ;; (setq user (nth 2 (file-attributes file)))
835 ;; (and prev-user (not (equal user prev-user))))
843 root))
847 "Search for COMMAND in `exec-path' and return the absolute file name.
848 Return nil if COMMAND is not found anywhere in `exec-path'."
849 ;; Use 1 rather than file-executable-p to better match the behavior of
850 ;; call-process.
854 "Load the Emacs Lisp library named LIBRARY.
855 This is an interface to the function `load'. LIBRARY is searched
856 for in `load-path', both with and without `load-suffixes' (as
857 well as `load-file-rep-suffixes').
859 See Info node `(emacs)Lisp Libraries' for more details.
860 See `load-file' for a different interface to `load'."
864 load-path
869 "Test whether FILE specifies a location on a remote system.
870 Returns nil or a string identifying the remote connection (ideally
871 a prefix of FILE). For example, the remote identification for filename
874 less reliable than accessing local files.
875 Furthermore, relative file names do not work across remote connections.
877 IDENTIFICATION specifies which part of the identification shall
878 be returned as string. IDENTIFICATION can be the symbol
879 `method', `user', `host' or `localname'; any other value is
880 handled like nil and means to return the complete identification
881 string.
883 If CONNECTED is non-nil, the function returns an identification only
884 if FILE is located on a remote system, and a connection is established
885 to that remote system.
887 `file-remote-p' will never open a connection on its own."
891 nil)))
894 "Copy the file FILE into a temporary file on this machine.
895 Returns the name of the local copy, or nil, if FILE is directly
896 accessible."
897 ;; This formerly had an optional BUFFER argument that wasn't used by
898 ;; anything.
902 nil)))
905 "Return the truename of FILENAME, which should be absolute.
906 The truename of a file name is found by chasing symbolic links
907 both at the level of the file and at the level of the directories
908 containing it, until no links are left at any level.
911 ;; COUNTER and PREV-DIRS are only used in recursive calls.
912 ;; COUNTER can be a cons cell whose car is the count of how many
913 ;; more links to chase before getting an error.
914 ;; PREV-DIRS can be a cons cell whose car is an alist
915 ;; of truenames we've just recently computed.
929 ;; For speed, remove the ange-ftp completion handler from the list.
930 ;; We know it's not needed here.
931 ;; For even more speed, do this only on the outermost call.
938 ;; andrewi@harlequin.co.uk - none of the following code (except for
939 ;; invoking the file-name handler) currently applies on Windows
940 ;; (ie. there are no native symlinks), but there is an issue with
941 ;; case differences being ignored by the OS, and short "8.3 DOS"
942 ;; name aliases existing for all files. (The short names are not
943 ;; reported by directory-files, but can be used to refer to files.)
944 ;; It seems appropriate for file-truename to resolve these issues in
945 ;; the most natural way, which on Windows is to call the function
946 ;; `w32-long-file-name' - this returns the exact name of a file as
947 ;; it is stored on disk (expanding short name aliases with the full
948 ;; name in the process).
951 ;; For file name that has a special handler, call handler.
952 ;; This is so that ange-ftp can save time by doing a no-op.
955 ;; If filename contains a wildcard, newname will be the old name.
957 ;; If filename exists, use the long name. If it doesn't exist,
958 ;; drill down until we find a directory that exists, and use
959 ;; the long name of that, with the extra non-existent path
960 ;; components concatenated.
962 missing rest)
965 ;; Include the preceding directory separator in the missing
966 ;; part so subsequent recursion on the rest works.
971 ""
976 ;; If this file directly leads to a link, process that iteratively
977 ;; so that we don't use lots of stack.
983 ;; For file name that has a special handler, call handler.
984 ;; This is so that ange-ftp can save time by doing a no-op.
987 done t)
989 target dirfile)
990 ;; Get the truename of the directory.
992 ;; If these are equal, we have the (or a) root directory.
994 ;; If this is the same dir we last got the truename for,
995 ;; save time--don't recalculate.
1005 done t)
1008 done t)
1009 ;; Put it back on the file name.
1011 ;; Is the file name the name of a link?
1014 ;; Yes => chase that link, then start all over
1015 ;; since the link may point to a directory name that uses links.
1016 ;; We can't safely use expand-file-name here
1017 ;; since target might look like foo/../bar where foo
1018 ;; is itself a link. Instead, we handle . and .. above.
1021 target
1023 done nil)
1024 ;; No, we are done!
1026 filename))
1029 "Chase links in FILENAME until a name that is not a link.
1030 Unlike `file-truename', this does not check whether a parent
1031 directory name is a symbolic link.
1032 If the optional argument LIMIT is a number,
1033 it means chase no more than that many links and then stop."
1041 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1044 ;; Handle `..' by hand, since it needs to work in the
1045 ;; target of any directory symlink.
1046 ;; This code is not quite complete; it does not handle
1047 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1051 ;; Chase links in the default dir of the symlink.
1055 ;; Now find the parent of that dir.
1059 newname))
1062 "Create a temporary file.
1063 The returned file name (created by appending some random characters at the end
1064 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1065 is guaranteed to point to a newly created empty file.
1066 You can then use `write-region' to write new data into the file.
1068 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1070 If SUFFIX is non-nil, add that at the end of the file name."
1072 file)
1075 ;; Create temp files with strict access rights. It's easy to
1076 ;; loosen them later, whereas it's impossible to close the
1077 ;; time-window of loose permissions otherwise.
1085 temporary-file-directory)
1087 temporary-file-directory))))
1093 nil)
1095 ;; the file was somehow created by someone else between
1096 ;; `make-temp-name' and `write-region', let's try again.
1097 nil)
1098 file)
1099 ;; Reset the umask.
1103 "Change the encoding of FILE's name from CODING to NEW-CODING.
1104 The value is a new name of FILE.
1105 Signals a `file-already-exists' error if a file of the new name
1106 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1107 is non-nil. A number as fourth arg means request confirmation if
1108 the new name already exists. This is what happens in interactive
1109 use with M-x."
1112 default-file-name-coding-system))
1114 from-coding to-coding)
1116 ;; We provide the default coding only when it seems that
1117 ;; the filename is correctly decoded by the default
1118 ;; coding.
1124 filename default-coding)
1125 default-coding))
1129 ;; We provide the default coding only when a user is going to
1130 ;; change the encoding not from the default coding.
1134 filename from-coding)))
1137 filename from-coding default-coding)
1138 default-coding)))
1142 default-file-name-coding-system))
1143 ;; FILE should have been decoded by DEFAULT-CODING.
1147 ;; Suppress further encoding.
1152 newname))
1153 \f
1155 "Whether confirmation is requested before visiting a new file or buffer.
1156 If nil, confirmation is not requested.
1157 If the value is `after-completion', confirmation is only
1158 requested if the user called `minibuffer-complete' right before
1159 `minibuffer-complete-and-exit'.
1160 Any other non-nil value means to request confirmation.
1162 This affects commands like `switch-to-buffer' and `find-file'."
1170 "Whether to request confirmation before visiting a new file or buffer.
1171 The variable `confirm-nonexistent-file-or-buffer' determines the
1172 return value, which may be passed as the REQUIRE-MATCH arg to
1173 `read-buffer' or `find-file-read-args'."
1181 "Read the name of a buffer to switch to and return as a string.
1182 It is intended for `switch-to-buffer' family of commands since they
1183 need to omit the name of current buffer from the list of completions
1184 and default values."
1189 ;; Since rbts-completion-table is built dynamically, we
1190 ;; can't just add it to the default value of
1191 ;; icomplete-with-completion-tables, so we add it
1192 ;; here manually.
1197 icomplete-with-completion-tables))))
1202 "Select the buffer specified by BUFFER-OR-NAME in another window.
1203 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1204 nil. Return the buffer switched to.
1206 If called interactively, prompt for the buffer name using the
1207 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1208 determines whether to request confirmation before creating a new
1209 buffer.
1211 If BUFFER-OR-NAME is a string and does not identify an existing
1212 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1213 nil, switch to the buffer returned by `other-buffer'.
1215 Optional second argument NORECORD non-nil means do not put this
1216 buffer at the front of the list of recently selected ones.
1218 This uses the function `display-buffer' as a subroutine; see its
1219 documentation for additional customization information."
1223 same-window-buffer-names same-window-regexps)
1227 "Switch to buffer BUFFER-OR-NAME in another frame.
1228 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1229 nil. Return the buffer switched to.
1231 If called interactively, prompt for the buffer name using the
1232 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1233 determines whether to request confirmation before creating a new
1234 buffer.
1236 If BUFFER-OR-NAME is a string and does not identify an existing
1237 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1238 nil, switch to the buffer returned by `other-buffer'.
1240 Optional second arg NORECORD non-nil means do not put this
1241 buffer at the front of the list of recently selected ones.
1243 This uses the function `display-buffer' as a subroutine; see its
1244 documentation for additional customization information."
1248 same-window-buffer-names same-window-regexps)
1252 "Display buffer BUFFER in another frame.
1253 This uses the function `display-buffer' as a subroutine; see
1254 its documentation for additional customization information."
1257 same-window-buffer-names same-window-regexps
1259 new-window)
1261 ;; This may have been here in order to prevent the new frame from hiding
1262 ;; the old frame. But it does more harm than good.
1263 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1264 ;;(lower-frame (window-frame new-window))
1266 ;; This may have been here in order to make sure the old-frame gets the
1267 ;; focus. But not only can it cause an annoying flicker, with some
1268 ;; window-managers it just makes the window invisible, with no easy
1269 ;; way to recover it. --Stef
1270 ;;(make-frame-invisible (window-frame old-window))
1271 ;;(make-frame-visible (window-frame old-window))
1272 ))
1278 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1279 BODY should use the minibuffer at most once.
1280 Recursive uses of the minibuffer will not be affected."
1286 ;; Clear out this hook so it does not interfere
1287 ;; with any recursive minibuffer usage.
1303 t))
1306 "Edit file FILENAME.
1307 Switch to a buffer visiting file FILENAME,
1308 creating one if none already exists.
1309 Interactively, the default if you just type RET is the current directory,
1310 but the visited file name is available through the minibuffer history:
1311 type M-n to pull it into the minibuffer.
1313 You can visit files on remote machines by specifying something
1314 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1315 also visit local files as a different user by specifying
1316 /sudo::FILE for the file name.
1317 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1318 manual, for more about this.
1320 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1321 expand wildcards (if any) and visit multiple files. You can
1322 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1324 To visit a file without any kind of conversion and without
1335 "Edit file FILENAME, in another window.
1338 an existing one. See the function `display-buffer'.
1340 Interactively, the default if you just type RET is the current directory,
1341 but the visited file name is available through the minibuffer history:
1342 type M-n to pull it into the minibuffer.
1344 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1345 expand wildcards (if any) and visit multiple files."
1358 "Edit file FILENAME, in another frame.
1361 an existing one. See the function `display-buffer'.
1363 Interactively, the default if you just type RET is the current directory,
1364 but the visited file name is available through the minibuffer history:
1365 type M-n to pull it into the minibuffer.
1367 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1368 expand wildcards (if any) and visit multiple files."
1381 "Edit the existing file FILENAME.
1383 file names with wildcards."
1392 "Edit file FILENAME but don't allow changes.
1406 value))
1409 "Edit file FILENAME in another window but don't allow changes.
1423 value))
1426 "Edit file FILENAME in another frame but don't allow changes.
1440 value))
1443 "Find file FILENAME as a replacement for the file in the next window.
1444 This command does not select that window.
1448 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1449 expand wildcards (if any) and replace the file with multiple files."
1460 "Find alternate file: " file-dir nil
1462 t))))
1470 "Find file FILENAME, select its buffer, kill previous buffer.
1471 If the current buffer now contains an empty file that you just visited
1472 \(presumably by mistake), use this command to visit the file you really want.
1476 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1477 expand wildcards (if any) and replace the file with multiple files.
1479 If the current buffer is an indirect buffer, or the base buffer
1480 for one or more indirect buffers, the other buffer(s) are not
1481 killed."
1490 "Find alternate file: " file-dir nil
1492 t)))
1507 ;; Run `kill-buffer-hook' here. It needs to happen before
1508 ;; variables like `buffer-file-name' etc are set to nil below,
1509 ;; because some of the hooks that could be invoked
1510 ;; (e.g., `save-place-to-alist') depend on those variables.
1511 ;;
1512 ;; Note that `kill-buffer-hook' is not what queries whether to
1513 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1514 ;; asks that itself. Thus, there's no need to temporarily do
1515 ;; `(set-buffer-modified-p nil)' before running this hook.
1517 ;; Okay, now we can end-of-life the old buffer.
1524 ;; This prevents us from finding the same buffer
1525 ;; if we specified the same file again.
1529 ;; Likewise for dired buffers.
1533 ;; This executes if find-file gets an error
1534 ;; and does not really find anything.
1535 ;; We put things back as they were.
1536 ;; If find-file actually finds something, we kill obuf below.
1545 ;; We already ran these; don't run them again.
1548 \f
1550 "Create a suitably named buffer for visiting FILENAME, and return it.
1551 FILENAME (sans directory) is used unchanged if that name is free;
1552 otherwise a string <2> or <3> or ... is appended to get an unused name.
1553 Spaces at the start of FILENAME (sans directory) are removed."
1562 "Create and return a buffer with a name based on NAME.
1563 Choose the buffer's name using `generate-new-buffer-name'."
1567 "Regexp to match the automounter prefix in a directory name."
1575 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1577 home directory is a root directory) and removes automounter prefixes
1578 \(see the variable `automount-dir-prefix')."
1579 ;; Get rid of the prefixes added by the automounter.
1586 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1587 ;; To fix this right, we need a `file-name-case-sensitive-p'
1588 ;; function, but we don't have that yet, so just guess.
1591 ;; If any elt of directory-abbrev-alist matches this name,
1592 ;; abbreviate accordingly.
1598 ;; Compute and save the abbreviated homedir name.
1599 ;; We defer computing this until the first time it's needed, to
1600 ;; give time for directory-abbrev-alist to be set properly.
1601 ;; We include a slash at the end, to avoid spurious matches
1602 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1609 ;; If FILENAME starts with the abbreviated homedir,
1610 ;; make it start with `~' instead.
1612 ;; If the home dir is just /, don't change it.
1615 ;; MS-DOS root directories can come with a drive letter;
1616 ;; Novell Netware allows drive letters beyond `Z:'.
1626 filename)))
1629 "List of logical names for which visiting shouldn't save the true dirname."
1634 "Return the buffer visiting file FILENAME (a string).
1635 This is like `get-file-buffer', except that it checks for any buffer
1636 visiting the same file, possibly under a different name.
1637 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1638 and others are ignored.
1639 If there is no such live buffer, return nil."
1653 found)
1663 ;; Verify this buffer's file number
1664 ;; still belongs to its file.
1667 attributes)
1671 found))))
1672 \f
1674 "Non-nil means file-visiting commands should handle wildcards.
1675 For example, if you specify `*.c', that would visit all the files
1676 whose names match the pattern."
1682 "Non-nil means suppress warning messages for symlinked files.
1683 When nil, Emacs prints a warning when visiting a file that is already
1684 visited, but with a different name. Setting this option to t
1685 suppresses this warning."
1691 "Maximum size of file above which a confirmation is requested.
1692 When nil, never request confirmation."
1699 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1700 OP-TYPE specifies the file operation being performed (for message to user)."
1710 "Read file FILENAME into a buffer and return the buffer.
1711 If a buffer exists visiting FILENAME, return that one, but
1712 verify that the file has not changed since visited or saved.
1713 The buffer is not selected, just returned to the caller.
1714 Optional second arg NOWARN non-nil means suppress any warning messages.
1715 Optional third arg RAWFILE non-nil means the file is read literally.
1716 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1717 and visit all the matching files. When wildcards are actually
1718 used and expanded, return a list of buffers that are visiting
1719 the various files."
1726 'find-directory-functions
1729 filename)))
1732 find-file-wildcards
1746 ;; Find any buffer for a file which has same truename.
1748 ;; Let user know if there is a buffer with the same truename.
1752 find-file-suppress-same-file-warnings
1756 ;; Optionally also find that buffer.
1759 ;; Check to see if the file looks uncommonly large.
1763 ;; We are using an existing buffer.
1770 ;; Certain files should be reverted automatically
1771 ;; if they have changed on disk and not in the buffer.
1779 found))
1789 "File %s changed on disk. Discard your edits? "
1794 "File %s changed on disk. Discard your edits in %s? "
1802 ;; Check if a formerly read-only file has become
1803 ;; writable and vice versa, but if the buffer agrees
1804 ;; with the new state of the file, that is ok too.
1812 buffer-file-name
1821 ;; It is confusing to ask whether to visit
1822 ;; non-literally if they have the file in
1823 ;; hexl-mode.
1829 "The file %s is already visited normally,
1830 and you have edited the buffer. Now you have asked to visit it literally,
1831 meaning no coding system handling, format conversion, or local variables.
1832 Emacs can only visit a file in one way at a time.
1834 Do you want to save the file, and visit it literally instead? "
1835 "The file %s is already visited literally,
1836 meaning no coding system handling, format conversion, or local variables.
1837 You have edited the buffer. Now you have asked to visit the file normally,
1838 but Emacs can only visit a file in one way at a time.
1845 rawfile truename number))
1849 "\
1850 Do you want to discard your changes, and visit the file literally now? "
1851 "\
1854 rawfile truename number)
1860 "The file %s is already visited normally.
1861 You have asked to visit it literally,
1862 meaning no coding system decoding, format conversion, or local variables.
1863 But Emacs can only visit a file in one way at a time.
1865 Do you want to revisit the file literally now? "
1866 "The file %s is already visited literally,
1867 meaning no coding system decoding, format conversion, or local variables.
1868 You have asked to visit it normally,
1869 but Emacs can only visit a file in one way at a time.
1874 rawfile truename number)
1877 ;; Return the buffer we are using.
1878 buf)
1879 ;; Create a new buffer.
1881 ;; find-file-noselect-1 may use a different buffer.
1883 rawfile truename number))))))
1889 ;; Needed in case we are re-visiting the file with a different
1890 ;; text representation.
1907 filename)))
1908 ;; Unconditionally set error
1918 filename)))
1919 ;; Run find-file-not-found-functions until one returns non-nil.
1921 ;; If they fail too, set error.
1923 ;; Record the file's truename, and maybe use that as visited name.
1931 ;; Set buffer's default directory to that of the file.
1933 ;; Turn off backup files for certain file names. Since
1934 ;; this is a permanent local, the major mode won't eliminate it.
1949 \f
1951 "Like `insert-file-contents', but only reads in the file literally.
1952 A buffer may be modified in several ways after reading into the buffer,
1953 to Emacs features such as format decoding, character code
1954 conversion, `find-file-hook', automatic uncompression, etc.
1956 This function ensures that none of these modifications will take place."
1964 nil))
1967 inhibit-file-name-handlers))
1980 filename)))
1981 ;; Check whether the file is uncommonly large
1992 "Insert contents of file FILENAME into buffer after point with no conversion.
1994 This function is meant for the user to run interactively.
1995 Don't call it from programs! Use `insert-file-contents-literally' instead.
1996 \(Its calling sequence is different; see its documentation)."
2001 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2006 "Visit file FILENAME with no conversion of any kind.
2007 Format conversion and character code conversion are both disabled,
2008 and multibyte characters are disabled in the resulting buffer.
2009 The major mode used is Fundamental mode regardless of the file name,
2010 and local variable specifications in the file are ignored.
2011 Automatic uncompression and adding a newline at the end of the
2012 file due to `require-final-newline' is also disabled.
2014 You cannot absolutely rely on this function to result in
2015 visiting the file literally. If Emacs already has a buffer
2016 which is visiting the file, you get the existing buffer,
2017 regardless of whether it was created literally or not.
2019 In a Lisp program, if you want to be sure of accessing a file's
2020 contents literally, you should create a temporary buffer and then read
2021 the file contents into it using `insert-file-contents-literally'."
2024 \f
2028 after-find-file-from-revert-buffer
2029 nomodes)
2030 "Called after finding a file and by the default revert function.
2031 Sets buffer mode, parses local variables.
2032 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2033 error in reading the file. WARN non-nil means warn if there
2034 exists an auto-save file more recent than the visited file.
2035 NOAUTO means don't mess with auto-save mode.
2036 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2037 means this call was from `revert-buffer'.
2038 Fifth arg NOMODES non-nil means don't alter the file's modes.
2039 Finishes by calling the functions in `find-file-hook'
2040 unless NOMODES is non-nil."
2043 nil
2053 ;; No need to warn if buffer is auto-saved
2054 ;; under the name of the visited file.
2056 auto-save-visited-file-name))
2059 buffer-file-name))
2079 ;; Make people do a little extra work (C-x C-q)
2080 ;; before altering a backup file.
2083 ;; When a file is marked read-only,
2084 ;; make the buffer read-only even if root is looking at it.
2092 ;; If requested, add a newline at the end of the file.
2102 view-read-only
2108 "Eval BODY and turn any error into a FORMAT message.
2109 FORMAT can have a %s escape which will be replaced with the actual error.
2110 If `debug-on-error' is set, errors are not caught, so that you can
2111 debug them.
2112 Avoid using a large BODY since it is duplicated."
2121 "Choose the major mode for this buffer automatically.
2122 Also sets up any specified local variables of the file.
2123 Uses the visited file name, the -*- line, and the local variables spec.
2125 This function is called automatically from `find-file'. In that case,
2126 we may set up the file-specified mode and local variables,
2127 depending on the value of `enable-local-variables'.
2128 In addition, if `local-enable-local-variables' is nil, we do
2129 not set local variables (though we do notice a mode specified with -*-.)
2131 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2132 or from Lisp without specifying the optional argument FIND-FILE;
2133 in that case, this function acts as if `enable-local-variables' were t."
2141 ;; Turn font lock off and on, to make sure it takes account of
2142 ;; whatever file local variables are relevant to it.
2144 ;; Font-lock-mode (now in font-core.el) can be ON when
2145 ;; font-lock.el still hasn't been loaded.
2155 "Non-nil means to try second pass through `auto-mode-alist'.
2156 This means that if the first case-sensitive search through the alist fails
2157 to find a matching major mode, a second case-insensitive search is made.
2158 On systems with case-insensitive file names, this variable is ignored,
2159 since only a single case-insensitive search through the alist is made."
2165 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2166 ;; c++-mode, java-mode and more) are added through autoload
2167 ;; directives in that file. That way is discouraged since it
2168 ;; spreads out the definition of the initial value.
2202 ;; Less common extensions come here
2203 ;; so more common ones above are found faster.
2242 ;; The list of archive file extensions should be in sync with
2243 ;; `auto-coding-alist' with `no-conversion' coding system.
2249 ;; Mailer puts message to be edited in
2250 ;; /tmp/Re.... or Message
2254 ;; some news reader is reported to use this
2263 ;; .emacs or .gnus or .viper following a directory delimiter in
2264 ;; Unix, MSDOG or VMS syntax.
2267 ;; _emacs following a directory delimiter
2268 ;; in MsDos syntax
2272 ;; Common Lisp ASDF package system.
2291 ;; Windows candidates may be opened case sensitively on Unix
2297 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2299 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2300 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2301 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2302 ;; this has lower priority to avoid matching changelog.sgml etc.
2304 ;; either user's dot-files or under /etc or some such
2306 ;; alas not all ~/.*rc files are like this
2307 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2312 ;; this contains everything twice, with space and with colon :-(
2314 ;; Get rid of any trailing .n.m and try again.
2315 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2316 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2317 ;; Using mode nil rather than `ignore' would let the search continue
2318 ;; through this list (with the shortened name) rather than start over.
2320 ;; The following should come after the ChangeLog pattern
2321 ;; for the sake of ChangeLog.1, etc.
2322 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2325 "Alist of filename patterns vs corresponding major mode functions.
2326 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2327 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2328 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2329 mode function to use. FUNCTION will be called, unless it is nil.
2331 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2332 calling FUNCTION (if it's not nil), we delete the suffix that matched
2333 REGEXP and search the list again for another match.
2335 If the file name matches `inhibit-first-line-modes-regexps',
2336 then `auto-mode-alist' is not processed.
2338 The extensions whose FUNCTION is `archive-mode' should also
2339 appear in `auto-coding-alist' with `no-conversion' coding system.
2341 See also `interpreter-mode-alist', which detects executable script modes
2342 based on the interpreters they specify to run,
2347 "Select Conf mode or XML mode according to start of file."
2357 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2358 ;; and pike-mode) are added through autoload directives in that
2359 ;; file. That way is discouraged since it spreads out the
2360 ;; definition of the initial value.
2398 "Alist mapping interpreter names to major modes.
2399 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2400 Each element looks like (INTERPRETER . MODE).
2401 If INTERPRETER matches the name of the interpreter specified in the first line
2402 of a script, mode MODE is enabled.
2410 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2411 When checking `inhibit-first-line-modes-regexps', we first discard
2417 "Regexp matching interpreters, for file mode determination.
2418 This regular expression is matched against the first line of a file
2419 to determine the file's mode in `set-auto-mode'. If it matches, the file
2420 is assumed to be interpreted by the interpreter matched by the second group
2421 of the regular expression. The mode is then determined as the mode
2425 "Alist of buffer beginnings vs. corresponding major mode functions.
2426 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2427 After visiting a file, if REGEXP matches the text at the beginning of the
2428 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2429 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2430 major mode.
2432 If FUNCTION is nil, then it is not called. (That is a way of saying
2439 ;; The < comes before the groups (but the first) to reduce backtracking.
2440 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2441 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2445 comment-re "*"
2448 . html-mode)
2450 ;; These two must come after html, because they are more general:
2455 . sgml-mode)
2458 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2459 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2460 After visiting a file, if REGEXP matches the text at the beginning of the
2461 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2462 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2463 have not specified a mode for this file.
2469 "Upper limit on `magic-mode-alist' regexp matches.
2473 "Select major mode appropriate for current buffer.
2475 To find the right major mode, this function checks for a -*- mode tag,
2476 checks if it uses an interpreter listed in `interpreter-mode-alist',
2477 matches the buffer beginning against `magic-mode-alist',
2478 compares the filename against the entries in `auto-mode-alist',
2479 then matches the buffer beginning against `magic-fallback-mode-alist'.
2481 It does not check for the `mode:' local variable in the
2482 Local Variables section of the file; for that, use `hack-local-variables'.
2484 If `enable-local-variables' is nil, this function does not check for a
2485 -*- mode tag.
2487 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2488 set the major mode only if that would change it. In other words
2489 we don't actually set it to the same mode the buffer already has."
2490 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2492 ;; Find a -*- mode tag
2499 ;; Find all specifications for the `mode:' variable
2500 ;; and execute them left to right.
2512 modes)))
2513 ;; Simple -*-MODE-*- case.
2516 modes))))
2517 ;; If we found modes to use, invoke them now, outside the save-excursion.
2525 ;; continuing would call minor modes again, toggling them off
2527 ;; If we didn't, look for an interpreter specified in the first line.
2528 ;; As a special case, allow for things like "#!/bin/env perl", which
2529 ;; finds the interpreter anywhere in $PATH.
2536 ;; Map interpreter name to a mode, signalling we're done at the
2537 ;; same time.
2539 interpreter-mode-alist))
2540 ;; If we found an interpreter mode to use, invoke it now.
2543 ;; Next try matching the buffer beginning against magic-mode-alist.
2557 ;; Next compare the filename against the entries in auto-mode-alist.
2562 ;; Remove remote file name identification.
2566 ;; Remove backup-suffixes from file name.
2569 ;; Find first matching alist entry.
2572 ;; System is case-insensitive.
2576 ;; System is case-sensitive.
2578 ;; First match case-sensitively.
2582 ;; Fallback to case-insensitive match.
2596 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2611 ;; When `keep-mode-if-same' is set, we are working on behalf of
2612 ;; set-visited-file-name. In that case, if the major mode specified is the
2613 ;; same one we already have, don't actually reset it. We don't want to lose
2614 ;; minor modes such as Font Lock.
2616 "Apply MODE and return it.
2617 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2618 any aliases and compared to current major mode. If they are the
2619 same, do nothing and return nil."
2625 mode)))
2628 "Find the -*- spec in the buffer.
2629 Call with point at the place to start searching from.
2630 If one is found, set point to the beginning
2631 and return the position of the end.
2632 Otherwise, return nil; point may be changed."
2635 ;; Don't look for -*- if this file name matches any
2636 ;; of the regexps in inhibit-first-line-modes-regexps.
2644 sufs)
2652 ;; If the file begins with "#!"
2653 ;; (exec interpreter magic), look
2654 ;; for mode frobs in the first two
2655 ;; lines. You cannot necessarily
2656 ;; put them in the first line of
2657 ;; such a file without screwing up
2658 ;; the interpreter invocation.
2659 ;; The same holds for
2660 ;; '\"
2661 ;; in man pages (preprocessor
2662 ;; magic for the `man' program).
2673 end))))
2674 \f
2675 ;;; Handling file local variables
2679 file-local-variables-alist dir-local-variables-alist)
2684 "Normal hook run after processing a file's local variables specs.
2685 Major modes can use this to examine user-specified local variables
2689 "List variable-value pairs that are considered safe.
2690 Each element is a cons cell (VAR . VAL), where VAR is a variable
2691 symbol and VAL is a value that is considered safe."
2692 :risky t
2699 "Expressions that are considered safe in an `eval:' local variable.
2700 Add expressions to this list if you want Emacs to evaluate them, when
2701 they appear in an `eval' local variable specification, without first
2702 asking you for confirmation."
2703 :risky t
2708 ;; Risky local variables:
2711 buffer-auto-save-file-name
2712 buffer-file-name
2713 buffer-file-truename
2714 buffer-undo-list
2715 debugger
2716 default-text-properties
2717 eval
2718 exec-directory
2719 exec-path
2720 file-name-handler-alist
2721 frame-title-format
2722 global-mode-string
2723 header-line-format
2724 icon-title-format
2725 inhibit-quit
2726 load-path
2727 max-lisp-eval-depth
2728 max-specpdl-size
2729 minor-mode-map-alist
2730 minor-mode-overriding-map-alist
2731 mode-line-format
2732 mode-name
2733 overriding-local-map
2734 overriding-terminal-local-map
2735 process-environment
2736 standard-input
2737 standard-output
2738 unread-command-events))
2740 ;; Safe local variables:
2741 ;;
2742 ;; For variables defined by major modes, the safety declarations can go into
2743 ;; the major mode's file, since that will be loaded before file variables are
2744 ;; processed.
2745 ;;
2746 ;; For variables defined by minor modes, put the safety declarations in the
2747 ;; file defining the minor mode after the defcustom/defvar using an autoload
2748 ;; cookie, e.g.:
2749 ;;
2750 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2751 ;;
2752 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2753 ;; minor mode file may not be loaded yet.
2754 ;;
2755 ;; For variables defined in the C source code the declaration should go here:
2771 "Alist of file-local variable settings in the current buffer.
2772 Each element in this list has the form (VAR . VALUE), where VAR
2773 is a file-local variable (a symbol) and VALUE is the value
2774 specified. The actual value in the buffer may differ from VALUE,
2779 "Alist of directory-local variable settings in the current buffer.
2780 Each element in this list has the form (VAR . VALUE), where VAR
2781 is a directory-local variable (a symbol) and VALUE is the value
2782 specified in .dir-locals.el. The actual value in the buffer
2783 may differ from VALUE, if it is changed by the major or minor modes,
2788 "Normal hook run before setting file-local variables.
2789 It is called after checking for unsafe/risky variables and
2790 setting `file-local-variables-alist', and before applying the
2791 variables stored in `file-local-variables-alist'. A hook
2792 function is allowed to change the contents of this alist.
2794 This hook is called only if there is at least one file-local
2798 "Get confirmation before setting up local variable values.
2799 ALL-VARS is the list of all variables to be set up.
2800 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2801 RISKY-VARS is the list of those that are marked as risky.
2802 DIR-NAME is a directory name if these settings come from
2803 directory-local variables, or nil otherwise."
2805 nil
2811 prompt char)
2821 ", and variables that are risky (**)."
2828 y -- to apply the local variables list.
2832 ! -- to apply the local variables list, and permanently mark these
2844 ;; Make strings with embedded whitespace easier to read.
2852 ""
2859 done)
2868 ;; read-event returns -1 if we are in a kbd
2869 ;; macro and there are no more events in the
2870 ;; macro. In that case, attempt to get an
2871 ;; event interactively.
2879 ;; When this is called from desktop-restore-file-buffer,
2880 ;; coding-system-for-read may be non-nil. Reset it before
2881 ;; writing to .emacs.
2885 'safe-local-variable-values
2886 safe-local-variable-values))))
2893 "Return local variables specified in the -*- line.
2894 Ignore any specification for `mode:' and `coding:';
2895 `set-auto-mode' should already have handled `mode:',
2896 `set-auto-coding' should already have handled `coding:'.
2898 If MODE-ONLY is non-nil, all we do is check whether the major
2899 mode is specified, returning t if it is specified. Otherwise,
2900 return an alist of elements (VAR . VAL), where VAR is a variable
2901 and VAL is the specified value."
2905 result mode-specified)
2906 ;; Parse the -*- line into the RESULT alist.
2907 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2909 nil)
2911 ;; Simple form: "-*- MODENAME -*-". Already handled.
2913 nil)
2915 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2916 ;; (last ";" is optional).
2921 ;; There used to be a downcase here,
2922 ;; but the manual didn't say so,
2923 ;; and people want to set var names that aren't all lc.
2929 ;; It is traditional to ignore
2930 ;; case when checking for `mode' in set-auto-mode,
2931 ;; so we must do that here as well.
2932 ;; That is inconsistent, but we're stuck with it.
2933 ;; The same can be said for `coding' in set-auto-coding.
2939 'eval
2946 mode-specified
2947 result))))
2950 "Filter local variable settings, querying the user if necessary.
2951 VARIABLES is the alist of variable-value settings. This alist is
2952 filtered based on the values of `ignored-local-variables',
2953 `enable-local-eval', `enable-local-variables', and (if necessary)
2954 user interaction. The results are added to
2955 `file-local-variables-alist', without applying them.
2956 DIR-NAME is a directory name if these settings come from
2957 directory-local variables, or nil otherwise."
2958 ;; Find those variables that we may want to save to
2959 ;; `safe-local-variable-values'.
2965 ;; Ignore any variable in `ignored-local-variables'.
2966 nil)
2967 ;; Obey `enable-local-eval'.
2974 ;; Ignore duplicates in the present list.
2976 ;; Accept known-safe variables.
2980 ;; The variable is either risky or unsafe:
2987 ;; Query, unless all vars are safe or user wants no querying.
2993 risky-vars dir-name))
3004 "Parse and put into effect this buffer's local variables spec.
3005 If MODE-ONLY is non-nil, all we do is check whether the major mode
3006 is specified, returning t if it is specified."
3009 result)
3016 ;; Look for "Local variables:" line in last page.
3024 ;; suffix is what comes after "local variables:" in its line.
3025 ;; prefix is what comes before "local variables:" in its line.
3035 beg)
3039 endpos
3045 nil t))
3046 ;; This used to be an error, but really all it means is
3047 ;; that this may simply not be a local-variables section,
3048 ;; so just ignore it.
3058 ;; Discard the prefix.
3063 ;; Discard the suffix.
3071 ;; Find the variable name; strip whitespace.
3080 val)
3081 ;; Read the variable value.
3092 'eval
3097 ;; Now we've read all the local variables.
3098 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3100 ;; Otherwise, set the variables.
3104 ;; Any 'evals must run in the Right sequence.
3113 "Non-nil if SYM is safe as a file-local variable with value VAL.
3114 It is safe if any of these conditions are met:
3116 * There is a matching entry (SYM . VAL) in the
3117 `safe-local-variable-values' user option.
3119 * The `safe-local-variable' property of SYM is a function that
3120 evaluates to a non-nil value with VAL as an argument."
3126 "Non-nil if SYM could be dangerous as a file-local variable.
3127 It is dangerous if either of these conditions are met:
3129 * Its `risky-local-variable' property is non-nil.
3135 ;; If this is an alias, check the base name.
3155 "Return t if it is safe to eval EXP when it is found in a file."
3157 ;; Detect certain `put' expressions.
3164 lisp-indent-function
3165 scheme-indent-function))
3166 ;; Only allow safe values (not functions).
3171 ;; Only allow indirect form specs.
3172 ;; During bootstrapping, edebug-basic-spec might not be
3173 ;; defined yet.
3177 ;; Allow expressions that the user requested.
3179 ;; Certain functions can be allowed with safe arguments
3180 ;; or can specify verification functions to try.
3188 ok))
3196 ok)))))))
3199 "Set local variable VAR with value VAL.
3200 If VAR is `mode', call `VAL-mode' as a function unless it's
3201 already the major mode."
3208 ;; A minor mode must be passed an argument.
3209 ;; Otherwise, if the user enables the minor mode in a
3210 ;; major mode hook, this would toggle it off.
3216 ;; Make sure the string has no text properties.
3217 ;; Some text properties can get evaluated in various ways,
3218 ;; so it is risky to put them on with a local variable list.
3222 \f
3223 ;;; Handling directory-local variables, aka project settings.
3229 "List of cached directory roots for directory-local variable classes.
3230 Each element in this list has the form (DIR CLASS MTIME).
3231 DIR is the name of the directory.
3232 CLASS is the name of a variable class (a symbol).
3233 MTIME is the recorded modification time of the directory-local
3234 variables file associated with this entry. This time is a list
3235 of two integers (the same format as `file-attributes'), and is
3236 used to test whether the cache entry is still valid.
3237 Alternatively, MTIME can be nil, which means the entry is always
3241 "Return the variable list for CLASS."
3245 "Collect directory-local variables from MODE-VARIABLES.
3246 VARIABLES is the initial list of variables.
3247 Returns the new list."
3252 ;; If variables are specified more than once, only use the last. (Why?)
3253 ;; The pseudo-variables mode and eval are different (bug#3430).
3256 ;; Need a new cons in case we setcdr later.
3260 "Collect entries from CLASS-VARIABLES into VARIABLES.
3261 ROOT is the root directory of the project.
3262 Return the new variables list."
3270 ;; Don't include this in the previous condition, because we
3271 ;; want to filter all strings before the next condition.
3283 "Declare that the DIRECTORY root is an instance of CLASS.
3284 DIRECTORY is the name of a directory, a string.
3285 CLASS is the name of a project class, a symbol.
3286 MTIME is either the modification time of the directory-local
3287 variables file that defined this class, or nil.
3289 When a file beneath DIRECTORY is visited, the mode-specific
3290 variables from CLASS are applied to the buffer. The variables
3291 for a class are defined using `dir-locals-set-class-variables'."
3298 "Map the type CLASS to a list of variable settings.
3299 CLASS is the project class, a symbol. VARIABLES is a list
3300 that declares directory-local variables for the class.
3301 An element in VARIABLES is either of the form:
3302 (MAJOR-MODE . ALIST)
3303 or
3304 (DIRECTORY . LIST)
3306 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3307 whose elements are of the form (VARIABLE . VALUE).
3309 In the second form, DIRECTORY is a directory name (a string), and
3310 LIST is a list of the form accepted by the function.
3312 When a file is visited, the file's class is found. A directory
3313 may be assigned a class using `dir-locals-set-directory-class'.
3314 Then variables are set in the file's buffer according to the
3315 class' LIST. The list is processed in order.
3317 * If the element is of the form (MAJOR-MODE . ALIST), and the
3318 buffer's major mode is derived from MAJOR-MODE (as determined
3319 by `derived-mode-p'), then all the variables in ALIST are
3320 applied. A MAJOR-MODE of nil may be used to match any buffer.
3321 `make-local-variable' is called for each variable before it is
3322 set.
3324 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3325 is an initial substring of the file's directory, then LIST is
3326 applied by recursively following these rules."
3333 "File that contains directory-local variables.
3334 It has to be constant to enforce uniform values
3338 "Find the directory-local variables for FILE.
3339 This searches upward in the directory tree from FILE.
3340 If the directory root of FILE has been registered in
3341 `dir-locals-directory-cache' and the directory-local variables
3342 file has not been modified, return the matching entry in
3343 `dir-locals-directory-cache'.
3344 Otherwise, if a directory-local variables file is found, return
3345 the file name.
3346 Otherwise, return nil."
3351 dir-locals-file))
3354 ;; `locate-dominating-file' may have abbreviated the name.
3357 ;; Find the best cached value in `dir-locals-directory-cache'.
3370 ;; Check the validity of the cache.
3375 ;; This cache entry is OK.
3376 dir-elt
3377 ;; This cache entry is invalid; clear it.
3380 locals-file)
3381 locals-file))))
3384 "Load a variables FILE and register a new class and instance.
3385 FILE is the name of the file holding the variables to apply.
3386 The new class name is the same as the directory in which FILE
3387 is found. Returns the new class name."
3397 class-name)))
3400 "Read per-directory local variables for the current buffer.
3401 Store the directory-local variables in `dir-local-variables-alist'
3402 and `file-local-variables-alist', without applying them."
3406 ;; Find the variables file.
3429 \f
3432 However, the mode will not be changed if
3433 \(1) a local variables list or the `-*-' line specifies a major mode, or
3435 \ not suitable for ordinary files, or
3436 \(3) the new file name does not particularly specify any mode."
3441 "Change name of file visited in current buffer to FILENAME.
3442 This also renames the buffer to correspond to the new file.
3443 The next time the buffer is saved it will go in the newly specified file.
3444 FILENAME nil or an empty string means mark buffer as not visiting any file.
3445 Remember to delete the initial contents of the minibuffer
3446 if you wish to pass an empty string as the argument.
3448 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3449 confirmation in the case where another buffer is already visiting FILENAME.
3451 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3452 the old visited file has been renamed to the new name FILENAME."
3460 nil
3475 filename)))
3485 ;; If new-name == old-name, renaming would add a spurious <2>
3486 ;; and it's considered as a feature in rename-buffer.
3492 ;; Abbreviate the file names of the buffer.
3501 nil)))
3502 ;; write-file-functions is normally used for things like ftp-find-file
3503 ;; that visit things that are not local files as if they were files.
3504 ;; Changing to visit an ordinary local file instead should flush the hook.
3509 ;; If buffer was read-only because of version control,
3510 ;; that reason is gone now, so make it writable.
3514 ;; Turn off backup files for certain file names.
3515 ;; Since this is a permanent local, the major mode won't eliminate it.
3517 backup-enable-predicate
3523 ;; If auto-save was not already on, turn it on if appropriate.
3527 ;; If auto save is on, start using a new name.
3528 ;; We deliberately don't rename or delete the old auto save
3529 ;; for the old visited file name. This is because perhaps
3530 ;; the user wants to save the new state and then compare with the
3531 ;; previous state from the auto save file.
3534 ;; Rename the old auto save file if any.
3541 ;; Update the major mode, if the file name determines it.
3543 ;; Don't change the mode if it is special.
3546 ;; Don't change the mode if the local variable list specifies it.
3552 "Write current buffer into file FILENAME.
3553 This makes the buffer visit that file, and marks it as not modified.
3555 If you specify just a directory name as FILENAME, that means to use
3556 the default file name but in that directory. You can also yank
3557 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3559 If the buffer is not already visiting a file, the default file name
3560 for the output file is the buffer name.
3562 If optional second arg CONFIRM is non-nil, this function
3563 asks for confirmation before overwriting an existing file.
3564 Interactively, confirmation is required unless you supply a prefix argument."
3565 ;; (interactive "FWrite file: ")
3569 nil nil nil nil)
3573 default-directory)
3574 nil nil))
3578 ;; If arg is just a directory,
3579 ;; use the default file name, but in that directory.
3590 ;; Make buffer writable if file is writable.
3595 ;; It's likely that the VC status at the new location is different from
3596 ;; the one at the old location.
3598 \f
3600 "Make a backup of the disk file visited by the current buffer, if appropriate.
3601 This is normally done before saving the buffer the first time.
3603 A backup may be done by renaming or by copying; see documentation of
3604 variable `make-backup-files'. If it's done by renaming, then the file is
3605 no longer accessible under its old name.
3607 The value is non-nil after a backup was made by renaming.
3608 It has the form (MODES . BACKUPNAME).
3609 MODES is the result of `file-modes' on the original
3610 file; this means that the caller, after saving the buffer, should change
3611 the modes of the new file to agree with the old modes.
3612 BACKUPNAME is the backup file name, which is the old file renamed."
3619 backup-info backupname targets setmodes)
3620 ;; If specified name is a symbolic link, chase it to the target.
3621 ;; Thus we make the backups in the directory where the real file is.
3626 ;; (if (file-directory-p buffer-file-name)
3627 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3631 ;; If have old versions to maybe delete,
3632 ;; ask the user to confirm now, before doing anything.
3633 ;; But don't actually delete til later.
3638 real-file-name)))))
3640 ;; Actually write the back up file.
3643 ; (file-symlink-p buffer-file-name)
3644 backup-by-copying
3645 ;; Don't rename a suid or sgid file.
3660 ;; rename-file should delete old backup.
3664 ;; If trouble writing the backup, write it in ~.
3669 backupname)
3673 ;; Now delete the old versions, if desired.
3680 setmodes)
3687 ;; Create temp files with strict access rights. It's easy to
3688 ;; loosen them later, whereas it's impossible to close the
3689 ;; time-window of loose permissions otherwise.
3692 ;; Try to overwrite old backup first.
3700 nil)
3702 ;; The file was somehow created by someone else between
3703 ;; `delete-file' and `copy-file', so let's try again.
3704 ;; rms says "I think there is also a possible race
3705 ;; condition for making backup files" (emacs-devel 20070821).
3706 nil)))
3707 ;; Reset the umask.
3713 "Return file NAME sans backup versions or strings.
3714 This is a separate procedure so your site-init or startup file can
3715 redefine it.
3716 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3717 we do not remove backup version numbers, only true file version numbers."
3729 "Return t if deleting FILE and rewriting it would preserve the owner."
3734 ;; Return t if the file doesn't exist, since it's true that no
3735 ;; information would be lost by an (attempted) delete and create.
3741 The extension, in a file name, is the part that follows the last `.',
3742 except that a leading `.', if any, doesn't count."
3745 directory)
3749 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3750 ;; we don't want to expand it.
3753 filename))))
3757 The extension, in a file name, is the part that follows the last `.',
3758 excluding version numbers and backup suffixes,
3759 except that a leading `.', if any, doesn't count.
3760 Return nil for extensionless file names such as `foo'.
3761 Return the empty string for file names such as `foo.'.
3763 If PERIOD is non-nil, then the returned value includes the period
3764 that delimits the extension, and if FILENAME has no extension,
3775 "A function to use instead of the default `make-backup-file-name'.
3776 A value of nil gives the default `make-backup-file-name' behavior.
3778 This could be buffer-local to do something special for specific
3779 files. If you define it, you may need to change `backup-file-name-p'
3780 and `file-name-sans-versions' too.
3782 See also `backup-directory-alist'."
3788 "Alist of filename patterns and backup directory names.
3789 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3790 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3791 relative or absolute. If it is absolute, so that all matching files
3792 are backed up into the same directory, the file names in this
3793 directory will be the full name of the file backed up with all
3794 directory separators changed to `!' to prevent clashes. This will not
3795 work correctly if your filesystem truncates the resulting name.
3797 For the common case of all backups going into one directory, the alist
3799 directory name.
3801 If this variable is nil, or it fails to match a filename, the backup
3802 is made in the original file's directory.
3804 On MS-DOS filesystems without long names this variable is always
3805 ignored."
3811 "Default `backup-enable-predicate' function.
3812 Checks for files in `temporary-file-directory',
3813 `small-temporary-file-directory', and /tmp."
3816 ;; Directory is under temporary-file-directory.
3821 ;; Directory is under /tmp.
3826 0 nil
3828 ;; Directory is under small-temporary-file-directory.
3833 "Create the non-numeric backup file name for FILE.
3834 Normally this will just be the file's name with `~' appended.
3835 Customization hooks are provided as follows.
3837 If the variable `make-backup-file-name-function' is non-nil, its value
3838 should be a function which will be called with FILE as its argument;
3839 the resulting name is used.
3841 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3842 the documentation of that variable. If the directory for the backup
3843 doesn't exist, it is created."
3857 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3859 elt backup-directory abs-backup-directory)
3864 alist nil)))
3865 ;; If backup-directory is relative, it should be relative to the
3866 ;; file's directory. By expanding explicitly here, we avoid
3867 ;; depending on default-directory.
3876 abs-backup-directory nil))))
3878 file
3882 ;; Normalize DOSish file names: downcase the drive
3883 ;; letter, if any, and replace the leading "x:" with
3884 ;; "/drive_x".
3887 ;; Replace any invalid file-name characters (for the
3888 ;; case of backing up remote files).
3892 "drive_"
3895 ""
3898 ;; Make the name unique by substituting directory
3899 ;; separators. It may not really be worth bothering about
3900 ;; doubling `!'s in the original name...
3905 backup-directory))
3910 "Return non-nil if FILE is a backup file name (numeric or not).
3911 This is a separate function so you can redefine it for customization.
3912 You may need to redefine `file-name-sans-versions' as well."
3917 ;; This is used in various files.
3918 ;; The usage of backup-extract-version-start is not very clean,
3919 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3921 "Given the name of a numeric backup file, FN, return the backup number.
3922 Uses the free variable `backup-extract-version-start', whose value should be
3923 the index in the name where the version number begins."
3930 "Find a file name for a backup file FN, and suggestions for deletions.
3931 Value is a list whose car is the name for the backup file
3932 and whose cdr is a list of old versions to consider deleting now.
3933 If the value is nil, don't make a backup.
3934 Uses `backup-directory-alist' in the same way as does
3935 `make-backup-file-name'."
3937 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3941 ;; We don't support numbered backups on plain MS-DOS
3942 ;; when long file names are unavailable.
3952 possibilities deserve-versions-p versions)
3955 base-versions
3958 possibilities)
3959 #'<)
3964 kept-old-versions
3965 kept-new-versions
3972 ;; Delete nothing if there is overflow
3973 ;; in the number of versions to keep.
3979 v))))))))))
3982 "Return number of names file FILENAME has."
3985 ;; (defun file-relative-name (filename &optional directory)
3986 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3987 ;; This function returns a relative file name which is equivalent to FILENAME
3988 ;; when used with that default directory as the default.
3989 ;; If this is impossible (which can happen on MSDOS and Windows
3990 ;; when the file name and directory use different drive names)
3991 ;; then it returns FILENAME."
3992 ;; (save-match-data
3993 ;; (let ((fname (expand-file-name filename)))
3994 ;; (setq directory (file-name-as-directory
3995 ;; (expand-file-name (or directory default-directory))))
3996 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3997 ;; ;; drive names, they can't be relative, so return the absolute name.
3998 ;; (if (and (or (eq system-type 'ms-dos)
3999 ;; (eq system-type 'cygwin)
4000 ;; (eq system-type 'windows-nt))
4001 ;; (not (string-equal (substring fname 0 2)
4002 ;; (substring directory 0 2))))
4003 ;; filename
4004 ;; (let ((ancestor ".")
4005 ;; (fname-dir (file-name-as-directory fname)))
4006 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4007 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4008 ;; (setq directory (file-name-directory (substring directory 0 -1))
4009 ;; ancestor (if (equal ancestor ".")
4010 ;; ".."
4011 ;; (concat "../" ancestor))))
4012 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4013 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4014 ;; ;; We matched within FNAME's directory part.
4015 ;; ;; Add the rest of FNAME onto ANCESTOR.
4016 ;; (let ((rest (substring fname (match-end 0))))
4017 ;; (if (and (equal ancestor ".")
4018 ;; (not (equal rest "")))
4019 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4020 ;; rest
4021 ;; (concat (file-name-as-directory ancestor) rest)))
4022 ;; ;; We matched FNAME's directory equivalent.
4023 ;; ancestor))))))
4026 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4027 This function returns a relative file name which is equivalent to FILENAME
4028 when used with that default directory as the default.
4029 If FILENAME and DIRECTORY lie on different machines or on different drives
4030 on a DOS/Windows machine, it returns FILENAME in expanded form."
4034 default-directory))))
4040 ;; Test for different drives on DOS/Windows
4042 ;; Should `cygwin' really be included here? --stef
4045 ;; Test for different remote file system identification
4047 filename
4053 directory nil nil case-fold-search))
4055 directory nil nil case-fold-search))))
4058 ".."
4060 ;; Now ancestor is empty, or .., or ../.., etc.
4062 directory nil nil case-fold-search))
4063 ;; We matched within FILENAME's directory part.
4064 ;; Add the rest of FILENAME onto ANCESTOR.
4067 ;; But don't bother with ANCESTOR if it would give us `./'.
4068 rest
4070 ;; We matched FILENAME's directory equivalent.
4071 ancestor))))))
4072 \f
4074 "Save current buffer in visited file if modified.
4075 Variations are described below.
4077 By default, makes the previous version into a backup file
4078 if previously requested or if this is the first save.
4080 to become a backup when the next save is done.
4082 unconditionally makes the previous version into a backup file.
4084 to become a backup when the next save is done,
4085 and unconditionally makes the previous version into a backup file.
4087 With a numeric argument of 0, never make the previous version
4088 into a backup file.
4090 If a file's name is FOO, the names of its numbered backup versions are
4091 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4092 Numeric backups (rather than FOO~) will be made if value of
4093 `version-control' is not the atom `never' and either there are already
4094 numeric versions of the file being backed up, or `version-control' is
4095 non-nil.
4096 We don't want excessive versions piling up, so there are variables
4097 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4098 and `kept-new-versions', which tells how many newest versions to keep.
4099 Defaults are 2 old versions and 2 new.
4100 `dired-kept-versions' controls dired's clean-directory (.) command.
4101 If `delete-old-versions' is nil, system will query user
4102 before trimming versions. Otherwise it does it silently.
4104 If `vc-make-backup-files' is nil, which is the default,
4105 no backup files are made for files managed by version control.
4106 (This is because the version control system itself records previous versions.)
4108 See the subroutine `basic-save-buffer' for more information."
4114 ;; We used to display the message below only for files > 50KB, but
4115 ;; then Rmail-mbox never displays it due to buffer swapping. If
4116 ;; the test is ever re-introduced, be sure to handle saving of
4117 ;; Rmail files.
4124 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4125 Normally delete only if the file was written by this Emacs since
4126 the last real save, but optional arg FORCE non-nil means delete anyway."
4140 "Normal hook that is run before a buffer is saved to its file."
4146 "Normal hook that is run after a buffer is saved to its file."
4152 "If non-nil, use this coding system for saving the buffer.
4153 More precisely, use this coding system in place of the
4154 value of `buffer-file-coding-system', when saving the buffer.
4155 Calling `write-region' for any purpose other than saving the buffer
4156 will still use `buffer-file-coding-system'; this variable has no effect
4163 "Save the current buffer in its visited file, if it has been modified.
4164 The hooks `write-contents-functions' and `write-file-functions' get a chance
4165 to do the job of saving; if they do not, then the buffer is saved in
4166 the visited file in the usual way.
4167 Before and after saving the buffer, this function runs
4168 `before-save-hook' and `after-save-hook', respectively."
4171 ;; In an indirect buffer, save its base buffer instead.
4176 setmodes)
4177 ;; If buffer has no file name, ask user for one.
4184 ;; Signal an error if the user specified the name of an
4185 ;; existing directory.
4188 filename))
4190 ;; Signal an error if the specified name refers to a
4191 ;; non-existing directory.
4221 ;; Support VC version backups.
4227 ;; If a hook returned t, file is already "written".
4228 ;; Otherwise, write it the usual way now.
4230 ;; Now we have saved the current buffer. Let's make sure
4231 ;; that buffer-file-coding-system is fixed to what
4232 ;; actually used for saving by binding it locally.
4242 ;; If the auto-save file was recent before this command,
4243 ;; delete it now.
4245 ;; Support VC `implicit' locking.
4250 ;; This does the "real job" of writing a buffer into its visited file
4251 ;; and making a backup file. This is what is normally done
4252 ;; but inhibited if one of write-file-functions returns non-nil.
4253 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4265 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4279 buffer-file-name)))
4293 ;; Write temp name, then rename it.
4294 ;; This requires write access to the containing dir,
4295 ;; which is why we don't try it if we don't have that access.
4297 tempname succeed
4300 ;; Create temp files with strict access rights. It's easy to
4301 ;; loosen them later, whereas it's impossible to close the
4302 ;; time-window of loose permissions otherwise.
4307 ;; Try various temporary names.
4308 ;; This code follows the example of make-temp-file,
4309 ;; but it calls write-region in the appropriate way
4310 ;; for saving the buffer.
4316 ;; Pass in nil&nil rather than point-min&max
4317 ;; cause we're saving the whole buffer.
4318 ;; write-region-annotate-functions may use it.
4320 tempname nil realname
4322 nil)
4324 ;; The file was somehow created by someone else between
4325 ;; `make-temp-name' and `write-region', let's try again.
4326 nil)
4328 ;; Reset the umask.
4330 ;; If we failed, restore the buffer's modtime.
4333 ;; Since we have created an entirely new file,
4334 ;; make sure it gets the right permission bits set.
4338 buffer-file-name)))
4339 ;; We succeeded in writing the temp file,
4340 ;; so rename it.
4342 ;; If file not writable, see if we can make it writable
4343 ;; temporarily while we write it.
4344 ;; But no need to do so if we have just backed it up
4345 ;; (setmodes is set) because that says we're superseding.
4347 ;; Change the mode back, after writing.
4353 ;; Pass in nil&nil rather than point-min&max to indicate
4354 ;; we're saving the buffer rather than just a region.
4355 ;; write-region-annotate-functions may make us of it.
4357 buffer-file-name nil t buffer-file-truename)
4359 ;; If we get an error writing the new file, and we made
4360 ;; the backup by renaming, undo the backing-up.
4365 setmodes))
4368 "View the differences between BUFFER and its associated file.
4369 This requires the external program `diff' to be in your `exec-path'."
4383 ;; Display that message for 1 second so that user can read it
4384 ;; in the minibuffer.
4386 ;; return always nil, so that save-buffers-kill-emacs will not move
4387 ;; over to the next unsaved buffer when calling `d'.
4388 nil)
4391 `((?\C-r
4398 ;; Return nil to ask about BUF again.
4399 nil)
4411 ;; Return nil to ask about BUF again.
4412 nil)
4422 "Save some modified file-visiting buffers. Asks user about each one.
4423 You can answer `y' to save, `n' not to save, `C-r' to look at the
4424 buffer in question with `view-buffer' before deciding or `d' to
4425 view the differences using `diff-buffer-with-file'.
4427 Optional argument (the prefix) non-nil means save all with no questions.
4428 Optional second argument PRED determines which buffers are considered:
4429 If PRED is nil, all the file-visiting buffers are considered.
4430 If PRED is t, then certain non-file buffers will also be considered.
4431 If PRED is a zero-argument function, it indicates for each buffer whether
4432 to consider it or not when called with that buffer current.
4434 See `save-some-buffers-action-alist' if you want to
4435 change the additional actions you can take on files."
4439 files-done abbrevs-done)
4441 ;; First save any buffers that we're supposed to save unconditionally.
4442 ;; That way the following code won't ask about them.
4447 ;; Ask about those buffers that merit it,
4448 ;; and record the number thus saved.
4452 ;; Note that killing some buffers may kill others via
4453 ;; hooks (e.g. Rmail and its viewing buffer).
4466 t
4478 save-some-buffers-action-alist))
4479 ;; Maybe to save abbrevs, and record whether
4480 ;; we either saved them or asked to.
4486 abbrev-file-name)))
4488 ;; Don't keep bothering user if he says no.
4493 "(Some special files were saved without asking)"
4495 \f
4497 "Mark current buffer as unmodified, not needing to be saved.
4500 It is not a good idea to use this function in Lisp programs, because it
4501 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4508 "Change whether this buffer is read-only.
4509 With prefix argument ARG, make the buffer read-only if ARG is
4510 positive, otherwise make it writable. If buffer is read-only
4511 and `view-read-only' is non-nil, enter view mode."
4516 nil ; do nothing.
4517 ;; Toggle.
4524 ;; If view-mode is already active, `view-mode-enter' is a nop.
4536 "Insert contents of file FILENAME into buffer after point.
4537 Set mark after the inserted text.
4539 This function is meant for the user to run interactively.
4540 Don't call it from programs! Use `insert-file-contents' instead.
4541 \(Its calling sequence is different; see its documentation)."
4546 "Append the contents of the region to the end of file FILENAME.
4547 When called from a function, expects three arguments,
4548 START, END and FILENAME. START and END are normally buffer positions
4549 specifying the part of the buffer to write.
4550 If START is nil, that means to use the entire buffer contents.
4551 If START is a string, then output that string to the file
4552 instead of any buffer contents; END is ignored.
4554 This does character code conversion and applies annotations
4555 like `write-region' does."
4560 "Return most recent backup file for FILENAME or nil if no backups exist."
4561 ;; `make-backup-file-name' will get us the right directory for
4562 ;; ordinary or numeric backups. It might create a directory for
4563 ;; backups as a side-effect, according to `backup-directory-alist'.
4570 tem)
4579 newest))
4582 "Rename current buffer to a similar name not already taken.
4583 This function is useful for creating multiple shell process buffers
4584 or multiple mail buffers, etc."
4592 ;; If the existing buffer name has a <NNN>,
4593 ;; which isn't part of the file name (if any),
4594 ;; then get rid of that.
4600 "Create the directory DIR and any nonexistent parent dirs.
4601 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4603 Interactively, the default choice of directory to create
4604 is the current default directory for file names.
4605 That is useful when you have visited a file in a nonexistent directory.
4607 Noninteractively, the second (optional) argument PARENTS says whether
4608 to create parent directories if they don't exist. Interactively,
4609 this happens by default."
4612 nil nil)
4613 t))
4614 ;; If default-directory is a remote directory,
4615 ;; make sure we find its make-directory handler.
4623 create-list)
4625 ;; If directory is its own parent, then we can't
4626 ;; keep looping forever
4637 "Delete the directory named DIRECTORY. Does not follow symlinks.
4638 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well."
4642 "Delete directory: "
4643 default-directory default-directory nil nil))))
4649 nil))))
4650 ;; If default-directory is a remote directory,
4651 ;; make sure we find its delete-directory handler.
4662 ;; We do not want to delete "." and "..".
4667 \f
4670 "Function to use to revert this buffer, or nil to do the default.
4671 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4676 "Function to use to insert contents when reverting this buffer.
4677 Gets two args, first the nominal file name to use,
4678 and second, t if reading the auto-save file.
4683 "Function to check whether a non-file buffer needs reverting.
4684 This should be a function with one optional argument NOCONFIRM.
4685 Auto Revert Mode passes t for NOCONFIRM. The function should return
4686 non-nil if the buffer should be reverted. A return value of
4687 `fast' means that the need for reverting was not checked, but
4688 that reverting the buffer is fast. The buffer is current when
4689 this function is called.
4691 The idea behind the NOCONFIRM argument is that it should be
4692 non-nil if the buffer is going to be reverted without asking the
4693 user. In such situations, one has to be careful with potentially
4694 time consuming operations.
4696 For more information on how this variable is used by Auto Revert mode,
4700 "Normal hook for `revert-buffer' to run before reverting.
4701 If `revert-buffer-function' is used to override the normal revert
4705 "Normal hook for `revert-buffer' to run after reverting.
4706 Note that the hook value that it runs is the value that was in effect
4707 before reverting; that makes a difference if you have buffer-local
4708 hook functions.
4710 If `revert-buffer-function' is used to override the normal revert
4716 "Replace current buffer text with the text of the visited file on disk.
4717 This undoes all changes since the file was visited or saved.
4718 With a prefix argument, offer to revert from latest auto-save file, if
4719 that is more recent than the visited file.
4721 This command also implements an interface for special buffers
4722 that contain text which doesn't come from a file, but reflects
4723 some other data instead (e.g. Dired buffers, `buffer-list'
4724 buffers). This is done via the variable `revert-buffer-function'.
4725 In these cases, it should reconstruct the buffer contents from the
4726 appropriate data.
4728 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4729 to revert from the auto-save file when this is nil. Note that the
4730 sense of this argument is the reverse of the prefix argument, for the
4731 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4732 to nil.
4734 Optional second argument NOCONFIRM means don't ask for confirmation
4735 at all. \(The variable `revert-without-query' offers another way to
4736 revert buffers without querying for confirmation.)
4738 Optional third argument PRESERVE-MODES non-nil means don't alter
4739 the files modes. Normally we reinitialize them using `normal-mode'.
4741 If the value of `revert-buffer-function' is non-nil, it is called to
4742 do all the work for this command. Otherwise, the hooks
4743 `before-revert-hook' and `after-revert-hook' are run at the beginning
4744 and the end, and if `revert-buffer-insert-file-contents-function' is
4745 non-nil, it is called instead of rereading visited file contents."
4747 ;; I admit it's odd to reverse the sense of the prefix argument, but
4748 ;; there is a lot of code out there which assumes that the first
4749 ;; argument should be t to avoid consulting the auto-save file, and
4750 ;; there's no straightforward way to encourage authors to notice a
4751 ;; reversal of the argument sense. So I'm just changing the user
4752 ;; interface, but leaving the programmatic interface the same.
4760 buffer-auto-save-file-name
4765 buffer-auto-save-file-name
4766 buffer-file-name)))
4776 file-name)))
4778 ;; If file was backed up but has changed since,
4779 ;; we shd make another backup.
4783 ;; Effectively copy the after-revert-hook status,
4784 ;; since after-find-file will clobber it.
4787 after-revert-hook))
4792 ;; Get rid of all undo records for this buffer.
4794 ;; Don't make undo records for the reversion.
4797 file-name auto-save-p)))
4800 "File %s no longer exists!"
4802 file-name))
4805 "File %s no longer readable!"
4807 file-name))
4809 ;; Bind buffer-file-name to nil
4810 ;; so that we don't try to lock the file.
4816 ;; Auto-saved file should be read by Emacs'
4817 ;; internal coding.
4821 buffer-file-coding-system-explicit
4824 coding-system-for-read
4826 coding-system-for-read)
4828 ;; As a coding system suitable for multibyte
4829 ;; buffer is specified, make the current
4830 ;; buffer multibyte.
4833 ;; This force after-insert-file-set-coding
4834 ;; (called from insert-file-contents) to set
4835 ;; buffer-file-coding-system to a proper value.
4838 ;; Note that this preserves point in an intelligent way.
4842 nil nil t))
4844 nil nil t)))))
4845 ;; Recompute the truename in case changes in symlinks
4846 ;; have changed the truename.
4850 ;; Run after-revert-hook as it was before we reverted.
4854 local-hook)
4857 t))))))
4860 "Recover the visited file--get contents from its last auto-save file."
4865 "Visit file FILE, but get contents from its last auto-save file."
4866 ;; Actually putting the file name in the minibuffer should be used
4867 ;; only rarely.
4868 ;; Not just because users often use the default.
4888 ;; Use insert-directory-safely, not insert-directory,
4889 ;; because these files might not exist. In particular,
4890 ;; FILE might not exist if the auto-save file was for
4891 ;; a buffer that didn't visit a file, such as "*mail*".
4892 ;; The code in v20.x called `ls' directly, so we need
4893 ;; to emulate what `ls' did in that case.
4899 ;; Keep the current buffer-file-coding-system.
4901 ;; Auto-saved file should be read with special coding.
4910 "Recover auto save files from a previous Emacs session.
4911 This command first displays a Dired buffer showing you the
4912 previous sessions that you could recover from.
4913 To choose one, move point to the proper line and then type C-c C-c.
4914 Then you'll be asked about a number of files to recover."
4924 auto-save-list-file-prefix)))
4925 t)
4934 ;; Each line starts with a space
4935 ;; so that Font Lock mode won't highlight the first character.
4944 "Choose one saved session to recover auto-save files from.
4945 This command is used in the special Dired buffer created by
4948 ;; Get the name of the session file to recover from.
4950 files
4956 ;; Read in the auto-save-list file.
4960 ;; Loop thru the text of that file
4961 ;; and get out the names of the files to recover.
4965 ;; This is a pair of lines for a non-file-visiting buffer.
4966 ;; Get the auto-save file name and manufacture
4967 ;; a "visited file name" from that.
4970 ;; If there is no auto-save file name, the
4971 ;; auto-save-list file is probably corrupted.
4984 ;; This pair of lines is a file-visiting
4985 ;; buffer. Use the visited file name.
4995 ;; Ignore a file if its auto-save file does not exist now.
4999 ;; The file contains a pair of line for each auto-saved buffer.
5000 ;; The first line of the pair contains the visited file name
5001 ;; or is empty if the buffer was not visiting a file.
5002 ;; The second line is the auto-save file name.
5010 files
5016 "Kill BUFFER if confirmed."
5024 "Kill some buffers. Asks the user whether to kill each one of them.
5025 Non-interactively, if optional argument LIST is non-nil, it
5026 specifies the list of buffers to kill, asking for approval for each one."
5034 ; if we killed the base buffer.
5041 "Kill buffers whose name matches the specified REGEXP.
5042 The optional second argument indicates whether to kill internal buffers too."
5051 \f
5053 "Toggle auto-saving of contents of current buffer.
5054 With prefix argument ARG, turn auto-saving on if positive, else off."
5059 ;; If auto-save is off because buffer has shrunk,
5060 ;; then toggling should turn it on.
5065 buffer-file-name
5067 ;; If -1 was stored here, to temporarily turn off saving,
5068 ;; turn it back on.
5074 buffer-auto-save-file-name)
5077 "Adjust current buffer's auto save file name for current conditions.
5078 Also rename any existing auto save file, if it was made in this session."
5090 "Return file name to use for auto-saves of current buffer.
5091 Does not consider `auto-save-visited-file-name' as that variable is checked
5092 before calling this function. You can redefine this for customization.
5093 See also `auto-save-file-name-p'."
5101 result uniq)
5102 ;; Apply user-specified translations
5103 ;; to the file name.
5107 filename)
5117 filename))))
5122 ;; We truncate the file name to DOS 8+3 limits
5123 ;; before doing anything else, because the regexp
5124 ;; passed to string-match below cannot handle
5125 ;; extensions longer than 3 characters, multiple
5126 ;; dots, and other atrocities.
5131 fn)
5136 "#"
5139 ;; Make sure auto-save file names don't contain characters
5140 ;; invalid for the underlying filesystem.
5142 ;; Don't modify remote (ange-ftp) filenames
5145 result))))
5147 ;; Deal with buffers that don't have any associated files. (Mail
5148 ;; mode tends to create a good number of these.)
5152 file-name)
5153 ;; Restrict the characters used in the file name to those which
5154 ;; are known to be safe on all filesystems, url-encoding the
5155 ;; rest.
5156 ;; We do this on all platforms, because even if we are not
5157 ;; running on DOS/Windows, the current directory may be on a
5158 ;; mounted VFAT filesystem, such as a USB memory stick.
5162 ;; For multibyte characters, this will produce more than
5163 ;; 2 hex digits, so is not true URL encoding.
5167 ;; Generate the file name.
5173 ;; Try a few alternative directories, to get one we can
5174 ;; write it.
5180 ;; Don't modify remote (ange-ftp) filenames
5182 ;; The call to convert-standard-filename is in case
5183 ;; buffer-name includes characters not allowed by the
5184 ;; DOS/Windows filesystems. make-temp-file writes to the
5185 ;; file it creates, so we must fix the file name _before_
5186 ;; make-temp-file is called.
5188 fname))
5190 ;; make-temp-file creates the file,
5191 ;; but we don't want it to exist until we do an auto-save.
5195 file-name)))
5198 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5199 FILENAME should lack slashes. You can redefine this for customization."
5201 \f
5203 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5204 The generated regexp will match a filename only if the filename
5205 matches that wildcard according to shell rules. Only wildcards known
5206 by `sh' are supported."
5208 ;; Copy the initial run of non-special characters.
5211 ;; If no special characters, we're almost done.
5215 j)
5217 result
5238 ;; Found "[^". Insert a `\0' character
5239 ;; (which cannot happen in a filename)
5240 ;; into the character class, so that `^'
5241 ;; is not the first character after `[',
5242 ;; and thus non-special in a regexp.
5247 ;; I don't think `]' can appear in a
5248 ;; character class in a wildcard, but
5249 ;; let's be general here.
5256 i
5269 ;; Shell wildcards should match the entire filename,
5270 ;; not its part. Make the regexp say so.
5272 \f
5274 "-CF"
5275 "Switches for `list-directory' to pass to `ls' for brief listing."
5280 "-l"
5281 "Switches for `list-directory' to pass to `ls' for verbose listing."
5286 "Expand wildcard pattern PATTERN.
5287 This returns a list of file names which match the pattern.
5289 If PATTERN is written as an absolute file name,
5290 the values are absolute also.
5292 If PATTERN is written as a relative file name, it is interpreted
5293 relative to the current default directory, `default-directory'.
5294 The file names returned are normally also relative to the current
5295 default directory. However, if FULL is non-nil, they are absolute."
5299 ;; A list of all dirs that DIRPART specifies.
5300 ;; This can be more than one dir
5301 ;; if DIRPART contains wildcards.
5306 contents)
5311 ;; Filter out "." and ".."
5316 name))
5323 this-dir-contents)
5324 this-dir-contents)
5325 contents))))
5327 contents)))
5330 "Display a list of files in or matching DIRNAME, a la `ls'.
5331 DIRNAME is globbed by the shell if necessary.
5332 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5333 Actions controlled by variables `list-directory-brief-switches'
5334 and `list-directory-verbose-switches'."
5338 nil default-directory nil)
5339 pfx)))
5341 list-directory-brief-switches))
5342 buffer)
5355 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5363 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5365 PATTERN is assumed to represent a file-name wildcard suitable for the
5366 underlying filesystem. For Unix and GNU/Linux, each character from the
5368 the parts of the pattern which don't include wildcard characters are
5369 quoted with double quotes.
5372 on Windows), so PATTERN can use them to quote wildcard characters that
5373 need to be passed verbatim to shell commands."
5377 ;; DOS/Windows don't allow `"' in file names. So if the
5378 ;; argument has quotes, we can safely assume it is already
5379 ;; quoted by the caller.
5381 ;; We quote [&()#$'] in case their shell is a port of a
5382 ;; Unixy shell. We quote [,=+] because stock DOS and
5383 ;; Windows shells require that in some cases, such as
5384 ;; passing arguments to batch files that use positional
5385 ;; arguments like %1.
5387 pattern
5390 end)
5407 pattern))))
5414 "Program to get the amount of free space on a file system.
5415 We assume the output has the format of `df'.
5416 The value of this variable must be just a command name or file name;
5417 if you want to specify options, use `directory-free-space-args'.
5419 A value of nil disables this feature.
5421 If the function `file-system-info' is defined, it is always used in
5422 preference to the program given by this variable."
5428 "Options to use when running `directory-free-space-program'."
5433 "Return the amount of free space on directory DIR's file system.
5434 The result is a string that gives the number of free 1KB blocks,
5435 or nil if the system call or the program which retrieve the information
5436 fail. It returns also nil when DIR is a remote directory.
5438 This function calls `file-system-info' if it is available, or invokes the
5439 program specified by `directory-free-space-program' if that is non-nil."
5441 ;; Try to find the number of free blocks. Non-Posix systems don't
5442 ;; always have df, but might have an equivalent system call.
5451 ;; Avoid failure if the default directory does
5452 ;; not exist (Bug#2631, Bug#3911).
5455 nil t nil
5456 directory-free-space-args
5457 dir)
5459 ;; Usual format is a header line followed by a line of
5460 ;; numbers.
5465 ;; Move to the end of the "available blocks" number.
5468 ;; Copy it into AVAILABLE.
5473 ;; The following expression replaces `dired-move-to-filename-regexp'.
5477 ;; In some locales, month abbreviations are as short as 2 letters,
5478 ;; and they can be followed by ".".
5479 ;; In Breton, a month name can include a quote character.
5492 s "+"
5495 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5496 ;; omits the Kanji characters after month and day-of-month.
5497 ;; On Mac OS X 10.3, the date format in East Asian locales is
5498 ;; day-of-month digits followed by month digits.
5504 ;; The "[0-9]" below requires the previous column to end in a digit.
5505 ;; This avoids recognizing `1 may 1997' as a date in the line:
5506 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5508 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5509 ;; The ".*" below finds the last match if there are multiple matches.
5510 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5511 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5513 ;; vc dired listings provide the state or blanks between file
5514 ;; permissions and date. The state is always surrounded by
5515 ;; parantheses:
5516 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5517 ;; This is not supported yet.
5521 "Regular expression to match up to the file name in a directory listing.
5522 The default value is designed to recognize dates and times
5527 ;; insert-directory
5528 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5529 ;; FULL-DIRECTORY-P is nil.
5530 ;; The single line of output must display FILE's name as it was
5531 ;; given, namely, an absolute path name.
5532 ;; - must insert exactly one line for each file if WILDCARD or
5533 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5534 ;; before the file lines, plus optional text after the file lines.
5535 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5536 ;; allowed.
5537 ;; File lines should display the basename.
5538 ;; - must be consistent with
5539 ;; - functions dired-move-to-filename, (these two define what a file line is)
5540 ;; dired-move-to-end-of-filename,
5541 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5542 ;; dired-insert-headerline
5543 ;; dired-after-subdir-garbage (defines what a "total" line is)
5544 ;; - variable dired-subdir-regexp
5545 ;; - may be passed "--dired" as the first argument in SWITCHES.
5546 ;; Filename handlers might have to remove this switch if their
5547 ;; "ls" command does not support it.
5549 "Insert directory listing for FILE, formatted according to SWITCHES.
5550 Leaves point after the inserted text.
5551 SWITCHES may be a string of options, or a list of strings
5552 representing individual options.
5553 Optional third arg WILDCARD means treat FILE as shell wildcard.
5554 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5555 switches do not contain `d', so that a full listing is expected.
5557 This works by running a directory listing program
5558 whose name is in the variable `insert-directory-program'.
5559 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5561 When SWITCHES contains the long `--dired' option, this function
5562 treats it specially, for the sake of dired. However, the
5563 normally equivalent short `-D' option is just passed on to
5564 `insert-directory-program', as any other option."
5565 ;; We need the directory in order to find the right handler.
5570 wildcard full-directory-p)
5573 ;; Read the actual directory using `insert-directory-program'.
5574 ;; RESULT gets the status code.
5576 ;; putting text property `dired-filename, decode one
5577 ;; bunch by one to preserve that property.
5579 ;; This is to control encoding the arguments in call-process.
5583 default-file-name-coding-system))))
5586 ;; Run ls in the directory part of the file pattern
5587 ;; using the last component as argument.
5594 shell-file-name nil t nil
5595 "-c"
5597 ""
5599 insert-directory-program
5600 " -d "
5602 switches
5604 " -- "
5605 ;; Quote some characters that have
5606 ;; special meanings in shells; but
5607 ;; don't quote the wildcards--we want
5608 ;; them to be special. We also
5609 ;; currently don't quote the quoting
5610 ;; characters in case people want to
5611 ;; use them explicitly to quote
5612 ;; wildcard characters.
5614 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5615 ;; directory if FILE is a symbolic link.
5617 insert-directory-program nil t nil
5621 ;; Split the switches at any spaces so we can
5622 ;; pass separate options as separate args.
5624 ;; Avoid lossage if FILE starts with `-'.
5632 file))))))))
5634 ;; If we got "//DIRED//" in the output, it means we got a real
5635 ;; directory listing, even if `ls' returned nonzero.
5636 ;; So ignore any errors.
5649 ;; The first time ls returns an error,
5650 ;; find the version numbers of ls,
5651 ;; and set insert-directory-ls-version
5652 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5653 ;; is equal or if the info cannot be obtained.
5654 ;; (That can mean it isn't GNU ls.)
5664 comparison)
5680 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5684 ;; If `insert-directory-program' failed, signal an error.
5686 ;; Delete the error message it may have output.
5688 ;; On non-Posix systems, we cannot open a directory, so
5689 ;; don't even try, because that will always result in
5690 ;; the ubiquitous "Access denied". Instead, show the
5691 ;; command line so the user can try to guess what went wrong.
5696 insert-directory-program
5698 file result)
5699 ;; Unix. Access the file to get a suitable error.
5706 ;; The following overshoots by one line for an empty
5707 ;; directory listed with "--dired", but without "-a"
5708 ;; switch, where the ls output contains a
5709 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5710 ;; We take care of that case later.
5718 error-lines)
5719 ;; Find all the lines that are error messages,
5720 ;; and record the bounds of each one.
5727 ;; Now read the numeric positions of file names.
5734 error-lines))
5737 error-lines)))
5739 ;; End is followed by \n or by " -> ".
5741 ;; It seems that we can't trust ls's output as to
5742 ;; byte positions of filenames.
5748 ;; Take care of the case where the ls output contains a
5749 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5750 ;; and we went one line too far back (see above).
5755 ;; Now decode what read if necessary.
5757 file-name-coding-system
5758 default-file-name-coding-system
5760 coding-no-eol
5761 val pos)
5765 ;; If no coding system is specified or detection is
5766 ;; requested, detect the coding.
5780 ;; Force no eol conversion on a file name, so
5781 ;; that CR is preserved.
5789 ;; Try to insert the amount of free space.
5792 ;; First find the line to put it on.
5796 ;; Replace "total" with "used", to avoid confusion.
5802 "Convert `ls --dired' file name position value POS to a buffer position.
5803 File name position values returned in ls --dired output
5804 count only stdout; they don't count the error messages sent to stderr.
5805 So this function converts to them to real buffer positions.
5806 ERROR-LINES is a list of buffer positions of error message lines,
5807 of the form (START END)."
5811 pos)
5815 "Insert directory listing for FILE, formatted according to SWITCHES.
5817 Like `insert-directory', but if FILE does not exist, it inserts a
5818 message to that effect instead of signaling an error."
5821 ;; Simulate the message printed by `ls'.
5825 "Functions to call with no arguments to query about killing Emacs.
5826 If any of these functions returns nil, killing Emacs is cancelled.
5827 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5831 "How to ask for confirmation when leaving Emacs.
5832 If nil, the default, don't ask at all. If the value is non-nil, it should
5833 be a predicate function such as `yes-or-no-p'."
5841 "Offer to save each buffer, then kill this Emacs process.
5842 With prefix ARG, silently save all file-visiting buffers, then kill."
5851 ;; process-list is not defined on MSDOS.
5853 active)
5862 ;; Query the user for other things, perhaps.
5869 "Offer to save each buffer, then kill the current connection.
5870 If the current frame has no client, kill Emacs itself.
5872 With prefix ARG, silently save all file-visiting buffers, then kill.
5874 If emacsclient was started with a list of filenames to edit, then
5875 only these files will be asked to be saved."
5880 \f
5881 ;; We use /: as a prefix to "quote" a file name
5882 ;; so that magic file name handlers will not apply to it.
5886 file-name-handler-alist))
5888 ;; We depend on being the last handler on the list,
5889 ;; so that anything else which does need handling
5890 ;; has been handled already.
5891 ;; So it is safe for us to inhibit *all* magic file name handlers.
5900 default-directory))
5901 ;; Get a list of the indices of the args which are file names.
5904 ;; The first six are special because they
5905 ;; return a file name. We want to include the /:
5906 ;; in the return value.
5907 ;; So just avoid stripping it in the first place.
5914 ;; `identity' means just return the first arg
5915 ;; not stripped of its quoting.
5917 ;; `add' means add "/:" to the result.
5919 ;; `quote' means add "/:" to buffer-file-name.
5921 ;; `unquote-then-quote' means set buffer-file-name
5922 ;; temporarily to unquoted filename.
5924 ;; List the arguments which are filenames.
5932 ;; For all other operations, treat the first argument only
5933 ;; as the file name.
5935 method
5936 ;; Copy ARGUMENTS so we can replace elements in it.
5940 ;; Strip off the /: from the file names that have it.
5948 "/"
5964 res))
5967 \f
5968 ;; Symbolic modes and read-file-modes.
5971 "Convert CHAR to a numeric bit-mask for extracting mode bits.
5972 CHAR is in [ugoa] and represents the category of users (Owner, Group,
5973 Others, or All) for whom to produce the mask.
5974 The bit-mask that is returned extracts from mode bits the access rights
5975 for the specified category of users."
5983 "Convert CHAR to a numeric value of mode bits.
5984 CHAR is in [rwxXstugo] and represents symbolic access permissions.
5985 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
5992 ;; Rights relative to the previous file modes.
6003 "Convert a symbolic mode string specification to an equivalent number.
6005 WHO-MASK is the bit-mask specifying the category of users to which to
6006 apply the access permissions. See `file-modes-char-to-who'.
6007 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6008 RIGHTS request to add, remove, or set permissions based on existing ones,
6015 char-right)
6022 num-rights
6026 op char-right)))
6027 num-rights))
6030 "Convert symbolic file modes to numeric file modes.
6031 MODES is the string to convert, it should match
6034 notation.
6035 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6036 MODES request to add, remove, or set permissions based on existing ones,
6050 num-who num-modes)
6053 num-modes)))
6056 "Read file modes in octal or symbolic notation and return its numeric value.
6057 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6058 ORIG-FILE is the name of a file on whose mode bits to base returned
6059 permissions if what user types requests to add, remove, or set permissions
6075 nil nil default)))
6081 \f
6082 ;; Trashcan handling.
6084 "Directory for `move-file-to-trash' to move files and directories to.
6085 This directory is only used when the function `system-move-file-to-trash'
6086 is not defined.
6087 Relative paths are interpreted relative to `default-directory'.
6088 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6098 "Move the file (or directory) named FILENAME to the trash.
6099 When `delete-by-moving-to-trash' is non-nil, this function is
6100 called by `delete-file' and `delete-directory' instead of
6101 deleting files outright.
6103 If the function `system-move-file-to-trash' is defined, call it
6104 with FILENAME as an argument.
6105 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6106 directory.
6107 Otherwise, trash FILENAME using the freedesktop.org conventions,
6108 like the GNOME, KDE and XFCE desktop environments. Emacs only
6112 ;; If `trash-directory' is non-nil, move the file there.
6116 trash-dir)))
6117 ;; We can't trash a parent directory of trash-directory.
6120 trash-dir filename))
6123 ;; Ensure that the trashed file-name is unique.
6130 ;; If `system-move-file-to-trash' is defined, use it.
6133 ;; Otherwise, use the freedesktop.org method, as specified at
6134 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6145 ;; Check if we have permissions to delete.
6149 ;; The trashed file cannot be the trash dir or its parent.
6152 trash-files-dir filename))
6155 trash-info-dir filename))
6157 ;; Ensure that the trash directory exists; otherwise, create it.
6166 ;; Try to move to trash with .trashinfo undo information
6171 ;; Perform url-encoding on FN. For compatibility with
6172 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6173 ;; for path separators.
6178 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6179 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6192 fn))
6197 ;; Attempt to make .trashinfo file, trying up to 5
6198 ;; times. The .trashinfo file is opened with O_EXCL,
6199 ;; as per trash-spec 0.7, even if that can be a problem
6200 ;; on old NFS versions...
6204 trash-files-dir))
6206 success info-fn)
6211 trash-info-dir))
6219 ;; Uniqify new-fn. (Some file managers do not
6220 ;; like Emacs-style backup file names---e.g. bug
6221 ;; 170956 in Konqueror bug tracker.)
6226 ;; Finally, try to move the file to the trashcan.
6230 \f
6255 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6256 ;;; files.el ends here