| blob | ee03c115cf8f3085b9770059a998ed1e4c043e93 |
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, 2010 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.
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.)
239 "Non-nil means protect against I/O errors while saving files.
240 Some modes set this non-nil in particular buffers.
242 This feature works by writing the new contents into a temporary file
243 and then renaming the temporary file to replace the original.
244 In this way, any I/O error in writing leaves the original untouched,
245 and there is never any instant where the file is nonexistent.
247 Note that this feature forces backups to be made by copying.
248 Yet, at the same time, saving a precious file
249 breaks any hard links between it and other files.
251 This feature is advisory: for example, if the directory in which the
252 file is being saved is not writable, Emacs may ignore a non-nil value
253 of `file-precious-flag' and write directly into the file.
255 See also: `break-hardlink-on-save'."
260 "Non-nil means when saving a file that exists under several names
261 \(i.e., has multiple hardlinks), break the hardlink associated with
262 `buffer-file-name' and write to a new file, so that the other
263 instances of the file are not affected by the save.
265 If `buffer-file-name' refers to a symlink, do not break the symlink.
267 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
268 For example, if the directory in which a file is being saved is not
269 itself writable, then error instead of saving in some
270 hardlink-nonbreaking way.
272 See also `backup-by-copying' and `backup-by-copying-when-linked'."
278 "Control use of version numbers for backup files.
279 When t, make numeric backup versions unconditionally.
280 When nil, make them for files that have some already.
281 The value `never' means do not make them."
291 "When cleaning directory, number of versions to keep."
297 "If t, delete excess backup versions silently.
298 If nil, ask confirmation. Any other value prevents any trimming."
305 "Number of oldest versions to keep when a new numbered backup is made."
311 "Number of newest versions to keep when a new numbered backup is made.
312 Includes the new backup. Must be > 0"
318 "Whether to add a newline automatically at the end of the file.
320 A value of t means do this only when the file is about to be saved.
321 A value of `visit' means do this right after the file is visited.
322 A value of `visit-save' means do it at both of those times.
323 Any other non-nil value means ask user whether to add a newline, when saving.
324 A value of nil means don't add newlines.
326 Certain major modes set this locally to the value obtained
327 from `mode-require-final-newline'."
336 "Whether to add a newline at end of file, in certain major modes.
337 Those modes set `require-final-newline' to this value when you enable them.
338 They do so because they are often used for files that are supposed
339 to end in newlines, and the question is how to arrange that.
341 A value of t means do this only when the file is about to be saved.
342 A value of `visit' means do this right after the file is visited.
343 A value of `visit-save' means do it at both of those times.
344 Any other non-nil value means ask user whether to add a newline, when saving.
346 A value of nil means do not add newlines. That is a risky choice in this
347 variable since this value is used for modes for files that ought to have
348 final newlines. So if you set this to nil, you must explicitly check and
349 add a final newline, whenever you save a file that really needs one."
359 "Non-nil says by default do auto-saving of every file-visiting buffer."
365 ;; Don't put "\\2" inside expand-file-name, since it will be
366 ;; transformed to "/2" on DOS/Windows.
368 "Transforms to apply to buffer file name before making auto-save file name.
369 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
370 REGEXP is a regular expression to match against the file name.
371 If it matches, `replace-match' is used to replace the
372 matching part with REPLACEMENT.
373 If the optional element UNIQUIFY is non-nil, the auto-save file name is
374 constructed by taking the directory part of the replaced file-name,
375 concatenated with the buffer file name with all directory separators
376 changed to `!' to prevent clashes. This will not work
377 correctly if your filesystem truncates the resulting name.
379 All the transforms in the list are tried, in the order they are listed.
380 When one transform applies, its result is final;
381 no further transforms are tried.
383 The default value is set up to put the auto-save file into the
384 temporary directory (see the variable `temporary-file-directory') for
385 editing a remote file.
387 On MS-DOS filesystems without long names this variable is always
388 ignored."
396 "Non-nil means save word abbrevs too when files are saved.
397 If `silently', don't ask the user before saving."
402 "Non-nil means allow `find-file' to visit directories.
403 To visit the directory, `find-file' runs `find-directory-functions'."
408 "List of functions to try in sequence to visit a directory.
409 Each function is called with the directory name as the sole argument
410 and should return either a buffer or nil."
414 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
416 "List of functions to try in sequence to get a file name at point.
417 Each function should return either nil or a file name found at the
418 location of point in the current buffer."
422 ;;;It is not useful to make this a local variable.
423 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
425 "List of functions to be called for `find-file' on nonexistent file.
426 These functions are called as soon as the error is detected.
427 Variable `buffer-file-name' is already set up.
432 ;;;It is not useful to make this a local variable.
433 ;;;(put 'find-file-hooks 'permanent-local t)
436 "List of functions to be called after a buffer is loaded from a file.
437 The buffer's local variables (if any) will have been processed before the
438 functions are called."
445 "List of functions to be called before writing out a buffer to a file.
446 If one of them returns non-nil, the file is considered already written
447 and the rest are not called.
448 These hooks are considered to pertain to the visited file.
449 So any buffer-local binding of this variable is discarded if you change
451 change the major mode.
453 This hook is not run if any of the functions in
454 `write-contents-functions' returns non-nil. Both hooks pertain
455 to how to save a buffer to file, for instance, choosing a suitable
456 coding system and setting mode bits. (See Info
457 node `(elisp)Saving Buffers'.) To perform various checks or
468 "List of functions to be called before writing out a buffer to a file.
469 If one of them returns non-nil, the file is considered already written
470 and the rest are not called and neither are the functions in
471 `write-file-functions'.
473 This variable is meant to be used for hooks that pertain to the
474 buffer's contents, not to the particular visited file; thus,
475 `set-visited-file-name' does not clear this variable; but changing the
476 major mode does clear it.
478 For hooks that _do_ pertain to the particular visited file, use
479 `write-file-functions'. Both this variable and
480 `write-file-functions' relate to how a buffer is saved to file.
481 To perform various checks or updates before the buffer is saved,
488 "Control use of local variables in files you visit.
489 The value can be t, nil, :safe, :all, or something else.
491 A value of t means file local variables specifications are obeyed
492 if all the specified variable values are safe; if any values are
493 not safe, Emacs queries you, once, whether to set them all.
494 \(When you say yes to certain values, they are remembered as safe.)
496 :safe means set the safe variables, and ignore the rest.
497 :all means set all variables, whether safe or not.
498 (Don't set it permanently to :all.)
499 A value of nil means always ignore the file local variables.
501 Any other value means always query you once whether to set them all.
502 \(When you say yes to certain values, they are remembered as safe, but
505 This variable also controls use of major modes specified in
506 a -*- line.
509 always obeys file local variable specifications and the -*- line,
510 and ignores this variable."
511 :risky t
520 "Like `enable-local-variables' but meant for buffer-local bindings.
521 The meaningful values are nil and non-nil. The default is non-nil.
522 If a major mode sets this to nil, buffer-locally, then any local
523 variables list in the file will be ignored.
525 This variable does not affect the use of major modes
530 The value can be t, nil or something else.
531 A value of t means obey `eval' variables.
532 A value of nil means ignore them; anything else means query."
533 :risky t
539 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
548 "Non-nil means buffers visiting files read-only do so in view mode.
549 In fact, this means that all read-only buffers normally have
550 View mode enabled, including buffers that are read-only because
551 you visit a file you cannot alter, and buffers you make read-only
557 "History list of file names entered in the minibuffer.
559 Maximum length of the history list is determined by the value
561 \f
564 "Provides support for ange-ftp host name completion.
565 Runs the usual ange-ftp hook, but only for completion operations."
566 ;; Having this here avoids the need to load ange-ftp when it's not
567 ;; really in use.
573 inhibit-file-name-handlers)))
578 "Convert a standard file's name to something suitable for the OS.
579 This means to guarantee valid names and perhaps to canonicalize
580 certain patterns.
582 FILENAME should be an absolute file name since the conversion rules
583 sometimes vary depending on the position in the file name. E.g. c:/foo
584 is a valid DOS file name, but c:/bar/c:/foo is not.
586 This function's standard definition is trivial; it just returns
587 the argument. However, on Windows and DOS, replace invalid
588 characters. On DOS, make sure to obey the 8.3 limitations.
589 In the native Windows build, turn Cygwin names into native names,
590 and also turn slashes into backslashes if the shell requires it (see
591 `w32-shell-dos-semantics').
593 See Info node `(elisp)Standard File Names' for more details."
597 ;; Replace invalid filename characters with !
601 name)
602 filename))
605 "Read directory name, prompting with PROMPT and completing in directory DIR.
606 Value is not expanded---you must call `expand-file-name' yourself.
607 Default name to DEFAULT-DIRNAME if user exits with the same
608 non-empty string that was inserted by this function.
609 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
610 or just DIR if INITIAL is nil.)
611 If the user exits with an empty minibuffer, this function returns
612 an empty string. (This can only happen if the user erased the
613 pre-inserted contents or if `insert-default-directory' is nil.)
614 Fourth arg MUSTMATCH non-nil means require existing directory's name.
615 Non-nil and non-t means also require confirmation after completion.
616 Fifth arg INITIAL specifies text to start with.
617 DIR should be an absolute directory name. It defaults to
618 the value of `default-directory'."
623 dir))
624 mustmatch initial
627 \f
629 "Show the current default directory."
634 "Value of the CDPATH environment variable, as a list.
638 "Explode a search path into a list of directory names.
639 Directories are separated by occurrences of `path-separator'
640 \(which is colon in GNU and GNU-like systems)."
641 ;; We could use split-string here.
649 nil
654 cd-list)))
657 "Change current directory to given absolute file name DIR."
658 ;; Put the name into directory syntax now,
659 ;; because otherwise expand-file-name may give some bad results.
661 ;; We used to additionally call abbreviate-file-name here, for an
662 ;; unknown reason. Problem is that most buffers are setup
663 ;; without going through cd-absolute and don't call
664 ;; abbreviate-file-name on their default-directory, so the few that
665 ;; do end up using a superficially different directory.
677 "Make DIR become the current buffer's default directory.
678 If your environment includes a `CDPATH' variable, try each one of
679 that list of directories (separated by occurrences of
680 `path-separator') when resolving a relative directory name.
681 The path separator is colon in GNU and GNU-like systems."
684 default-directory default-directory
700 cd-path)
701 nil))
705 "Load the Lisp file named FILE."
706 ;; This is a case where .elc makes a lot of sense.
713 "Search for FILENAME through PATH.
714 If found, return the absolute file name of FILENAME, with its suffixes;
715 otherwise return nil.
716 PATH should be a list of directories to look in, like the lists in
717 `exec-path' or `load-path'.
718 If SUFFIXES is non-nil, it should be a list of suffixes to append to
721 If non-nil, PREDICATE is used instead of `file-readable-p'.
722 PREDICATE can also be an integer to pass to the `access' system call,
723 in which case file-name handlers are ignored. This usage is deprecated.
725 For compatibility, PREDICATE can also be one of the symbols
726 `executable', `readable', `writable', or `exists', or a list of
727 one or more of those symbols."
738 "Do completion for file names passed to `locate-file'."
741 ;; FIXME: maybe we should use completion-file-name-table instead,
742 ;; tho at least for `load', the arg is passed through
743 ;; substitute-in-file-name for historical reasons.
762 string-file dir))
768 string-dir names string-file pred action)))))
771 "Do completion for file names passed to `locate-file'.
772 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
775 string nil action))
780 "Regexp of directory names which stop the search in `locate-dominating-file'.
781 Any directory whose name matches this regexp will be treated like
782 a kind of root directory by `locate-dominating-file' which will stop its search
783 when it bumps into it.
784 The default regexp prevents fruitless and time-consuming attempts to find
785 special files in directories in which filenames are interpreted as hostnames,
788 ;; (defun locate-dominating-files (file regexp)
789 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
790 ;; Stop at the first parent where a matching file is found and return the list
791 ;; of files that that match in this directory."
792 ;; (catch 'found
793 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
794 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
795 ;; (let ((user nil)
796 ;; ;; Abbreviate, so as to stop when we cross ~/.
797 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
798 ;; files)
799 ;; (while (and dir
800 ;; ;; As a heuristic, we stop looking up the hierarchy of
801 ;; ;; directories as soon as we find a directory belonging to
802 ;; ;; another user. This should save us from looking in
803 ;; ;; things like /net and /afs. This assumes that all the
804 ;; ;; files inside a project belong to the same user.
805 ;; (let ((prev-user user))
806 ;; (setq user (nth 2 (file-attributes dir)))
807 ;; (or (null prev-user) (equal user prev-user))))
808 ;; (if (setq files (condition-case nil
809 ;; (directory-files dir 'full regexp 'nosort)
810 ;; (error nil)))
811 ;; (throw 'found files)
812 ;; (if (equal dir
813 ;; (setq dir (file-name-directory
814 ;; (directory-file-name dir))))
815 ;; (setq dir nil))))
816 ;; nil)))
819 "Look up the directory hierarchy from FILE for a file named NAME.
820 Stop at the first parent directory containing a file NAME,
821 and return the directory. Return nil if not found."
822 ;; We used to use the above locate-dominating-files code, but the
823 ;; directory-files call is very costly, so we're much better off doing
824 ;; multiple calls using the code in here.
825 ;;
826 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
827 ;; `name' in /home or in /.
831 ;; `user' is not initialized outside the loop because
832 ;; `file' may not exist, so we may have to walk up part of the
833 ;; hierarchy before we find the "initial UID".
835 try)
838 ;; FIXME: Disabled this heuristic because it is sometimes
839 ;; inappropriate.
840 ;; As a heuristic, we stop looking up the hierarchy of
841 ;; directories as soon as we find a directory belonging
842 ;; to another user. This should save us from looking in
843 ;; things like /net and /afs. This assumes that all the
844 ;; files inside a project belong to the same user.
845 ;; (let ((prev-user user))
846 ;; (setq user (nth 2 (file-attributes file)))
847 ;; (and prev-user (not (equal user prev-user))))
855 root))
859 "Search for COMMAND in `exec-path' and return the absolute file name.
860 Return nil if COMMAND is not found anywhere in `exec-path'."
861 ;; Use 1 rather than file-executable-p to better match the behavior of
862 ;; call-process.
866 "Load the Emacs Lisp library named LIBRARY.
867 This is an interface to the function `load'. LIBRARY is searched
868 for in `load-path', both with and without `load-suffixes' (as
869 well as `load-file-rep-suffixes').
871 See Info node `(emacs)Lisp Libraries' for more details.
872 See `load-file' for a different interface to `load'."
876 load-path
881 "Test whether FILE specifies a location on a remote system.
882 Returns nil or a string identifying the remote connection (ideally
883 a prefix of FILE). For example, the remote identification for filename
886 less reliable than accessing local files.
887 Furthermore, relative file names do not work across remote connections.
889 IDENTIFICATION specifies which part of the identification shall
890 be returned as string. IDENTIFICATION can be the symbol
891 `method', `user', `host' or `localname'; any other value is
892 handled like nil and means to return the complete identification
893 string.
895 If CONNECTED is non-nil, the function returns an identification only
896 if FILE is located on a remote system, and a connection is established
897 to that remote system.
899 `file-remote-p' will never open a connection on its own."
903 nil)))
906 "Copy the file FILE into a temporary file on this machine.
907 Returns the name of the local copy, or nil, if FILE is directly
908 accessible."
909 ;; This formerly had an optional BUFFER argument that wasn't used by
910 ;; anything.
914 nil)))
917 "Return the truename of FILENAME, which should be absolute.
918 The truename of a file name is found by chasing symbolic links
919 both at the level of the file and at the level of the directories
920 containing it, until no links are left at any level.
923 ;; COUNTER and PREV-DIRS are only used in recursive calls.
924 ;; COUNTER can be a cons cell whose car is the count of how many
925 ;; more links to chase before getting an error.
926 ;; PREV-DIRS can be a cons cell whose car is an alist
927 ;; of truenames we've just recently computed.
941 ;; For speed, remove the ange-ftp completion handler from the list.
942 ;; We know it's not needed here.
943 ;; For even more speed, do this only on the outermost call.
950 ;; andrewi@harlequin.co.uk - none of the following code (except for
951 ;; invoking the file-name handler) currently applies on Windows
952 ;; (ie. there are no native symlinks), but there is an issue with
953 ;; case differences being ignored by the OS, and short "8.3 DOS"
954 ;; name aliases existing for all files. (The short names are not
955 ;; reported by directory-files, but can be used to refer to files.)
956 ;; It seems appropriate for file-truename to resolve these issues in
957 ;; the most natural way, which on Windows is to call the function
958 ;; `w32-long-file-name' - this returns the exact name of a file as
959 ;; it is stored on disk (expanding short name aliases with the full
960 ;; name in the process).
963 ;; For file name that has a special handler, call handler.
964 ;; This is so that ange-ftp can save time by doing a no-op.
967 ;; If filename contains a wildcard, newname will be the old name.
969 ;; If filename exists, use the long name. If it doesn't exist,
970 ;; drill down until we find a directory that exists, and use
971 ;; the long name of that, with the extra non-existent path
972 ;; components concatenated.
974 missing rest)
977 ;; Include the preceding directory separator in the missing
978 ;; part so subsequent recursion on the rest works.
983 ""
988 ;; If this file directly leads to a link, process that iteratively
989 ;; so that we don't use lots of stack.
995 ;; For file name that has a special handler, call handler.
996 ;; This is so that ange-ftp can save time by doing a no-op.
999 done t)
1001 target dirfile)
1002 ;; Get the truename of the directory.
1004 ;; If these are equal, we have the (or a) root directory.
1006 ;; If this is the same dir we last got the truename for,
1007 ;; save time--don't recalculate.
1017 done t)
1020 done t)
1021 ;; Put it back on the file name.
1023 ;; Is the file name the name of a link?
1026 ;; Yes => chase that link, then start all over
1027 ;; since the link may point to a directory name that uses links.
1028 ;; We can't safely use expand-file-name here
1029 ;; since target might look like foo/../bar where foo
1030 ;; is itself a link. Instead, we handle . and .. above.
1033 target
1035 done nil)
1036 ;; No, we are done!
1038 filename))
1041 "Chase links in FILENAME until a name that is not a link.
1042 Unlike `file-truename', this does not check whether a parent
1043 directory name is a symbolic link.
1044 If the optional argument LIMIT is a number,
1045 it means chase no more than that many links and then stop."
1053 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1056 ;; Handle `..' by hand, since it needs to work in the
1057 ;; target of any directory symlink.
1058 ;; This code is not quite complete; it does not handle
1059 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1063 ;; Chase links in the default dir of the symlink.
1067 ;; Now find the parent of that dir.
1071 newname))
1074 "Create a temporary file.
1075 The returned file name (created by appending some random characters at the end
1076 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1077 is guaranteed to point to a newly created empty file.
1078 You can then use `write-region' to write new data into the file.
1080 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1082 If SUFFIX is non-nil, add that at the end of the file name."
1084 file)
1087 ;; Create temp files with strict access rights. It's easy to
1088 ;; loosen them later, whereas it's impossible to close the
1089 ;; time-window of loose permissions otherwise.
1097 temporary-file-directory)
1099 temporary-file-directory))))
1105 nil)
1107 ;; the file was somehow created by someone else between
1108 ;; `make-temp-name' and `write-region', let's try again.
1109 nil)
1110 file)
1111 ;; Reset the umask.
1115 "Change the encoding of FILE's name from CODING to NEW-CODING.
1116 The value is a new name of FILE.
1117 Signals a `file-already-exists' error if a file of the new name
1118 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1119 is non-nil. A number as fourth arg means request confirmation if
1120 the new name already exists. This is what happens in interactive
1121 use with M-x."
1124 default-file-name-coding-system))
1126 from-coding to-coding)
1128 ;; We provide the default coding only when it seems that
1129 ;; the filename is correctly decoded by the default
1130 ;; coding.
1136 filename default-coding)
1137 default-coding))
1141 ;; We provide the default coding only when a user is going to
1142 ;; change the encoding not from the default coding.
1146 filename from-coding)))
1149 filename from-coding default-coding)
1150 default-coding)))
1154 default-file-name-coding-system))
1155 ;; FILE should have been decoded by DEFAULT-CODING.
1159 ;; Suppress further encoding.
1164 newname))
1165 \f
1167 "Whether confirmation is requested before visiting a new file or buffer.
1168 If nil, confirmation is not requested.
1169 If the value is `after-completion', confirmation is only
1170 requested if the user called `minibuffer-complete' right before
1171 `minibuffer-complete-and-exit'.
1172 Any other non-nil value means to request confirmation.
1174 This affects commands like `switch-to-buffer' and `find-file'."
1182 "Whether to request confirmation before visiting a new file or buffer.
1183 The variable `confirm-nonexistent-file-or-buffer' determines the
1184 return value, which may be passed as the REQUIRE-MATCH arg to
1185 `read-buffer' or `find-file-read-args'."
1193 "Read the name of a buffer to switch to and return as a string.
1194 It is intended for `switch-to-buffer' family of commands since they
1195 need to omit the name of current buffer from the list of completions
1196 and default values."
1201 ;; Since rbts-completion-table is built dynamically, we
1202 ;; can't just add it to the default value of
1203 ;; icomplete-with-completion-tables, so we add it
1204 ;; here manually.
1209 icomplete-with-completion-tables))))
1214 "Select the buffer specified by BUFFER-OR-NAME in another window.
1215 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1216 nil. Return the buffer switched to.
1218 If called interactively, prompt for the buffer name using the
1219 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1220 determines whether to request confirmation before creating a new
1221 buffer.
1223 If BUFFER-OR-NAME is a string and does not identify an existing
1224 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1225 nil, switch to the buffer returned by `other-buffer'.
1227 Optional second argument NORECORD non-nil means do not put this
1228 buffer at the front of the list of recently selected ones.
1230 This uses the function `display-buffer' as a subroutine; see its
1231 documentation for additional customization information."
1235 same-window-buffer-names same-window-regexps)
1239 "Switch to buffer BUFFER-OR-NAME in another frame.
1240 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1241 nil. Return the buffer switched to.
1243 If called interactively, prompt for the buffer name using the
1244 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1245 determines whether to request confirmation before creating a new
1246 buffer.
1248 If BUFFER-OR-NAME is a string and does not identify an existing
1249 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1250 nil, switch to the buffer returned by `other-buffer'.
1252 Optional second arg NORECORD non-nil means do not put this
1253 buffer at the front of the list of recently selected ones.
1255 This uses the function `display-buffer' as a subroutine; see its
1256 documentation for additional customization information."
1260 same-window-buffer-names same-window-regexps)
1264 "Display buffer BUFFER in another frame.
1265 This uses the function `display-buffer' as a subroutine; see
1266 its documentation for additional customization information."
1269 same-window-buffer-names same-window-regexps
1271 new-window)
1273 ;; This may have been here in order to prevent the new frame from hiding
1274 ;; the old frame. But it does more harm than good.
1275 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1276 ;;(lower-frame (window-frame new-window))
1278 ;; This may have been here in order to make sure the old-frame gets the
1279 ;; focus. But not only can it cause an annoying flicker, with some
1280 ;; window-managers it just makes the window invisible, with no easy
1281 ;; way to recover it. --Stef
1282 ;;(make-frame-invisible (window-frame old-window))
1283 ;;(make-frame-visible (window-frame old-window))
1284 ))
1287 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1288 BODY should use the minibuffer at most once.
1289 Recursive uses of the minibuffer are unaffected (FUN is not
1290 called additional times).
1292 This macro actually adds an auxiliary function that calls FUN,
1293 rather than FUN itself, to `minibuffer-setup-hook'."
1299 ;; Clear out this hook so it does not interfere
1300 ;; with any recursive minibuffer usage.
1311 t))
1314 "Edit file FILENAME.
1315 Switch to a buffer visiting file FILENAME,
1316 creating one if none already exists.
1317 Interactively, the default if you just type RET is the current directory,
1318 but the visited file name is available through the minibuffer history:
1319 type M-n to pull it into the minibuffer.
1321 You can visit files on remote machines by specifying something
1322 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1323 also visit local files as a different user by specifying
1324 /sudo::FILE for the file name.
1325 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1326 manual, for more about this.
1328 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1329 expand wildcards (if any) and visit multiple files. You can
1330 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1332 To visit a file without any kind of conversion and without
1343 "Edit file FILENAME, in another window.
1346 an existing one. See the function `display-buffer'.
1348 Interactively, the default if you just type RET is the current directory,
1349 but the visited file name is available through the minibuffer history:
1350 type M-n to pull it into the minibuffer.
1352 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1353 expand wildcards (if any) and visit multiple files."
1366 "Edit file FILENAME, in another frame.
1369 an existing one. See the function `display-buffer'.
1371 Interactively, the default if you just type RET is the current directory,
1372 but the visited file name is available through the minibuffer history:
1373 type M-n to pull it into the minibuffer.
1375 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1376 expand wildcards (if any) and visit multiple files."
1389 "Edit the existing file FILENAME.
1391 file names with wildcards."
1400 "Edit file FILENAME but don't allow changes.
1414 value))
1417 "Edit file FILENAME in another window but don't allow changes.
1431 value))
1434 "Edit file FILENAME in another frame but don't allow changes.
1448 value))
1451 "Find file FILENAME as a replacement for the file in the next window.
1452 This command does not select that window.
1456 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1457 expand wildcards (if any) and replace the file with multiple files."
1468 "Find alternate file: " file-dir nil
1470 t))))
1478 "Find file FILENAME, select its buffer, kill previous buffer.
1479 If the current buffer now contains an empty file that you just visited
1480 \(presumably by mistake), use this command to visit the file you really want.
1484 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1485 expand wildcards (if any) and replace the file with multiple files.
1487 If the current buffer is an indirect buffer, or the base buffer
1488 for one or more indirect buffers, the other buffer(s) are not
1489 killed."
1498 "Find alternate file: " file-dir nil
1500 t)))
1515 ;; Run `kill-buffer-hook' here. It needs to happen before
1516 ;; variables like `buffer-file-name' etc are set to nil below,
1517 ;; because some of the hooks that could be invoked
1518 ;; (e.g., `save-place-to-alist') depend on those variables.
1519 ;;
1520 ;; Note that `kill-buffer-hook' is not what queries whether to
1521 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1522 ;; asks that itself. Thus, there's no need to temporarily do
1523 ;; `(set-buffer-modified-p nil)' before running this hook.
1525 ;; Okay, now we can end-of-life the old buffer.
1532 ;; This prevents us from finding the same buffer
1533 ;; if we specified the same file again.
1537 ;; Likewise for dired buffers.
1541 ;; This executes if find-file gets an error
1542 ;; and does not really find anything.
1543 ;; We put things back as they were.
1544 ;; If find-file actually finds something, we kill obuf below.
1553 ;; We already ran these; don't run them again.
1556 \f
1558 "Create a suitably named buffer for visiting FILENAME, and return it.
1559 FILENAME (sans directory) is used unchanged if that name is free;
1560 otherwise a string <2> or <3> or ... is appended to get an unused name.
1561 Spaces at the start of FILENAME (sans directory) are removed."
1570 "Create and return a buffer with a name based on NAME.
1571 Choose the buffer's name using `generate-new-buffer-name'."
1575 "Regexp to match the automounter prefix in a directory name."
1583 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1585 home directory is a root directory) and removes automounter prefixes
1586 \(see the variable `automount-dir-prefix')."
1587 ;; Get rid of the prefixes added by the automounter.
1594 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1595 ;; To fix this right, we need a `file-name-case-sensitive-p'
1596 ;; function, but we don't have that yet, so just guess.
1599 ;; If any elt of directory-abbrev-alist matches this name,
1600 ;; abbreviate accordingly.
1606 ;; Compute and save the abbreviated homedir name.
1607 ;; We defer computing this until the first time it's needed, to
1608 ;; give time for directory-abbrev-alist to be set properly.
1609 ;; We include a slash at the end, to avoid spurious matches
1610 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1617 ;; If FILENAME starts with the abbreviated homedir,
1618 ;; make it start with `~' instead.
1620 ;; If the home dir is just /, don't change it.
1623 ;; MS-DOS root directories can come with a drive letter;
1624 ;; Novell Netware allows drive letters beyond `Z:'.
1632 filename)))
1635 "List of logical names for which visiting shouldn't save the true dirname."
1640 "Return the buffer visiting file FILENAME (a string).
1641 This is like `get-file-buffer', except that it checks for any buffer
1642 visiting the same file, possibly under a different name.
1643 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1644 and others are ignored.
1645 If there is no such live buffer, return nil."
1658 found)
1668 ;; Verify this buffer's file number
1669 ;; still belongs to its file.
1672 attributes)
1676 found))))
1677 \f
1679 "Non-nil means file-visiting commands should handle wildcards.
1680 For example, if you specify `*.c', that would visit all the files
1681 whose names match the pattern."
1687 "Non-nil means suppress warning messages for symlinked files.
1688 When nil, Emacs prints a warning when visiting a file that is already
1689 visited, but with a different name. Setting this option to t
1690 suppresses this warning."
1696 "Maximum size of file above which a confirmation is requested.
1697 When nil, never request confirmation."
1704 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1705 OP-TYPE specifies the file operation being performed (for message to user)."
1715 "Read file FILENAME into a buffer and return the buffer.
1716 If a buffer exists visiting FILENAME, return that one, but
1717 verify that the file has not changed since visited or saved.
1718 The buffer is not selected, just returned to the caller.
1719 Optional second arg NOWARN non-nil means suppress any warning messages.
1720 Optional third arg RAWFILE non-nil means the file is read literally.
1721 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1722 and visit all the matching files. When wildcards are actually
1723 used and expanded, return a list of buffers that are visiting
1724 the various files."
1731 'find-directory-functions
1734 filename)))
1737 find-file-wildcards
1751 ;; Find any buffer for a file which has same truename.
1753 ;; Let user know if there is a buffer with the same truename.
1757 find-file-suppress-same-file-warnings
1761 ;; Optionally also find that buffer.
1764 ;; Check to see if the file looks uncommonly large.
1768 ;; We are using an existing buffer.
1775 ;; Certain files should be reverted automatically
1776 ;; if they have changed on disk and not in the buffer.
1784 found))
1794 "File %s changed on disk. Discard your edits? "
1799 "File %s changed on disk. Discard your edits in %s? "
1807 ;; Check if a formerly read-only file has become
1808 ;; writable and vice versa, but if the buffer agrees
1809 ;; with the new state of the file, that is ok too.
1817 buffer-file-name
1826 ;; It is confusing to ask whether to visit
1827 ;; non-literally if they have the file in
1828 ;; hexl-mode.
1834 "The file %s is already visited normally,
1835 and you have edited the buffer. Now you have asked to visit it literally,
1836 meaning no coding system handling, format conversion, or local variables.
1837 Emacs can only visit a file in one way at a time.
1839 Do you want to save the file, and visit it literally instead? "
1840 "The file %s is already visited literally,
1841 meaning no coding system handling, format conversion, or local variables.
1842 You have edited the buffer. Now you have asked to visit the file normally,
1843 but Emacs can only visit a file in one way at a time.
1850 rawfile truename number))
1854 "\
1855 Do you want to discard your changes, and visit the file literally now? "
1856 "\
1859 rawfile truename number)
1865 "The file %s is already visited normally.
1866 You have asked to visit it literally,
1867 meaning no coding system decoding, format conversion, or local variables.
1868 But Emacs can only visit a file in one way at a time.
1870 Do you want to revisit the file literally now? "
1871 "The file %s is already visited literally,
1872 meaning no coding system decoding, format conversion, or local variables.
1873 You have asked to visit it normally,
1874 but Emacs can only visit a file in one way at a time.
1879 rawfile truename number)
1882 ;; Return the buffer we are using.
1883 buf)
1884 ;; Create a new buffer.
1886 ;; find-file-noselect-1 may use a different buffer.
1888 rawfile truename number))))))
1894 ;; Needed in case we are re-visiting the file with a different
1895 ;; text representation.
1912 filename)))
1913 ;; Unconditionally set error
1923 filename)))
1924 ;; Run find-file-not-found-functions until one returns non-nil.
1926 ;; If they fail too, set error.
1928 ;; Record the file's truename, and maybe use that as visited name.
1936 ;; Set buffer's default directory to that of the file.
1938 ;; Turn off backup files for certain file names. Since
1939 ;; this is a permanent local, the major mode won't eliminate it.
1954 \f
1956 "Like `insert-file-contents', but only reads in the file literally.
1957 A buffer may be modified in several ways after reading into the buffer,
1958 to Emacs features such as format decoding, character code
1959 conversion, `find-file-hook', automatic uncompression, etc.
1961 This function ensures that none of these modifications will take place."
1969 nil))
1972 inhibit-file-name-handlers))
1985 filename)))
1986 ;; Check whether the file is uncommonly large
1997 "Insert contents of file FILENAME into buffer after point with no conversion.
1999 This function is meant for the user to run interactively.
2000 Don't call it from programs! Use `insert-file-contents-literally' instead.
2001 \(Its calling sequence is different; see its documentation)."
2006 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2011 "Visit file FILENAME with no conversion of any kind.
2012 Format conversion and character code conversion are both disabled,
2013 and multibyte characters are disabled in the resulting buffer.
2014 The major mode used is Fundamental mode regardless of the file name,
2015 and local variable specifications in the file are ignored.
2016 Automatic uncompression and adding a newline at the end of the
2017 file due to `require-final-newline' is also disabled.
2019 You cannot absolutely rely on this function to result in
2020 visiting the file literally. If Emacs already has a buffer
2021 which is visiting the file, you get the existing buffer,
2022 regardless of whether it was created literally or not.
2024 In a Lisp program, if you want to be sure of accessing a file's
2025 contents literally, you should create a temporary buffer and then read
2026 the file contents into it using `insert-file-contents-literally'."
2029 "Find file literally: " nil default-directory
2032 \f
2036 after-find-file-from-revert-buffer
2037 nomodes)
2038 "Called after finding a file and by the default revert function.
2039 Sets buffer mode, parses local variables.
2040 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2041 error in reading the file. WARN non-nil means warn if there
2042 exists an auto-save file more recent than the visited file.
2043 NOAUTO means don't mess with auto-save mode.
2044 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2045 means this call was from `revert-buffer'.
2046 Fifth arg NOMODES non-nil means don't alter the file's modes.
2047 Finishes by calling the functions in `find-file-hook'
2048 unless NOMODES is non-nil."
2051 nil
2061 ;; No need to warn if buffer is auto-saved
2062 ;; under the name of the visited file.
2064 auto-save-visited-file-name))
2067 buffer-file-name))
2087 ;; Make people do a little extra work (C-x C-q)
2088 ;; before altering a backup file.
2091 ;; When a file is marked read-only,
2092 ;; make the buffer read-only even if root is looking at it.
2100 ;; If requested, add a newline at the end of the file.
2110 view-read-only
2116 "Eval BODY and turn any error into a FORMAT message.
2117 FORMAT can have a %s escape which will be replaced with the actual error.
2118 If `debug-on-error' is set, errors are not caught, so that you can
2119 debug them.
2120 Avoid using a large BODY since it is duplicated."
2129 "Choose the major mode for this buffer automatically.
2130 Also sets up any specified local variables of the file.
2131 Uses the visited file name, the -*- line, and the local variables spec.
2133 This function is called automatically from `find-file'. In that case,
2134 we may set up the file-specified mode and local variables,
2135 depending on the value of `enable-local-variables'.
2136 In addition, if `local-enable-local-variables' is nil, we do
2137 not set local variables (though we do notice a mode specified with -*-.)
2139 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2140 or from Lisp without specifying the optional argument FIND-FILE;
2141 in that case, this function acts as if `enable-local-variables' were t."
2149 ;; Turn font lock off and on, to make sure it takes account of
2150 ;; whatever file local variables are relevant to it.
2152 ;; Font-lock-mode (now in font-core.el) can be ON when
2153 ;; font-lock.el still hasn't been loaded.
2163 "Non-nil means to try second pass through `auto-mode-alist'.
2164 This means that if the first case-sensitive search through the alist fails
2165 to find a matching major mode, a second case-insensitive search is made.
2166 On systems with case-insensitive file names, this variable is ignored,
2167 since only a single case-insensitive search through the alist is made."
2173 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2174 ;; c++-mode, java-mode and more) are added through autoload
2175 ;; directives in that file. That way is discouraged since it
2176 ;; spreads out the definition of the initial value.
2211 ;; Less common extensions come here
2212 ;; so more common ones above are found faster.
2252 ;; The list of archive file extensions should be in sync with
2253 ;; `auto-coding-alist' with `no-conversion' coding system.
2259 ;; Mailer puts message to be edited in
2260 ;; /tmp/Re.... or Message
2264 ;; some news reader is reported to use this
2273 ;; .emacs or .gnus or .viper following a directory delimiter in
2274 ;; Unix, MSDOG or VMS syntax.
2277 ;; _emacs following a directory delimiter
2278 ;; in MsDos syntax
2282 ;; Common Lisp ASDF package system.
2301 ;; Windows candidates may be opened case sensitively on Unix
2307 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2309 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2310 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2311 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2312 ;; this has lower priority to avoid matching changelog.sgml etc.
2314 ;; either user's dot-files or under /etc or some such
2316 ;; alas not all ~/.*rc files are like this
2317 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2322 ;; this contains everything twice, with space and with colon :-(
2324 ;; Get rid of any trailing .n.m and try again.
2325 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2326 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2327 ;; Using mode nil rather than `ignore' would let the search continue
2328 ;; through this list (with the shortened name) rather than start over.
2330 ;; The following should come after the ChangeLog pattern
2331 ;; for the sake of ChangeLog.1, etc.
2332 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2335 "Alist of filename patterns vs corresponding major mode functions.
2336 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2337 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2338 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2339 mode function to use. FUNCTION will be called, unless it is nil.
2341 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2342 calling FUNCTION (if it's not nil), we delete the suffix that matched
2343 REGEXP and search the list again for another match.
2345 If the file name matches `inhibit-first-line-modes-regexps',
2346 then `auto-mode-alist' is not processed.
2348 The extensions whose FUNCTION is `archive-mode' should also
2349 appear in `auto-coding-alist' with `no-conversion' coding system.
2351 See also `interpreter-mode-alist', which detects executable script modes
2352 based on the interpreters they specify to run,
2357 "Select Conf mode or XML mode according to start of file."
2367 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2368 ;; and pike-mode) are added through autoload directives in that
2369 ;; file. That way is discouraged since it spreads out the
2370 ;; definition of the initial value.
2408 "Alist mapping interpreter names to major modes.
2409 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2410 Each element looks like (INTERPRETER . MODE).
2411 If INTERPRETER matches the name of the interpreter specified in the first line
2412 of a script, mode MODE is enabled.
2420 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2421 When checking `inhibit-first-line-modes-regexps', we first discard
2427 "Regexp matching interpreters, for file mode determination.
2428 This regular expression is matched against the first line of a file
2429 to determine the file's mode in `set-auto-mode'. If it matches, the file
2430 is assumed to be interpreted by the interpreter matched by the second group
2431 of the regular expression. The mode is then determined as the mode
2435 "Alist of buffer beginnings vs. corresponding major mode functions.
2436 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2437 After visiting a file, if REGEXP matches the text at the beginning of the
2438 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2439 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2440 major mode.
2442 If FUNCTION is nil, then it is not called. (That is a way of saying
2450 ;; The < comes before the groups (but the first) to reduce backtracking.
2451 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2452 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2456 comment-re "*"
2459 . html-mode)
2461 ;; These two must come after html, because they are more general:
2466 . sgml-mode)
2469 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2470 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2471 After visiting a file, if REGEXP matches the text at the beginning of the
2472 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2473 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2474 have not specified a mode for this file.
2480 "Upper limit on `magic-mode-alist' regexp matches.
2484 "Select major mode appropriate for current buffer.
2486 To find the right major mode, this function checks for a -*- mode tag,
2487 checks if it uses an interpreter listed in `interpreter-mode-alist',
2488 matches the buffer beginning against `magic-mode-alist',
2489 compares the filename against the entries in `auto-mode-alist',
2490 then matches the buffer beginning against `magic-fallback-mode-alist'.
2492 It does not check for the `mode:' local variable in the
2493 Local Variables section of the file; for that, use `hack-local-variables'.
2495 If `enable-local-variables' is nil, this function does not check for a
2496 -*- mode tag.
2498 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2499 set the major mode only if that would change it. In other words
2500 we don't actually set it to the same mode the buffer already has."
2501 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2503 ;; Find a -*- mode tag
2510 ;; Find all specifications for the `mode:' variable
2511 ;; and execute them left to right.
2523 modes)))
2524 ;; Simple -*-MODE-*- case.
2527 modes))))
2528 ;; If we found modes to use, invoke them now, outside the save-excursion.
2536 ;; continuing would call minor modes again, toggling them off
2538 ;; If we didn't, look for an interpreter specified in the first line.
2539 ;; As a special case, allow for things like "#!/bin/env perl", which
2540 ;; finds the interpreter anywhere in $PATH.
2547 ;; Map interpreter name to a mode, signalling we're done at the
2548 ;; same time.
2550 interpreter-mode-alist))
2551 ;; If we found an interpreter mode to use, invoke it now.
2554 ;; Next try matching the buffer beginning against magic-mode-alist.
2568 ;; Next compare the filename against the entries in auto-mode-alist.
2573 ;; Remove remote file name identification.
2577 ;; Remove backup-suffixes from file name.
2580 ;; Find first matching alist entry.
2583 ;; System is case-insensitive.
2587 ;; System is case-sensitive.
2589 ;; First match case-sensitively.
2593 ;; Fallback to case-insensitive match.
2607 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2622 ;; When `keep-mode-if-same' is set, we are working on behalf of
2623 ;; set-visited-file-name. In that case, if the major mode specified is the
2624 ;; same one we already have, don't actually reset it. We don't want to lose
2625 ;; minor modes such as Font Lock.
2627 "Apply MODE and return it.
2628 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2629 any aliases and compared to current major mode. If they are the
2630 same, do nothing and return nil."
2636 mode)))
2639 "Find the -*- spec in the buffer.
2640 Call with point at the place to start searching from.
2641 If one is found, set point to the beginning
2642 and return the position of the end.
2643 Otherwise, return nil; point may be changed."
2646 ;; Don't look for -*- if this file name matches any
2647 ;; of the regexps in inhibit-first-line-modes-regexps.
2655 sufs)
2663 ;; If the file begins with "#!"
2664 ;; (exec interpreter magic), look
2665 ;; for mode frobs in the first two
2666 ;; lines. You cannot necessarily
2667 ;; put them in the first line of
2668 ;; such a file without screwing up
2669 ;; the interpreter invocation.
2670 ;; The same holds for
2671 ;; '\"
2672 ;; in man pages (preprocessor
2673 ;; magic for the `man' program).
2684 end))))
2685 \f
2686 ;;; Handling file local variables
2690 file-local-variables-alist dir-local-variables-alist)
2695 "Normal hook run after processing a file's local variables specs.
2696 Major modes can use this to examine user-specified local variables
2700 "List variable-value pairs that are considered safe.
2701 Each element is a cons cell (VAR . VAL), where VAR is a variable
2702 symbol and VAL is a value that is considered safe."
2703 :risky t
2710 "Expressions that are considered safe in an `eval:' local variable.
2711 Add expressions to this list if you want Emacs to evaluate them, when
2712 they appear in an `eval' local variable specification, without first
2713 asking you for confirmation."
2714 :risky t
2719 ;; Risky local variables:
2722 buffer-auto-save-file-name
2723 buffer-file-name
2724 buffer-file-truename
2725 buffer-undo-list
2726 debugger
2727 default-text-properties
2728 eval
2729 exec-directory
2730 exec-path
2731 file-name-handler-alist
2732 frame-title-format
2733 global-mode-string
2734 header-line-format
2735 icon-title-format
2736 inhibit-quit
2737 load-path
2738 max-lisp-eval-depth
2739 max-specpdl-size
2740 minor-mode-map-alist
2741 minor-mode-overriding-map-alist
2742 mode-line-format
2743 mode-name
2744 overriding-local-map
2745 overriding-terminal-local-map
2746 process-environment
2747 standard-input
2748 standard-output
2749 unread-command-events))
2751 ;; Safe local variables:
2752 ;;
2753 ;; For variables defined by major modes, the safety declarations can go into
2754 ;; the major mode's file, since that will be loaded before file variables are
2755 ;; processed.
2756 ;;
2757 ;; For variables defined by minor modes, put the safety declarations in the
2758 ;; file defining the minor mode after the defcustom/defvar using an autoload
2759 ;; cookie, e.g.:
2760 ;;
2761 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2762 ;;
2763 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2764 ;; minor mode file may not be loaded yet.
2765 ;;
2766 ;; For variables defined in the C source code the declaration should go here:
2782 "Alist of file-local variable settings in the current buffer.
2783 Each element in this list has the form (VAR . VALUE), where VAR
2784 is a file-local variable (a symbol) and VALUE is the value
2785 specified. The actual value in the buffer may differ from VALUE,
2790 "Alist of directory-local variable settings in the current buffer.
2791 Each element in this list has the form (VAR . VALUE), where VAR
2792 is a directory-local variable (a symbol) and VALUE is the value
2793 specified in .dir-locals.el. The actual value in the buffer
2794 may differ from VALUE, if it is changed by the major or minor modes,
2799 "Normal hook run before setting file-local variables.
2800 It is called after checking for unsafe/risky variables and
2801 setting `file-local-variables-alist', and before applying the
2802 variables stored in `file-local-variables-alist'. A hook
2803 function is allowed to change the contents of this alist.
2805 This hook is called only if there is at least one file-local
2809 "Get confirmation before setting up local variable values.
2810 ALL-VARS is the list of all variables to be set up.
2811 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2812 RISKY-VARS is the list of those that are marked as risky.
2813 DIR-NAME is a directory name if these settings come from
2814 directory-local variables, or nil otherwise."
2816 nil
2822 prompt char)
2832 ", and variables that are risky (**)."
2839 y -- to apply the local variables list.
2843 ! -- to apply the local variables list, and permanently mark these
2855 ;; Make strings with embedded whitespace easier to read.
2863 ""
2870 done)
2879 ;; read-event returns -1 if we are in a kbd
2880 ;; macro and there are no more events in the
2881 ;; macro. In that case, attempt to get an
2882 ;; event interactively.
2890 ;; When this is called from desktop-restore-file-buffer,
2891 ;; coding-system-for-read may be non-nil. Reset it before
2892 ;; writing to .emacs.
2896 'safe-local-variable-values
2897 safe-local-variable-values))))
2904 "Return local variables specified in the -*- line.
2905 Ignore any specification for `mode:' and `coding:';
2906 `set-auto-mode' should already have handled `mode:',
2907 `set-auto-coding' should already have handled `coding:'.
2909 If MODE-ONLY is non-nil, all we do is check whether the major
2910 mode is specified, returning t if it is specified. Otherwise,
2911 return an alist of elements (VAR . VAL), where VAR is a variable
2912 and VAL is the specified value."
2916 result mode-specified)
2917 ;; Parse the -*- line into the RESULT alist.
2918 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2920 nil)
2922 ;; Simple form: "-*- MODENAME -*-". Already handled.
2924 nil)
2926 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2927 ;; (last ";" is optional).
2932 ;; There used to be a downcase here,
2933 ;; but the manual didn't say so,
2934 ;; and people want to set var names that aren't all lc.
2940 ;; It is traditional to ignore
2941 ;; case when checking for `mode' in set-auto-mode,
2942 ;; so we must do that here as well.
2943 ;; That is inconsistent, but we're stuck with it.
2944 ;; The same can be said for `coding' in set-auto-coding.
2950 'eval
2957 mode-specified
2958 result))))
2961 "Filter local variable settings, querying the user if necessary.
2962 VARIABLES is the alist of variable-value settings. This alist is
2963 filtered based on the values of `ignored-local-variables',
2964 `enable-local-eval', `enable-local-variables', and (if necessary)
2965 user interaction. The results are added to
2966 `file-local-variables-alist', without applying them.
2967 DIR-NAME is a directory name if these settings come from
2968 directory-local variables, or nil otherwise."
2969 ;; Find those variables that we may want to save to
2970 ;; `safe-local-variable-values'.
2976 ;; Ignore any variable in `ignored-local-variables'.
2977 nil)
2978 ;; Obey `enable-local-eval'.
2985 ;; Ignore duplicates (except `mode') in the present list.
2987 ;; Accept known-safe variables.
2991 ;; The variable is either risky or unsafe:
2998 ;; Query, unless all vars are safe or user wants no querying.
3004 risky-vars dir-name))
3015 "Parse and put into effect this buffer's local variables spec.
3016 If MODE-ONLY is non-nil, all we do is check whether the major mode
3017 is specified, returning t if it is specified."
3020 result)
3027 ;; Look for "Local variables:" line in last page.
3035 ;; suffix is what comes after "local variables:" in its line.
3036 ;; prefix is what comes before "local variables:" in its line.
3046 beg)
3050 endpos
3056 nil t))
3057 ;; This used to be an error, but really all it means is
3058 ;; that this may simply not be a local-variables section,
3059 ;; so just ignore it.
3069 ;; Discard the prefix.
3074 ;; Discard the suffix.
3082 ;; Find the variable name; strip whitespace.
3091 val)
3092 ;; Read the variable value.
3103 'eval
3108 ;; Now we've read all the local variables.
3109 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3111 ;; Otherwise, set the variables.
3115 ;; Any 'evals must run in the Right sequence.
3124 "Non-nil if SYM is safe as a file-local variable with value VAL.
3125 It is safe if any of these conditions are met:
3127 * There is a matching entry (SYM . VAL) in the
3128 `safe-local-variable-values' user option.
3130 * The `safe-local-variable' property of SYM is a function that
3131 evaluates to a non-nil value with VAL as an argument."
3137 "Non-nil if SYM could be dangerous as a file-local variable.
3138 It is dangerous if either of these conditions are met:
3140 * Its `risky-local-variable' property is non-nil.
3146 ;; If this is an alias, check the base name.
3166 "Return t if it is safe to eval EXP when it is found in a file."
3168 ;; Detect certain `put' expressions.
3175 lisp-indent-function
3176 scheme-indent-function))
3177 ;; Only allow safe values (not functions).
3182 ;; Only allow indirect form specs.
3183 ;; During bootstrapping, edebug-basic-spec might not be
3184 ;; defined yet.
3188 ;; Allow expressions that the user requested.
3190 ;; Certain functions can be allowed with safe arguments
3191 ;; or can specify verification functions to try.
3199 ok))
3207 ok)))))))
3210 "Set local variable VAR with value VAL.
3211 If VAR is `mode', call `VAL-mode' as a function unless it's
3212 already the major mode."
3219 ;; A minor mode must be passed an argument.
3220 ;; Otherwise, if the user enables the minor mode in a
3221 ;; major mode hook, this would toggle it off.
3227 ;; Make sure the string has no text properties.
3228 ;; Some text properties can get evaluated in various ways,
3229 ;; so it is risky to put them on with a local variable list.
3233 \f
3234 ;;; Handling directory-local variables, aka project settings.
3240 "List of cached directory roots for directory-local variable classes.
3241 Each element in this list has the form (DIR CLASS MTIME).
3242 DIR is the name of the directory.
3243 CLASS is the name of a variable class (a symbol).
3244 MTIME is the recorded modification time of the directory-local
3245 variables file associated with this entry. This time is a list
3246 of two integers (the same format as `file-attributes'), and is
3247 used to test whether the cache entry is still valid.
3248 Alternatively, MTIME can be nil, which means the entry is always
3252 "Return the variable list for CLASS."
3256 "Collect directory-local variables from MODE-VARIABLES.
3257 VARIABLES is the initial list of variables.
3258 Returns the new list."
3263 ;; If variables are specified more than once, only use the last. (Why?)
3264 ;; The pseudo-variables mode and eval are different (bug#3430).
3267 ;; Need a new cons in case we setcdr later.
3271 "Collect entries from CLASS-VARIABLES into VARIABLES.
3272 ROOT is the root directory of the project.
3273 Return the new variables list."
3281 ;; Don't include this in the previous condition, because we
3282 ;; want to filter all strings before the next condition.
3294 "Declare that the DIRECTORY root is an instance of CLASS.
3295 DIRECTORY is the name of a directory, a string.
3296 CLASS is the name of a project class, a symbol.
3297 MTIME is either the modification time of the directory-local
3298 variables file that defined this class, or nil.
3300 When a file beneath DIRECTORY is visited, the mode-specific
3301 variables from CLASS are applied to the buffer. The variables
3302 for a class are defined using `dir-locals-set-class-variables'."
3309 "Map the type CLASS to a list of variable settings.
3310 CLASS is the project class, a symbol. VARIABLES is a list
3311 that declares directory-local variables for the class.
3312 An element in VARIABLES is either of the form:
3313 (MAJOR-MODE . ALIST)
3314 or
3315 (DIRECTORY . LIST)
3317 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3318 whose elements are of the form (VARIABLE . VALUE).
3320 In the second form, DIRECTORY is a directory name (a string), and
3321 LIST is a list of the form accepted by the function.
3323 When a file is visited, the file's class is found. A directory
3324 may be assigned a class using `dir-locals-set-directory-class'.
3325 Then variables are set in the file's buffer according to the
3326 class' LIST. The list is processed in order.
3328 * If the element is of the form (MAJOR-MODE . ALIST), and the
3329 buffer's major mode is derived from MAJOR-MODE (as determined
3330 by `derived-mode-p'), then all the variables in ALIST are
3331 applied. A MAJOR-MODE of nil may be used to match any buffer.
3332 `make-local-variable' is called for each variable before it is
3333 set.
3335 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3336 is an initial substring of the file's directory, then LIST is
3337 applied by recursively following these rules."
3344 "File that contains directory-local variables.
3345 It has to be constant to enforce uniform values
3349 "Find the directory-local variables for FILE.
3350 This searches upward in the directory tree from FILE.
3351 If the directory root of FILE has been registered in
3352 `dir-locals-directory-cache' and the directory-local variables
3353 file has not been modified, return the matching entry in
3354 `dir-locals-directory-cache'.
3355 Otherwise, if a directory-local variables file is found, return
3356 the file name.
3357 Otherwise, return nil."
3362 dir-locals-file))
3365 ;; `locate-dominating-file' may have abbreviated the name.
3368 ;; Find the best cached value in `dir-locals-directory-cache'.
3381 ;; Check the validity of the cache.
3386 ;; This cache entry is OK.
3387 dir-elt
3388 ;; This cache entry is invalid; clear it.
3391 locals-file)
3392 locals-file))))
3395 "Load a variables FILE and register a new class and instance.
3396 FILE is the name of the file holding the variables to apply.
3397 The new class name is the same as the directory in which FILE
3398 is found. Returns the new class name."
3408 class-name)))
3411 "Read per-directory local variables for the current buffer.
3412 Store the directory-local variables in `dir-local-variables-alist'
3413 and `file-local-variables-alist', without applying them."
3417 ;; Find the variables file.
3440 \f
3443 However, the mode will not be changed if
3444 \(1) a local variables list or the `-*-' line specifies a major mode, or
3446 \ not suitable for ordinary files, or
3447 \(3) the new file name does not particularly specify any mode."
3452 "Change name of file visited in current buffer to FILENAME.
3453 This also renames the buffer to correspond to the new file.
3454 The next time the buffer is saved it will go in the newly specified file.
3455 FILENAME nil or an empty string means mark buffer as not visiting any file.
3456 Remember to delete the initial contents of the minibuffer
3457 if you wish to pass an empty string as the argument.
3459 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3460 confirmation in the case where another buffer is already visiting FILENAME.
3462 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3463 the old visited file has been renamed to the new name FILENAME."
3471 nil
3486 filename)))
3496 ;; If new-name == old-name, renaming would add a spurious <2>
3497 ;; and it's considered as a feature in rename-buffer.
3503 ;; Abbreviate the file names of the buffer.
3512 nil)))
3513 ;; write-file-functions is normally used for things like ftp-find-file
3514 ;; that visit things that are not local files as if they were files.
3515 ;; Changing to visit an ordinary local file instead should flush the hook.
3520 ;; If buffer was read-only because of version control,
3521 ;; that reason is gone now, so make it writable.
3525 ;; Turn off backup files for certain file names.
3526 ;; Since this is a permanent local, the major mode won't eliminate it.
3528 backup-enable-predicate
3534 ;; If auto-save was not already on, turn it on if appropriate.
3538 ;; If auto save is on, start using a new name.
3539 ;; We deliberately don't rename or delete the old auto save
3540 ;; for the old visited file name. This is because perhaps
3541 ;; the user wants to save the new state and then compare with the
3542 ;; previous state from the auto save file.
3545 ;; Rename the old auto save file if any.
3552 ;; Update the major mode, if the file name determines it.
3554 ;; Don't change the mode if it is special.
3557 ;; Don't change the mode if the local variable list specifies it.
3563 "Write current buffer into file FILENAME.
3564 This makes the buffer visit that file, and marks it as not modified.
3566 If you specify just a directory name as FILENAME, that means to use
3567 the default file name but in that directory. You can also yank
3568 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3570 If the buffer is not already visiting a file, the default file name
3571 for the output file is the buffer name.
3573 If optional second arg CONFIRM is non-nil, this function
3574 asks for confirmation before overwriting an existing file.
3575 Interactively, confirmation is required unless you supply a prefix argument."
3576 ;; (interactive "FWrite file: ")
3580 nil nil nil nil)
3584 default-directory)
3585 nil nil))
3589 ;; If arg is just a directory,
3590 ;; use the default file name, but in that directory.
3601 ;; Make buffer writable if file is writable.
3606 ;; It's likely that the VC status at the new location is different from
3607 ;; the one at the old location.
3609 \f
3611 "Make a backup of the disk file visited by the current buffer, if appropriate.
3612 This is normally done before saving the buffer the first time.
3614 A backup may be done by renaming or by copying; see documentation of
3615 variable `make-backup-files'. If it's done by renaming, then the file is
3616 no longer accessible under its old name.
3618 The value is non-nil after a backup was made by renaming.
3619 It has the form (MODES . BACKUPNAME).
3620 MODES is the result of `file-modes' on the original
3621 file; this means that the caller, after saving the buffer, should change
3622 the modes of the new file to agree with the old modes.
3623 BACKUPNAME is the backup file name, which is the old file renamed."
3630 backup-info backupname targets setmodes)
3631 ;; If specified name is a symbolic link, chase it to the target.
3632 ;; Thus we make the backups in the directory where the real file is.
3637 ;; (if (file-directory-p buffer-file-name)
3638 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3642 ;; If have old versions to maybe delete,
3643 ;; ask the user to confirm now, before doing anything.
3644 ;; But don't actually delete til later.
3649 real-file-name)))))
3651 ;; Actually write the back up file.
3654 ; (file-symlink-p buffer-file-name)
3655 backup-by-copying
3656 ;; Don't rename a suid or sgid file.
3671 ;; rename-file should delete old backup.
3675 ;; If trouble writing the backup, write it in ~.
3680 backupname)
3684 ;; Now delete the old versions, if desired.
3691 setmodes)
3698 ;; Create temp files with strict access rights. It's easy to
3699 ;; loosen them later, whereas it's impossible to close the
3700 ;; time-window of loose permissions otherwise.
3703 ;; Try to overwrite old backup first.
3711 nil)
3713 ;; The file was somehow created by someone else between
3714 ;; `delete-file' and `copy-file', so let's try again.
3715 ;; rms says "I think there is also a possible race
3716 ;; condition for making backup files" (emacs-devel 20070821).
3717 nil)))
3718 ;; Reset the umask.
3724 "Return file NAME sans backup versions or strings.
3725 This is a separate procedure so your site-init or startup file can
3726 redefine it.
3727 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3728 we do not remove backup version numbers, only true file version numbers."
3740 "Return t if deleting FILE and rewriting it would preserve the owner."
3745 ;; Return t if the file doesn't exist, since it's true that no
3746 ;; information would be lost by an (attempted) delete and create.
3752 The extension, in a file name, is the part that follows the last `.',
3753 except that a leading `.', if any, doesn't count."
3756 directory)
3760 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3761 ;; we don't want to expand it.
3764 filename))))
3768 The extension, in a file name, is the part that follows the last `.',
3769 excluding version numbers and backup suffixes,
3770 except that a leading `.', if any, doesn't count.
3771 Return nil for extensionless file names such as `foo'.
3772 Return the empty string for file names such as `foo.'.
3774 If PERIOD is non-nil, then the returned value includes the period
3775 that delimits the extension, and if FILENAME has no extension,
3786 "A function to use instead of the default `make-backup-file-name'.
3787 A value of nil gives the default `make-backup-file-name' behavior.
3789 This could be buffer-local to do something special for specific
3790 files. If you define it, you may need to change `backup-file-name-p'
3791 and `file-name-sans-versions' too.
3793 See also `backup-directory-alist'."
3799 "Alist of filename patterns and backup directory names.
3800 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3801 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3802 relative or absolute. If it is absolute, so that all matching files
3803 are backed up into the same directory, the file names in this
3804 directory will be the full name of the file backed up with all
3805 directory separators changed to `!' to prevent clashes. This will not
3806 work correctly if your filesystem truncates the resulting name.
3808 For the common case of all backups going into one directory, the alist
3810 directory name.
3812 If this variable is nil, or it fails to match a filename, the backup
3813 is made in the original file's directory.
3815 On MS-DOS filesystems without long names this variable is always
3816 ignored."
3822 "Default `backup-enable-predicate' function.
3823 Checks for files in `temporary-file-directory',
3824 `small-temporary-file-directory', and /tmp."
3827 ;; Directory is under temporary-file-directory.
3832 ;; Directory is under /tmp.
3837 0 nil
3839 ;; Directory is under small-temporary-file-directory.
3844 "Create the non-numeric backup file name for FILE.
3845 Normally this will just be the file's name with `~' appended.
3846 Customization hooks are provided as follows.
3848 If the variable `make-backup-file-name-function' is non-nil, its value
3849 should be a function which will be called with FILE as its argument;
3850 the resulting name is used.
3852 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3853 the documentation of that variable. If the directory for the backup
3854 doesn't exist, it is created."
3868 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3870 elt backup-directory abs-backup-directory)
3875 alist nil)))
3876 ;; If backup-directory is relative, it should be relative to the
3877 ;; file's directory. By expanding explicitly here, we avoid
3878 ;; depending on default-directory.
3887 abs-backup-directory nil))))
3889 file
3893 ;; Normalize DOSish file names: downcase the drive
3894 ;; letter, if any, and replace the leading "x:" with
3895 ;; "/drive_x".
3898 ;; Replace any invalid file-name characters (for the
3899 ;; case of backing up remote files).
3903 "drive_"
3906 ""
3909 ;; Make the name unique by substituting directory
3910 ;; separators. It may not really be worth bothering about
3911 ;; doubling `!'s in the original name...
3916 backup-directory))
3921 "Return non-nil if FILE is a backup file name (numeric or not).
3922 This is a separate function so you can redefine it for customization.
3923 You may need to redefine `file-name-sans-versions' as well."
3928 ;; This is used in various files.
3929 ;; The usage of backup-extract-version-start is not very clean,
3930 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3932 "Given the name of a numeric backup file, FN, return the backup number.
3933 Uses the free variable `backup-extract-version-start', whose value should be
3934 the index in the name where the version number begins."
3941 "Find a file name for a backup file FN, and suggestions for deletions.
3942 Value is a list whose car is the name for the backup file
3943 and whose cdr is a list of old versions to consider deleting now.
3944 If the value is nil, don't make a backup.
3945 Uses `backup-directory-alist' in the same way as does
3946 `make-backup-file-name'."
3948 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3952 ;; We don't support numbered backups on plain MS-DOS
3953 ;; when long file names are unavailable.
3963 possibilities deserve-versions-p versions)
3966 base-versions
3969 possibilities)
3970 #'<)
3975 kept-old-versions
3976 kept-new-versions
3983 ;; Delete nothing if there is overflow
3984 ;; in the number of versions to keep.
3990 v))))))))))
3993 "Return number of names file FILENAME has."
3996 ;; (defun file-relative-name (filename &optional directory)
3997 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3998 ;; This function returns a relative file name which is equivalent to FILENAME
3999 ;; when used with that default directory as the default.
4000 ;; If this is impossible (which can happen on MSDOS and Windows
4001 ;; when the file name and directory use different drive names)
4002 ;; then it returns FILENAME."
4003 ;; (save-match-data
4004 ;; (let ((fname (expand-file-name filename)))
4005 ;; (setq directory (file-name-as-directory
4006 ;; (expand-file-name (or directory default-directory))))
4007 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4008 ;; ;; drive names, they can't be relative, so return the absolute name.
4009 ;; (if (and (or (eq system-type 'ms-dos)
4010 ;; (eq system-type 'cygwin)
4011 ;; (eq system-type 'windows-nt))
4012 ;; (not (string-equal (substring fname 0 2)
4013 ;; (substring directory 0 2))))
4014 ;; filename
4015 ;; (let ((ancestor ".")
4016 ;; (fname-dir (file-name-as-directory fname)))
4017 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4018 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4019 ;; (setq directory (file-name-directory (substring directory 0 -1))
4020 ;; ancestor (if (equal ancestor ".")
4021 ;; ".."
4022 ;; (concat "../" ancestor))))
4023 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4024 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4025 ;; ;; We matched within FNAME's directory part.
4026 ;; ;; Add the rest of FNAME onto ANCESTOR.
4027 ;; (let ((rest (substring fname (match-end 0))))
4028 ;; (if (and (equal ancestor ".")
4029 ;; (not (equal rest "")))
4030 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4031 ;; rest
4032 ;; (concat (file-name-as-directory ancestor) rest)))
4033 ;; ;; We matched FNAME's directory equivalent.
4034 ;; ancestor))))))
4037 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4038 This function returns a relative file name which is equivalent to FILENAME
4039 when used with that default directory as the default.
4040 If FILENAME and DIRECTORY lie on different machines or on different drives
4041 on a DOS/Windows machine, it returns FILENAME in expanded form."
4045 default-directory))))
4051 ;; Test for different drives on DOS/Windows
4053 ;; Should `cygwin' really be included here? --stef
4056 ;; Test for different remote file system identification
4058 filename
4064 directory nil nil case-fold-search))
4066 directory nil nil case-fold-search))))
4069 ".."
4071 ;; Now ancestor is empty, or .., or ../.., etc.
4073 directory nil nil case-fold-search))
4074 ;; We matched within FILENAME's directory part.
4075 ;; Add the rest of FILENAME onto ANCESTOR.
4078 ;; But don't bother with ANCESTOR if it would give us `./'.
4079 rest
4081 ;; We matched FILENAME's directory equivalent.
4082 ancestor))))))
4083 \f
4085 "Save current buffer in visited file if modified.
4086 Variations are described below.
4088 By default, makes the previous version into a backup file
4089 if previously requested or if this is the first save.
4091 to become a backup when the next save is done.
4093 unconditionally makes the previous version into a backup file.
4095 to become a backup when the next save is done,
4096 and unconditionally makes the previous version into a backup file.
4098 With a numeric argument of 0, never make the previous version
4099 into a backup file.
4101 If a file's name is FOO, the names of its numbered backup versions are
4102 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4103 Numeric backups (rather than FOO~) will be made if value of
4104 `version-control' is not the atom `never' and either there are already
4105 numeric versions of the file being backed up, or `version-control' is
4106 non-nil.
4107 We don't want excessive versions piling up, so there are variables
4108 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4109 and `kept-new-versions', which tells how many newest versions to keep.
4110 Defaults are 2 old versions and 2 new.
4111 `dired-kept-versions' controls dired's clean-directory (.) command.
4112 If `delete-old-versions' is nil, system will query user
4113 before trimming versions. Otherwise it does it silently.
4115 If `vc-make-backup-files' is nil, which is the default,
4116 no backup files are made for files managed by version control.
4117 (This is because the version control system itself records previous versions.)
4119 See the subroutine `basic-save-buffer' for more information."
4125 ;; We used to display the message below only for files > 50KB, but
4126 ;; then Rmail-mbox never displays it due to buffer swapping. If
4127 ;; the test is ever re-introduced, be sure to handle saving of
4128 ;; Rmail files.
4135 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4136 Normally delete only if the file was written by this Emacs since
4137 the last real save, but optional arg FORCE non-nil means delete anyway."
4151 "Normal hook that is run before a buffer is saved to its file."
4157 "Normal hook that is run after a buffer is saved to its file."
4163 "If non-nil, use this coding system for saving the buffer.
4164 More precisely, use this coding system in place of the
4165 value of `buffer-file-coding-system', when saving the buffer.
4166 Calling `write-region' for any purpose other than saving the buffer
4167 will still use `buffer-file-coding-system'; this variable has no effect
4174 "Save the current buffer in its visited file, if it has been modified.
4175 The hooks `write-contents-functions' and `write-file-functions' get a chance
4176 to do the job of saving; if they do not, then the buffer is saved in
4177 the visited file in the usual way.
4178 Before and after saving the buffer, this function runs
4179 `before-save-hook' and `after-save-hook', respectively."
4182 ;; In an indirect buffer, save its base buffer instead.
4187 setmodes)
4188 ;; If buffer has no file name, ask user for one.
4195 ;; Signal an error if the user specified the name of an
4196 ;; existing directory.
4199 filename))
4201 ;; Signal an error if the specified name refers to a
4202 ;; non-existing directory.
4232 ;; Support VC version backups.
4238 ;; If a hook returned t, file is already "written".
4239 ;; Otherwise, write it the usual way now.
4241 ;; Now we have saved the current buffer. Let's make sure
4242 ;; that buffer-file-coding-system is fixed to what
4243 ;; actually used for saving by binding it locally.
4253 ;; If the auto-save file was recent before this command,
4254 ;; delete it now.
4256 ;; Support VC `implicit' locking.
4261 ;; This does the "real job" of writing a buffer into its visited file
4262 ;; and making a backup file. This is what is normally done
4263 ;; but inhibited if one of write-file-functions returns non-nil.
4264 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4276 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4290 buffer-file-name)))
4304 ;; Write temp name, then rename it.
4305 ;; This requires write access to the containing dir,
4306 ;; which is why we don't try it if we don't have that access.
4308 tempname succeed
4311 ;; Create temp files with strict access rights. It's easy to
4312 ;; loosen them later, whereas it's impossible to close the
4313 ;; time-window of loose permissions otherwise.
4318 ;; Try various temporary names.
4319 ;; This code follows the example of make-temp-file,
4320 ;; but it calls write-region in the appropriate way
4321 ;; for saving the buffer.
4327 ;; Pass in nil&nil rather than point-min&max
4328 ;; cause we're saving the whole buffer.
4329 ;; write-region-annotate-functions may use it.
4331 tempname nil realname
4333 nil)
4335 ;; The file was somehow created by someone else between
4336 ;; `make-temp-name' and `write-region', let's try again.
4337 nil)
4339 ;; Reset the umask.
4341 ;; If we failed, restore the buffer's modtime.
4344 ;; Since we have created an entirely new file,
4345 ;; make sure it gets the right permission bits set.
4349 buffer-file-name)))
4350 ;; We succeeded in writing the temp file,
4351 ;; so rename it.
4353 ;; If file not writable, see if we can make it writable
4354 ;; temporarily while we write it.
4355 ;; But no need to do so if we have just backed it up
4356 ;; (setmodes is set) because that says we're superseding.
4358 ;; Change the mode back, after writing.
4364 ;; Pass in nil&nil rather than point-min&max to indicate
4365 ;; we're saving the buffer rather than just a region.
4366 ;; write-region-annotate-functions may make us of it.
4368 buffer-file-name nil t buffer-file-truename)
4370 ;; If we get an error writing the new file, and we made
4371 ;; the backup by renaming, undo the backing-up.
4376 setmodes))
4379 "View the differences between BUFFER and its associated file.
4380 This requires the external program `diff' to be in your `exec-path'."
4394 ;; Display that message for 1 second so that user can read it
4395 ;; in the minibuffer.
4397 ;; return always nil, so that save-buffers-kill-emacs will not move
4398 ;; over to the next unsaved buffer when calling `d'.
4399 nil)
4402 `((?\C-r
4409 ;; Return nil to ask about BUF again.
4410 nil)
4422 ;; Return nil to ask about BUF again.
4423 nil)
4433 "Save some modified file-visiting buffers. Asks user about each one.
4434 You can answer `y' to save, `n' not to save, `C-r' to look at the
4435 buffer in question with `view-buffer' before deciding or `d' to
4436 view the differences using `diff-buffer-with-file'.
4438 Optional argument (the prefix) non-nil means save all with no questions.
4439 Optional second argument PRED determines which buffers are considered:
4440 If PRED is nil, all the file-visiting buffers are considered.
4441 If PRED is t, then certain non-file buffers will also be considered.
4442 If PRED is a zero-argument function, it indicates for each buffer whether
4443 to consider it or not when called with that buffer current.
4445 See `save-some-buffers-action-alist' if you want to
4446 change the additional actions you can take on files."
4450 files-done abbrevs-done)
4452 ;; First save any buffers that we're supposed to save unconditionally.
4453 ;; That way the following code won't ask about them.
4458 ;; Ask about those buffers that merit it,
4459 ;; and record the number thus saved.
4463 ;; Note that killing some buffers may kill others via
4464 ;; hooks (e.g. Rmail and its viewing buffer).
4477 t
4489 save-some-buffers-action-alist))
4490 ;; Maybe to save abbrevs, and record whether
4491 ;; we either saved them or asked to.
4497 abbrev-file-name)))
4499 ;; Don't keep bothering user if he says no.
4504 "(Some special files were saved without asking)"
4506 \f
4508 "Mark current buffer as unmodified, not needing to be saved.
4511 It is not a good idea to use this function in Lisp programs, because it
4512 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4519 "Change whether this buffer is read-only.
4520 With prefix argument ARG, make the buffer read-only if ARG is
4521 positive, otherwise make it writable. If buffer is read-only
4522 and `view-read-only' is non-nil, enter view mode."
4527 nil ; do nothing.
4528 ;; Toggle.
4535 ;; If view-mode is already active, `view-mode-enter' is a nop.
4547 "Insert contents of file FILENAME into buffer after point.
4548 Set mark after the inserted text.
4550 This function is meant for the user to run interactively.
4551 Don't call it from programs! Use `insert-file-contents' instead.
4552 \(Its calling sequence is different; see its documentation)."
4557 "Append the contents of the region to the end of file FILENAME.
4558 When called from a function, expects three arguments,
4559 START, END and FILENAME. START and END are normally buffer positions
4560 specifying the part of the buffer to write.
4561 If START is nil, that means to use the entire buffer contents.
4562 If START is a string, then output that string to the file
4563 instead of any buffer contents; END is ignored.
4565 This does character code conversion and applies annotations
4566 like `write-region' does."
4571 "Return most recent backup file for FILENAME or nil if no backups exist."
4572 ;; `make-backup-file-name' will get us the right directory for
4573 ;; ordinary or numeric backups. It might create a directory for
4574 ;; backups as a side-effect, according to `backup-directory-alist'.
4581 tem)
4590 newest))
4593 "Rename current buffer to a similar name not already taken.
4594 This function is useful for creating multiple shell process buffers
4595 or multiple mail buffers, etc."
4603 ;; If the existing buffer name has a <NNN>,
4604 ;; which isn't part of the file name (if any),
4605 ;; then get rid of that.
4611 "Create the directory DIR and any nonexistent parent dirs.
4612 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4614 Interactively, the default choice of directory to create
4615 is the current default directory for file names.
4616 That is useful when you have visited a file in a nonexistent directory.
4618 Noninteractively, the second (optional) argument PARENTS says whether
4619 to create parent directories if they don't exist. Interactively,
4620 this happens by default."
4623 nil nil)
4624 t))
4625 ;; If default-directory is a remote directory,
4626 ;; make sure we find its make-directory handler.
4634 create-list)
4636 ;; If directory is its own parent, then we can't
4637 ;; keep looping forever
4652 "Delete the directory named DIRECTORY. Does not follow symlinks.
4653 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well."
4657 "Delete directory: "
4658 default-directory default-directory nil nil))))
4663 nil))))
4664 ;; If default-directory is a remote directory, make sure we find its
4665 ;; delete-directory handler.
4672 ;; Only move non-empty dir to trash if recursive deletion was
4673 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4674 ;; case, where the operation fails in delete-directory-internal.
4675 ;; As `move-file-to-trash' trashes directories (empty or
4676 ;; otherwise) as a unit, we do not need to recurse here.
4678 ;; Check if directory is empty apart from "." and "..".
4683 ;; Otherwise, call outselves recursively if needed.
4687 ;; This test is equivalent to
4688 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4689 ;; but more efficient
4693 ;; We do not want to delete "." and "..".
4699 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4700 If NEWNAME names an existing directory, copy DIRECTORY as subdirectory there.
4702 This function always sets the file modes of the output files to match
4703 the corresponding input file.
4705 The third arg KEEP-TIME non-nil means give the output files the same
4706 last-modified time as the old ones. (This works on only some systems.)
4708 A prefix arg makes KEEP-TIME non-nil.
4710 Noninteractively, the last argument PARENTS says whether to
4711 create parent directories if they don't exist. Interactively,
4712 this happens by default."
4719 default-directory default-directory nil nil)
4720 current-prefix-arg t)))
4721 ;; If default-directory is a remote directory, make sure we find its
4722 ;; copy-directory handler.
4728 ;; Compute target name.
4733 ;; Copy recursively.
4741 ;; We do not want to copy "." and "..".
4744 ;; Set directory attributes.
4748 \f
4751 "Function to use to revert this buffer, or nil to do the default.
4752 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4757 "Function to use to insert contents when reverting this buffer.
4758 Gets two args, first the nominal file name to use,
4759 and second, t if reading the auto-save file.
4764 "Function to check whether a non-file buffer needs reverting.
4765 This should be a function with one optional argument NOCONFIRM.
4766 Auto Revert Mode passes t for NOCONFIRM. The function should return
4767 non-nil if the buffer should be reverted. A return value of
4768 `fast' means that the need for reverting was not checked, but
4769 that reverting the buffer is fast. The buffer is current when
4770 this function is called.
4772 The idea behind the NOCONFIRM argument is that it should be
4773 non-nil if the buffer is going to be reverted without asking the
4774 user. In such situations, one has to be careful with potentially
4775 time consuming operations.
4777 For more information on how this variable is used by Auto Revert mode,
4781 "Normal hook for `revert-buffer' to run before reverting.
4782 If `revert-buffer-function' is used to override the normal revert
4786 "Normal hook for `revert-buffer' to run after reverting.
4787 Note that the hook value that it runs is the value that was in effect
4788 before reverting; that makes a difference if you have buffer-local
4789 hook functions.
4791 If `revert-buffer-function' is used to override the normal revert
4797 "Replace current buffer text with the text of the visited file on disk.
4798 This undoes all changes since the file was visited or saved.
4799 With a prefix argument, offer to revert from latest auto-save file, if
4800 that is more recent than the visited file.
4802 This command also implements an interface for special buffers
4803 that contain text which doesn't come from a file, but reflects
4804 some other data instead (e.g. Dired buffers, `buffer-list'
4805 buffers). This is done via the variable `revert-buffer-function'.
4806 In these cases, it should reconstruct the buffer contents from the
4807 appropriate data.
4809 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4810 to revert from the auto-save file when this is nil. Note that the
4811 sense of this argument is the reverse of the prefix argument, for the
4812 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4813 to nil.
4815 Optional second argument NOCONFIRM means don't ask for confirmation
4816 at all. \(The variable `revert-without-query' offers another way to
4817 revert buffers without querying for confirmation.)
4819 Optional third argument PRESERVE-MODES non-nil means don't alter
4820 the files modes. Normally we reinitialize them using `normal-mode'.
4822 If the value of `revert-buffer-function' is non-nil, it is called to
4823 do all the work for this command. Otherwise, the hooks
4824 `before-revert-hook' and `after-revert-hook' are run at the beginning
4825 and the end, and if `revert-buffer-insert-file-contents-function' is
4826 non-nil, it is called instead of rereading visited file contents."
4828 ;; I admit it's odd to reverse the sense of the prefix argument, but
4829 ;; there is a lot of code out there which assumes that the first
4830 ;; argument should be t to avoid consulting the auto-save file, and
4831 ;; there's no straightforward way to encourage authors to notice a
4832 ;; reversal of the argument sense. So I'm just changing the user
4833 ;; interface, but leaving the programmatic interface the same.
4841 buffer-auto-save-file-name
4846 buffer-auto-save-file-name
4847 buffer-file-name)))
4857 file-name)))
4859 ;; If file was backed up but has changed since,
4860 ;; we should make another backup.
4864 ;; Effectively copy the after-revert-hook status,
4865 ;; since after-find-file will clobber it.
4868 after-revert-hook))
4873 ;; Get rid of all undo records for this buffer.
4875 ;; Don't make undo records for the reversion.
4878 file-name auto-save-p)))
4881 "File %s no longer exists!"
4883 file-name))
4886 "File %s no longer readable!"
4888 file-name))
4890 ;; Bind buffer-file-name to nil
4891 ;; so that we don't try to lock the file.
4897 ;; Auto-saved file should be read by Emacs'
4898 ;; internal coding.
4902 buffer-file-coding-system-explicit
4905 coding-system-for-read
4907 coding-system-for-read)
4909 ;; As a coding system suitable for multibyte
4910 ;; buffer is specified, make the current
4911 ;; buffer multibyte.
4914 ;; This force after-insert-file-set-coding
4915 ;; (called from insert-file-contents) to set
4916 ;; buffer-file-coding-system to a proper value.
4919 ;; Note that this preserves point in an intelligent way.
4923 nil nil t))
4925 nil nil t)))))
4926 ;; Recompute the truename in case changes in symlinks
4927 ;; have changed the truename.
4931 ;; Run after-revert-hook as it was before we reverted.
4935 local-hook)
4938 t))))))
4941 "Recover the visited file--get contents from its last auto-save file."
4946 "Visit file FILE, but get contents from its last auto-save file."
4947 ;; Actually putting the file name in the minibuffer should be used
4948 ;; only rarely.
4949 ;; Not just because users often use the default.
4969 ;; Use insert-directory-safely, not insert-directory,
4970 ;; because these files might not exist. In particular,
4971 ;; FILE might not exist if the auto-save file was for
4972 ;; a buffer that didn't visit a file, such as "*mail*".
4973 ;; The code in v20.x called `ls' directly, so we need
4974 ;; to emulate what `ls' did in that case.
4980 ;; Keep the current buffer-file-coding-system.
4982 ;; Auto-saved file should be read with special coding.
4991 "Recover auto save files from a previous Emacs session.
4992 This command first displays a Dired buffer showing you the
4993 previous sessions that you could recover from.
4994 To choose one, move point to the proper line and then type C-c C-c.
4995 Then you'll be asked about a number of files to recover."
5005 auto-save-list-file-prefix)))
5006 t)
5015 ;; Each line starts with a space
5016 ;; so that Font Lock mode won't highlight the first character.
5025 "Choose one saved session to recover auto-save files from.
5026 This command is used in the special Dired buffer created by
5029 ;; Get the name of the session file to recover from.
5031 files
5037 ;; Read in the auto-save-list file.
5041 ;; Loop thru the text of that file
5042 ;; and get out the names of the files to recover.
5046 ;; This is a pair of lines for a non-file-visiting buffer.
5047 ;; Get the auto-save file name and manufacture
5048 ;; a "visited file name" from that.
5051 ;; If there is no auto-save file name, the
5052 ;; auto-save-list file is probably corrupted.
5065 ;; This pair of lines is a file-visiting
5066 ;; buffer. Use the visited file name.
5076 ;; Ignore a file if its auto-save file does not exist now.
5080 ;; The file contains a pair of line for each auto-saved buffer.
5081 ;; The first line of the pair contains the visited file name
5082 ;; or is empty if the buffer was not visiting a file.
5083 ;; The second line is the auto-save file name.
5091 files
5097 "Kill BUFFER if confirmed."
5105 "Kill some buffers. Asks the user whether to kill each one of them.
5106 Non-interactively, if optional argument LIST is non-nil, it
5107 specifies the list of buffers to kill, asking for approval for each one."
5115 ; if we killed the base buffer.
5122 "Kill buffers whose name matches the specified REGEXP.
5123 The optional second argument indicates whether to kill internal buffers too."
5132 \f
5134 "Toggle auto-saving of contents of current buffer.
5135 With prefix argument ARG, turn auto-saving on if positive, else off."
5140 ;; If auto-save is off because buffer has shrunk,
5141 ;; then toggling should turn it on.
5146 buffer-file-name
5148 ;; If -1 was stored here, to temporarily turn off saving,
5149 ;; turn it back on.
5155 buffer-auto-save-file-name)
5158 "Adjust current buffer's auto save file name for current conditions.
5159 Also rename any existing auto save file, if it was made in this session."
5171 "Return file name to use for auto-saves of current buffer.
5172 Does not consider `auto-save-visited-file-name' as that variable is checked
5173 before calling this function. You can redefine this for customization.
5174 See also `auto-save-file-name-p'."
5182 result uniq)
5183 ;; Apply user-specified translations
5184 ;; to the file name.
5188 filename)
5198 filename))))
5203 ;; We truncate the file name to DOS 8+3 limits
5204 ;; before doing anything else, because the regexp
5205 ;; passed to string-match below cannot handle
5206 ;; extensions longer than 3 characters, multiple
5207 ;; dots, and other atrocities.
5212 fn)
5217 "#"
5220 ;; Make sure auto-save file names don't contain characters
5221 ;; invalid for the underlying filesystem.
5223 ;; Don't modify remote (ange-ftp) filenames
5226 result))))
5228 ;; Deal with buffers that don't have any associated files. (Mail
5229 ;; mode tends to create a good number of these.)
5233 file-name)
5234 ;; Restrict the characters used in the file name to those which
5235 ;; are known to be safe on all filesystems, url-encoding the
5236 ;; rest.
5237 ;; We do this on all platforms, because even if we are not
5238 ;; running on DOS/Windows, the current directory may be on a
5239 ;; mounted VFAT filesystem, such as a USB memory stick.
5243 ;; For multibyte characters, this will produce more than
5244 ;; 2 hex digits, so is not true URL encoding.
5248 ;; Generate the file name.
5254 ;; Try a few alternative directories, to get one we can
5255 ;; write it.
5261 ;; Don't modify remote (ange-ftp) filenames
5263 ;; The call to convert-standard-filename is in case
5264 ;; buffer-name includes characters not allowed by the
5265 ;; DOS/Windows filesystems. make-temp-file writes to the
5266 ;; file it creates, so we must fix the file name _before_
5267 ;; make-temp-file is called.
5269 fname))
5271 ;; make-temp-file creates the file,
5272 ;; but we don't want it to exist until we do an auto-save.
5276 file-name)))
5279 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5280 FILENAME should lack slashes. You can redefine this for customization."
5282 \f
5284 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5285 The generated regexp will match a filename only if the filename
5286 matches that wildcard according to shell rules. Only wildcards known
5287 by `sh' are supported."
5289 ;; Copy the initial run of non-special characters.
5292 ;; If no special characters, we're almost done.
5296 j)
5298 result
5319 ;; Found "[^". Insert a `\0' character
5320 ;; (which cannot happen in a filename)
5321 ;; into the character class, so that `^'
5322 ;; is not the first character after `[',
5323 ;; and thus non-special in a regexp.
5328 ;; I don't think `]' can appear in a
5329 ;; character class in a wildcard, but
5330 ;; let's be general here.
5337 i
5350 ;; Shell wildcards should match the entire filename,
5351 ;; not its part. Make the regexp say so.
5353 \f
5356 "Switches for `list-directory' to pass to `ls' for brief listing."
5362 "Switches for `list-directory' to pass to `ls' for verbose listing."
5367 "Expand wildcard pattern PATTERN.
5368 This returns a list of file names which match the pattern.
5370 If PATTERN is written as an absolute file name,
5371 the values are absolute also.
5373 If PATTERN is written as a relative file name, it is interpreted
5374 relative to the current default directory, `default-directory'.
5375 The file names returned are normally also relative to the current
5376 default directory. However, if FULL is non-nil, they are absolute."
5380 ;; A list of all dirs that DIRPART specifies.
5381 ;; This can be more than one dir
5382 ;; if DIRPART contains wildcards.
5386 dirpart)))
5390 contents)
5395 ;; Filter out "." and ".."
5400 name))
5407 this-dir-contents)
5408 this-dir-contents)
5409 contents))))
5411 contents)))
5413 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5417 "Display a list of files in or matching DIRNAME, a la `ls'.
5418 DIRNAME is globbed by the shell if necessary.
5419 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5420 Actions controlled by variables `list-directory-brief-switches'
5421 and `list-directory-verbose-switches'."
5425 nil default-directory nil)
5426 pfx)))
5428 list-directory-brief-switches))
5429 buffer)
5441 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5449 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5451 PATTERN is assumed to represent a file-name wildcard suitable for the
5452 underlying filesystem. For Unix and GNU/Linux, each character from the
5454 the parts of the pattern which don't include wildcard characters are
5455 quoted with double quotes.
5458 on Windows), so PATTERN can use them to quote wildcard characters that
5459 need to be passed verbatim to shell commands."
5463 ;; DOS/Windows don't allow `"' in file names. So if the
5464 ;; argument has quotes, we can safely assume it is already
5465 ;; quoted by the caller.
5467 ;; We quote [&()#$'] in case their shell is a port of a
5468 ;; Unixy shell. We quote [,=+] because stock DOS and
5469 ;; Windows shells require that in some cases, such as
5470 ;; passing arguments to batch files that use positional
5471 ;; arguments like %1.
5473 pattern
5476 end)
5493 pattern))))
5500 "Program to get the amount of free space on a file system.
5501 We assume the output has the format of `df'.
5502 The value of this variable must be just a command name or file name;
5503 if you want to specify options, use `directory-free-space-args'.
5505 A value of nil disables this feature.
5507 If the function `file-system-info' is defined, it is always used in
5508 preference to the program given by this variable."
5514 "Options to use when running `directory-free-space-program'."
5519 "Return the amount of free space on directory DIR's file system.
5520 The result is a string that gives the number of free 1KB blocks,
5521 or nil if the system call or the program which retrieve the information
5522 fail. It returns also nil when DIR is a remote directory.
5524 This function calls `file-system-info' if it is available, or invokes the
5525 program specified by `directory-free-space-program' if that is non-nil."
5527 ;; Try to find the number of free blocks. Non-Posix systems don't
5528 ;; always have df, but might have an equivalent system call.
5537 ;; Avoid failure if the default directory does
5538 ;; not exist (Bug#2631, Bug#3911).
5541 nil t nil
5542 directory-free-space-args
5543 dir)
5545 ;; Usual format is a header line followed by a line of
5546 ;; numbers.
5551 ;; Move to the end of the "available blocks" number.
5554 ;; Copy it into AVAILABLE.
5559 ;; The following expression replaces `dired-move-to-filename-regexp'.
5563 ;; In some locales, month abbreviations are as short as 2 letters,
5564 ;; and they can be followed by ".".
5565 ;; In Breton, a month name can include a quote character.
5578 s "+"
5581 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5582 ;; omits the Kanji characters after month and day-of-month.
5583 ;; On Mac OS X 10.3, the date format in East Asian locales is
5584 ;; day-of-month digits followed by month digits.
5590 ;; The "[0-9]" below requires the previous column to end in a digit.
5591 ;; This avoids recognizing `1 may 1997' as a date in the line:
5592 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5594 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5596 ;; For non-iso date formats, we add the ".*" in order to find
5597 ;; the last possible match. This avoids recognizing
5598 ;; `jservice 10 1024' as a date in the line:
5599 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5601 ;; vc dired listings provide the state or blanks between file
5602 ;; permissions and date. The state is always surrounded by
5603 ;; parantheses:
5604 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5605 ;; This is not supported yet.
5610 "Regular expression to match up to the file name in a directory listing.
5611 The default value is designed to recognize dates and times
5616 ;; insert-directory
5617 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5618 ;; FULL-DIRECTORY-P is nil.
5619 ;; The single line of output must display FILE's name as it was
5620 ;; given, namely, an absolute path name.
5621 ;; - must insert exactly one line for each file if WILDCARD or
5622 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5623 ;; before the file lines, plus optional text after the file lines.
5624 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5625 ;; allowed.
5626 ;; File lines should display the basename.
5627 ;; - must be consistent with
5628 ;; - functions dired-move-to-filename, (these two define what a file line is)
5629 ;; dired-move-to-end-of-filename,
5630 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5631 ;; dired-insert-headerline
5632 ;; dired-after-subdir-garbage (defines what a "total" line is)
5633 ;; - variable dired-subdir-regexp
5634 ;; - may be passed "--dired" as the first argument in SWITCHES.
5635 ;; Filename handlers might have to remove this switch if their
5636 ;; "ls" command does not support it.
5638 "Insert directory listing for FILE, formatted according to SWITCHES.
5639 Leaves point after the inserted text.
5640 SWITCHES may be a string of options, or a list of strings
5641 representing individual options.
5642 Optional third arg WILDCARD means treat FILE as shell wildcard.
5643 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5644 switches do not contain `d', so that a full listing is expected.
5646 This works by running a directory listing program
5647 whose name is in the variable `insert-directory-program'.
5648 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5650 When SWITCHES contains the long `--dired' option, this function
5651 treats it specially, for the sake of dired. However, the
5652 normally equivalent short `-D' option is just passed on to
5653 `insert-directory-program', as any other option."
5654 ;; We need the directory in order to find the right handler.
5659 wildcard full-directory-p)
5662 ;; Read the actual directory using `insert-directory-program'.
5663 ;; RESULT gets the status code.
5665 ;; putting text property `dired-filename, decode one
5666 ;; bunch by one to preserve that property.
5668 ;; This is to control encoding the arguments in call-process.
5672 default-file-name-coding-system))))
5675 ;; Run ls in the directory part of the file pattern
5676 ;; using the last component as argument.
5683 shell-file-name nil t nil
5684 "-c"
5686 ""
5688 insert-directory-program
5689 " -d "
5691 switches
5693 " -- "
5694 ;; Quote some characters that have
5695 ;; special meanings in shells; but
5696 ;; don't quote the wildcards--we want
5697 ;; them to be special. We also
5698 ;; currently don't quote the quoting
5699 ;; characters in case people want to
5700 ;; use them explicitly to quote
5701 ;; wildcard characters.
5703 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5704 ;; directory if FILE is a symbolic link.
5711 insert-directory-program nil t nil
5715 ;; Split the switches at any spaces so we can
5716 ;; pass separate options as separate args.
5718 ;; Avoid lossage if FILE starts with `-'.
5726 file))))))))
5728 ;; If we got "//DIRED//" in the output, it means we got a real
5729 ;; directory listing, even if `ls' returned nonzero.
5730 ;; So ignore any errors.
5743 ;; The first time ls returns an error,
5744 ;; find the version numbers of ls,
5745 ;; and set insert-directory-ls-version
5746 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5747 ;; is equal or if the info cannot be obtained.
5748 ;; (That can mean it isn't GNU ls.)
5758 comparison)
5774 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5778 ;; If `insert-directory-program' failed, signal an error.
5780 ;; Delete the error message it may have output.
5782 ;; On non-Posix systems, we cannot open a directory, so
5783 ;; don't even try, because that will always result in
5784 ;; the ubiquitous "Access denied". Instead, show the
5785 ;; command line so the user can try to guess what went wrong.
5790 insert-directory-program
5792 file result)
5793 ;; Unix. Access the file to get a suitable error.
5800 ;; The following overshoots by one line for an empty
5801 ;; directory listed with "--dired", but without "-a"
5802 ;; switch, where the ls output contains a
5803 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5804 ;; We take care of that case later.
5812 error-lines)
5813 ;; Find all the lines that are error messages,
5814 ;; and record the bounds of each one.
5821 ;; Now read the numeric positions of file names.
5828 error-lines))
5831 error-lines)))
5833 ;; End is followed by \n or by " -> ".
5835 ;; It seems that we can't trust ls's output as to
5836 ;; byte positions of filenames.
5842 ;; Take care of the case where the ls output contains a
5843 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5844 ;; and we went one line too far back (see above).
5849 ;; Now decode what read if necessary.
5851 file-name-coding-system
5852 default-file-name-coding-system
5854 coding-no-eol
5855 val pos)
5859 ;; If no coding system is specified or detection is
5860 ;; requested, detect the coding.
5874 ;; Force no eol conversion on a file name, so
5875 ;; that CR is preserved.
5883 ;; Try to insert the amount of free space.
5886 ;; First find the line to put it on.
5890 ;; Replace "total" with "used", to avoid confusion.
5896 "Convert `ls --dired' file name position value POS to a buffer position.
5897 File name position values returned in ls --dired output
5898 count only stdout; they don't count the error messages sent to stderr.
5899 So this function converts to them to real buffer positions.
5900 ERROR-LINES is a list of buffer positions of error message lines,
5901 of the form (START END)."
5905 pos)
5909 "Insert directory listing for FILE, formatted according to SWITCHES.
5911 Like `insert-directory', but if FILE does not exist, it inserts a
5912 message to that effect instead of signaling an error."
5915 ;; Simulate the message printed by `ls'.
5919 "Functions to call with no arguments to query about killing Emacs.
5920 If any of these functions returns nil, killing Emacs is cancelled.
5921 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5925 "How to ask for confirmation when leaving Emacs.
5926 If nil, the default, don't ask at all. If the value is non-nil, it should
5927 be a predicate function such as `yes-or-no-p'."
5935 "Offer to save each buffer, then kill this Emacs process.
5936 With prefix ARG, silently save all file-visiting buffers, then kill."
5945 ;; process-list is not defined on MSDOS.
5947 active)
5956 ;; Query the user for other things, perhaps.
5963 "Offer to save each buffer, then kill the current connection.
5964 If the current frame has no client, kill Emacs itself.
5966 With prefix ARG, silently save all file-visiting buffers, then kill.
5968 If emacsclient was started with a list of filenames to edit, then
5969 only these files will be asked to be saved."
5974 \f
5975 ;; We use /: as a prefix to "quote" a file name
5976 ;; so that magic file name handlers will not apply to it.
5980 file-name-handler-alist))
5982 ;; We depend on being the last handler on the list,
5983 ;; so that anything else which does need handling
5984 ;; has been handled already.
5985 ;; So it is safe for us to inhibit *all* magic file name handlers.
5994 default-directory))
5995 ;; Get a list of the indices of the args which are file names.
5998 ;; The first six are special because they
5999 ;; return a file name. We want to include the /:
6000 ;; in the return value.
6001 ;; So just avoid stripping it in the first place.
6008 ;; `identity' means just return the first arg
6009 ;; not stripped of its quoting.
6011 ;; `add' means add "/:" to the result.
6013 ;; `quote' means add "/:" to buffer-file-name.
6015 ;; `unquote-then-quote' means set buffer-file-name
6016 ;; temporarily to unquoted filename.
6018 ;; List the arguments which are filenames.
6026 ;; For all other operations, treat the first argument only
6027 ;; as the file name.
6029 method
6030 ;; Copy ARGUMENTS so we can replace elements in it.
6034 ;; Strip off the /: from the file names that have it.
6042 "/"
6058 res))
6061 \f
6062 ;; Symbolic modes and read-file-modes.
6065 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6066 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6067 Others, or All) for whom to produce the mask.
6068 The bit-mask that is returned extracts from mode bits the access rights
6069 for the specified category of users."
6077 "Convert CHAR to a numeric value of mode bits.
6078 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6079 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6086 ;; Rights relative to the previous file modes.
6097 "Convert a symbolic mode string specification to an equivalent number.
6099 WHO-MASK is the bit-mask specifying the category of users to which to
6100 apply the access permissions. See `file-modes-char-to-who'.
6101 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6102 RIGHTS request to add, remove, or set permissions based on existing ones,
6109 char-right)
6116 num-rights
6120 op char-right)))
6121 num-rights))
6124 "Convert symbolic file modes to numeric file modes.
6125 MODES is the string to convert, it should match
6128 notation.
6129 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6130 MODES request to add, remove, or set permissions based on existing ones,
6144 num-who num-modes)
6147 num-modes)))
6150 "Read file modes in octal or symbolic notation and return its numeric value.
6151 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6152 ORIG-FILE is the name of a file on whose mode bits to base returned
6153 permissions if what user types requests to add, remove, or set permissions
6169 nil nil default)))
6175 \f
6176 ;; Trashcan handling.
6178 "Directory for `move-file-to-trash' to move files and directories to.
6179 This directory is only used when the function `system-move-file-to-trash'
6180 is not defined.
6181 Relative paths are interpreted relative to `default-directory'.
6182 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6192 "Move the file (or directory) named FILENAME to the trash.
6193 When `delete-by-moving-to-trash' is non-nil, this function is
6194 called by `delete-file' and `delete-directory' instead of
6195 deleting files outright.
6197 If the function `system-move-file-to-trash' is defined, call it
6198 with FILENAME as an argument.
6199 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6200 directory.
6201 Otherwise, trash FILENAME using the freedesktop.org conventions,
6202 like the GNOME, KDE and XFCE desktop environments. Emacs only
6206 ;; If `trash-directory' is non-nil, move the file there.
6210 trash-dir)))
6211 ;; We can't trash a parent directory of trash-directory.
6214 trash-dir filename))
6217 ;; Ensure that the trashed file-name is unique.
6224 ;; If `system-move-file-to-trash' is defined, use it.
6227 ;; Otherwise, use the freedesktop.org method, as specified at
6228 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6239 ;; Check if we have permissions to delete.
6243 ;; The trashed file cannot be the trash dir or its parent.
6246 trash-files-dir filename))
6249 trash-info-dir filename))
6251 ;; Ensure that the trash directory exists; otherwise, create it.
6260 ;; Try to move to trash with .trashinfo undo information
6265 ;; Perform url-encoding on FN. For compatibility with
6266 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6267 ;; for path separators.
6272 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6273 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6286 fn))
6291 ;; Attempt to make .trashinfo file, trying up to 5
6292 ;; times. The .trashinfo file is opened with O_EXCL,
6293 ;; as per trash-spec 0.7, even if that can be a problem
6294 ;; on old NFS versions...
6298 trash-files-dir))
6300 success info-fn)
6305 trash-info-dir))
6313 ;; Uniqify new-fn. (Some file managers do not
6314 ;; like Emacs-style backup file names---e.g. bug
6315 ;; 170956 in Konqueror bug tracker.)
6320 ;; Finally, try to move the file to the trashcan.
6324 \f
6349 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6350 ;;; files.el ends here