| blob | 4901c3872cd57d172eab361f79bb544793fae1dc |
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."
129 "Non-nil means create backups by copying to preserve a privileged owner.
130 Renaming may still be used (subject to control of other variables)
131 when it would not result in changing the owner of the file or if the owner
132 has a user id greater than the value of this variable. This is useful
133 when low-numbered uid's are used for special system users (such as root)
134 that must maintain ownership of certain files.
135 This variable is relevant only if `backup-by-copying' and
136 `backup-by-copying-when-mismatch' are nil."
141 "Predicate that looks at a file name and decides whether to make backups.
145 "Non-nil in a buffer means always offer to save buffer on exit.
146 Do so even if the buffer is not visiting a file.
147 Automatically local in all buffers."
153 "Non-nil means find a file under alternative names, in existing buffers.
154 This means if any existing buffer is visiting the file you want
155 under another name, you get the existing buffer instead of a new buffer."
160 "Non-nil means visit a file under its truename.
161 The truename of a file is found by chasing all links
162 both at the file level and at the levels of the containing directories."
168 "Specify which files should be reverted without query.
169 The value is a list of regular expressions.
170 If the file name matches one of these regular expressions,
171 then `revert-buffer' reverts the file without querying
172 if the file has changed on disk and you have not edited the buffer."
177 "The device number and file number of the file visited in the current buffer.
178 The value is a list of the form (FILENUM DEVNUM).
179 This pair of numbers uniquely identifies the file.
197 "The directory for writing temporary files."
204 "The directory for writing small temporary files.
205 If non-nil, this directory is used instead of `temporary-file-directory'
206 by programs that create small temporary files. This is for systems that
207 have fast storage with limited space, such as a RAM disk."
212 ;; The system null device. (Should reference NULL_DEVICE from C.)
240 "Non-nil means protect against I/O errors while saving files.
241 Some modes set this non-nil in particular buffers.
243 This feature works by writing the new contents into a temporary file
244 and then renaming the temporary file to replace the original.
245 In this way, any I/O error in writing leaves the original untouched,
246 and there is never any instant where the file is nonexistent.
248 Note that this feature forces backups to be made by copying.
249 Yet, at the same time, saving a precious file
250 breaks any hard links between it and other files.
252 This feature is advisory: for example, if the directory in which the
253 file is being saved is not writable, Emacs may ignore a non-nil value
254 of `file-precious-flag' and write directly into the file.
256 See also: `break-hardlink-on-save'."
261 "Non-nil means when saving a file that exists under several names
262 \(i.e., has multiple hardlinks), break the hardlink associated with
263 `buffer-file-name' and write to a new file, so that the other
264 instances of the file are not affected by the save.
266 If `buffer-file-name' refers to a symlink, do not break the symlink.
268 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
269 For example, if the directory in which a file is being saved is not
270 itself writable, then error instead of saving in some
271 hardlink-nonbreaking way.
273 See also `backup-by-copying' and `backup-by-copying-when-linked'."
279 "Control use of version numbers for backup files.
280 When t, make numeric backup versions unconditionally.
281 When nil, make them for files that have some already.
282 The value `never' means do not make them."
292 "When cleaning directory, number of versions to keep."
298 "If t, delete excess backup versions silently.
299 If nil, ask confirmation. Any other value prevents any trimming."
306 "Number of oldest versions to keep when a new numbered backup is made."
312 "Number of newest versions to keep when a new numbered backup is made.
313 Includes the new backup. Must be > 0"
319 "Whether to add a newline automatically at the end of the file.
321 A value of t means do this only when the file is about to be saved.
322 A value of `visit' means do this right after the file is visited.
323 A value of `visit-save' means do it at both of those times.
324 Any other non-nil value means ask user whether to add a newline, when saving.
325 A value of nil means don't add newlines.
327 Certain major modes set this locally to the value obtained
328 from `mode-require-final-newline'."
337 "Whether to add a newline at end of file, in certain major modes.
338 Those modes set `require-final-newline' to this value when you enable them.
339 They do so because they are often used for files that are supposed
340 to end in newlines, and the question is how to arrange that.
342 A value of t means do this only when the file is about to be saved.
343 A value of `visit' means do this right after the file is visited.
344 A value of `visit-save' means do it at both of those times.
345 Any other non-nil value means ask user whether to add a newline, when saving.
347 A value of nil means do not add newlines. That is a risky choice in this
348 variable since this value is used for modes for files that ought to have
349 final newlines. So if you set this to nil, you must explicitly check and
350 add a final newline, whenever you save a file that really needs one."
360 "Non-nil says by default do auto-saving of every file-visiting buffer."
366 ;; Don't put "\\2" inside expand-file-name, since it will be
367 ;; transformed to "/2" on DOS/Windows.
369 "Transforms to apply to buffer file name before making auto-save file name.
370 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
371 REGEXP is a regular expression to match against the file name.
372 If it matches, `replace-match' is used to replace the
373 matching part with REPLACEMENT.
374 If the optional element UNIQUIFY is non-nil, the auto-save file name is
375 constructed by taking the directory part of the replaced file-name,
376 concatenated with the buffer file name with all directory separators
377 changed to `!' to prevent clashes. This will not work
378 correctly if your filesystem truncates the resulting name.
380 All the transforms in the list are tried, in the order they are listed.
381 When one transform applies, its result is final;
382 no further transforms are tried.
384 The default value is set up to put the auto-save file into the
385 temporary directory (see the variable `temporary-file-directory') for
386 editing a remote file.
388 On MS-DOS filesystems without long names this variable is always
389 ignored."
397 "Non-nil means save word abbrevs too when files are saved.
398 If `silently', don't ask the user before saving."
403 "Non-nil means allow `find-file' to visit directories.
404 To visit the directory, `find-file' runs `find-directory-functions'."
409 "List of functions to try in sequence to visit a directory.
410 Each function is called with the directory name as the sole argument
411 and should return either a buffer or nil."
415 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
417 "List of functions to try in sequence to get a file name at point.
418 Each function should return either nil or a file name found at the
419 location of point in the current buffer."
423 ;;;It is not useful to make this a local variable.
424 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
426 "List of functions to be called for `find-file' on nonexistent file.
427 These functions are called as soon as the error is detected.
428 Variable `buffer-file-name' is already set up.
433 ;;;It is not useful to make this a local variable.
434 ;;;(put 'find-file-hooks 'permanent-local t)
437 "List of functions to be called after a buffer is loaded from a file.
438 The buffer's local variables (if any) will have been processed before the
439 functions are called."
446 "List of functions to be called before writing out a buffer to a file.
447 If one of them returns non-nil, the file is considered already written
448 and the rest are not called.
449 These hooks are considered to pertain to the visited file.
450 So any buffer-local binding of this variable is discarded if you change
452 change the major mode.
454 This hook is not run if any of the functions in
455 `write-contents-functions' returns non-nil. Both hooks pertain
456 to how to save a buffer to file, for instance, choosing a suitable
457 coding system and setting mode bits. (See Info
458 node `(elisp)Saving Buffers'.) To perform various checks or
469 "List of functions to be called before writing out a buffer to a file.
470 If one of them returns non-nil, the file is considered already written
471 and the rest are not called and neither are the functions in
472 `write-file-functions'.
474 This variable is meant to be used for hooks that pertain to the
475 buffer's contents, not to the particular visited file; thus,
476 `set-visited-file-name' does not clear this variable; but changing the
477 major mode does clear it.
479 For hooks that _do_ pertain to the particular visited file, use
480 `write-file-functions'. Both this variable and
481 `write-file-functions' relate to how a buffer is saved to file.
482 To perform various checks or updates before the buffer is saved,
489 "Control use of local variables in files you visit.
490 The value can be t, nil, :safe, :all, or something else.
492 A value of t means file local variables specifications are obeyed
493 if all the specified variable values are safe; if any values are
494 not safe, Emacs queries you, once, whether to set them all.
495 \(When you say yes to certain values, they are remembered as safe.)
497 :safe means set the safe variables, and ignore the rest.
498 :all means set all variables, whether safe or not.
499 (Don't set it permanently to :all.)
500 A value of nil means always ignore the file local variables.
502 Any other value means always query you once whether to set them all.
503 \(When you say yes to certain values, they are remembered as safe, but
506 This variable also controls use of major modes specified in
507 a -*- line.
510 always obeys file local variable specifications and the -*- line,
511 and ignores this variable."
512 :risky t
521 "Like `enable-local-variables' but meant for buffer-local bindings.
522 The meaningful values are nil and non-nil. The default is non-nil.
523 If a major mode sets this to nil, buffer-locally, then any local
524 variables list in the file will be ignored.
526 This variable does not affect the use of major modes
531 The value can be t, nil or something else.
532 A value of t means obey `eval' variables.
533 A value of nil means ignore them; anything else means query."
534 :risky t
540 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
549 "Non-nil means buffers visiting files read-only do so in view mode.
550 In fact, this means that all read-only buffers normally have
551 View mode enabled, including buffers that are read-only because
552 you visit a file you cannot alter, and buffers you make read-only
558 "History list of file names entered in the minibuffer.
560 Maximum length of the history list is determined by the value
562 \f
565 "Provides support for ange-ftp host name completion.
566 Runs the usual ange-ftp hook, but only for completion operations."
567 ;; Having this here avoids the need to load ange-ftp when it's not
568 ;; really in use.
574 inhibit-file-name-handlers)))
579 "Convert a standard file's name to something suitable for the OS.
580 This means to guarantee valid names and perhaps to canonicalize
581 certain patterns.
583 FILENAME should be an absolute file name since the conversion rules
584 sometimes vary depending on the position in the file name. E.g. c:/foo
585 is a valid DOS file name, but c:/bar/c:/foo is not.
587 This function's standard definition is trivial; it just returns
588 the argument. However, on Windows and DOS, replace invalid
589 characters. On DOS, make sure to obey the 8.3 limitations.
590 In the native Windows build, turn Cygwin names into native names,
591 and also turn slashes into backslashes if the shell requires it (see
592 `w32-shell-dos-semantics').
594 See Info node `(elisp)Standard File Names' for more details."
598 ;; Replace invalid filename characters with !
602 name)
603 filename))
606 "Read directory name, prompting with PROMPT and completing in directory DIR.
607 Value is not expanded---you must call `expand-file-name' yourself.
608 Default name to DEFAULT-DIRNAME if user exits with the same
609 non-empty string that was inserted by this function.
610 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
611 or just DIR if INITIAL is nil.)
612 If the user exits with an empty minibuffer, this function returns
613 an empty string. (This can only happen if the user erased the
614 pre-inserted contents or if `insert-default-directory' is nil.)
615 Fourth arg MUSTMATCH non-nil means require existing directory's name.
616 Non-nil and non-t means also require confirmation after completion.
617 Fifth arg INITIAL specifies text to start with.
618 DIR should be an absolute directory name. It defaults to
619 the value of `default-directory'."
624 dir))
625 mustmatch initial
628 \f
630 "Show the current default directory."
635 "Value of the CDPATH environment variable, as a list.
639 "Explode a search path into a list of directory names.
640 Directories are separated by occurrences of `path-separator'
641 \(which is colon in GNU and GNU-like systems)."
642 ;; We could use split-string here.
650 nil
655 cd-list)))
658 "Change current directory to given absolute file name DIR."
659 ;; Put the name into directory syntax now,
660 ;; because otherwise expand-file-name may give some bad results.
662 ;; We used to additionally call abbreviate-file-name here, for an
663 ;; unknown reason. Problem is that most buffers are setup
664 ;; without going through cd-absolute and don't call
665 ;; abbreviate-file-name on their default-directory, so the few that
666 ;; do end up using a superficially different directory.
678 "Make DIR become the current buffer's default directory.
679 If your environment includes a `CDPATH' variable, try each one of
680 that list of directories (separated by occurrences of
681 `path-separator') when resolving a relative directory name.
682 The path separator is colon in GNU and GNU-like systems."
685 default-directory default-directory
701 cd-path)
702 nil))
706 "Load the Lisp file named FILE."
707 ;; This is a case where .elc makes a lot of sense.
714 "Search for FILENAME through PATH.
715 If found, return the absolute file name of FILENAME, with its suffixes;
716 otherwise return nil.
717 PATH should be a list of directories to look in, like the lists in
718 `exec-path' or `load-path'.
719 If SUFFIXES is non-nil, it should be a list of suffixes to append to
722 If non-nil, PREDICATE is used instead of `file-readable-p'.
723 PREDICATE can also be an integer to pass to the `access' system call,
724 in which case file-name handlers are ignored. This usage is deprecated.
726 For compatibility, PREDICATE can also be one of the symbols
727 `executable', `readable', `writable', or `exists', or a list of
728 one or more of those symbols."
739 "Do completion for file names passed to `locate-file'."
742 ;; FIXME: maybe we should use completion-file-name-table instead,
743 ;; tho at least for `load', the arg is passed through
744 ;; substitute-in-file-name for historical reasons.
763 string-file dir))
769 string-dir names string-file pred action)))))
772 "Do completion for file names passed to `locate-file'.
773 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
776 string nil action))
781 "Regexp of directory names which stop the search in `locate-dominating-file'.
782 Any directory whose name matches this regexp will be treated like
783 a kind of root directory by `locate-dominating-file' which will stop its search
784 when it bumps into it.
785 The default regexp prevents fruitless and time-consuming attempts to find
786 special files in directories in which filenames are interpreted as hostnames,
789 ;; (defun locate-dominating-files (file regexp)
790 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
791 ;; Stop at the first parent where a matching file is found and return the list
792 ;; of files that that match in this directory."
793 ;; (catch 'found
794 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
795 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
796 ;; (let ((user nil)
797 ;; ;; Abbreviate, so as to stop when we cross ~/.
798 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
799 ;; files)
800 ;; (while (and dir
801 ;; ;; As a heuristic, we stop looking up the hierarchy of
802 ;; ;; directories as soon as we find a directory belonging to
803 ;; ;; another user. This should save us from looking in
804 ;; ;; things like /net and /afs. This assumes that all the
805 ;; ;; files inside a project belong to the same user.
806 ;; (let ((prev-user user))
807 ;; (setq user (nth 2 (file-attributes dir)))
808 ;; (or (null prev-user) (equal user prev-user))))
809 ;; (if (setq files (condition-case nil
810 ;; (directory-files dir 'full regexp 'nosort)
811 ;; (error nil)))
812 ;; (throw 'found files)
813 ;; (if (equal dir
814 ;; (setq dir (file-name-directory
815 ;; (directory-file-name dir))))
816 ;; (setq dir nil))))
817 ;; nil)))
820 "Look up the directory hierarchy from FILE for a file named NAME.
821 Stop at the first parent directory containing a file NAME,
822 and return the directory. Return nil if not found."
823 ;; We used to use the above locate-dominating-files code, but the
824 ;; directory-files call is very costly, so we're much better off doing
825 ;; multiple calls using the code in here.
826 ;;
827 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
828 ;; `name' in /home or in /.
832 ;; `user' is not initialized outside the loop because
833 ;; `file' may not exist, so we may have to walk up part of the
834 ;; hierarchy before we find the "initial UID".
836 try)
839 ;; FIXME: Disabled this heuristic because it is sometimes
840 ;; inappropriate.
841 ;; As a heuristic, we stop looking up the hierarchy of
842 ;; directories as soon as we find a directory belonging
843 ;; to another user. This should save us from looking in
844 ;; things like /net and /afs. This assumes that all the
845 ;; files inside a project belong to the same user.
846 ;; (let ((prev-user user))
847 ;; (setq user (nth 2 (file-attributes file)))
848 ;; (and prev-user (not (equal user prev-user))))
856 root))
860 "Search for COMMAND in `exec-path' and return the absolute file name.
861 Return nil if COMMAND is not found anywhere in `exec-path'."
862 ;; Use 1 rather than file-executable-p to better match the behavior of
863 ;; call-process.
867 "Load the Emacs Lisp library named LIBRARY.
868 This is an interface to the function `load'. LIBRARY is searched
869 for in `load-path', both with and without `load-suffixes' (as
870 well as `load-file-rep-suffixes').
872 See Info node `(emacs)Lisp Libraries' for more details.
873 See `load-file' for a different interface to `load'."
877 load-path
882 "Test whether FILE specifies a location on a remote system.
883 Returns nil or a string identifying the remote connection (ideally
884 a prefix of FILE). For example, the remote identification for filename
887 less reliable than accessing local files.
888 Furthermore, relative file names do not work across remote connections.
890 IDENTIFICATION specifies which part of the identification shall
891 be returned as string. IDENTIFICATION can be the symbol
892 `method', `user', `host' or `localname'; any other value is
893 handled like nil and means to return the complete identification
894 string.
896 If CONNECTED is non-nil, the function returns an identification only
897 if FILE is located on a remote system, and a connection is established
898 to that remote system.
900 `file-remote-p' will never open a connection on its own."
904 nil)))
907 "Copy the file FILE into a temporary file on this machine.
908 Returns the name of the local copy, or nil, if FILE is directly
909 accessible."
910 ;; This formerly had an optional BUFFER argument that wasn't used by
911 ;; anything.
915 nil)))
918 "Return the truename of FILENAME, which should be absolute.
919 The truename of a file name is found by chasing symbolic links
920 both at the level of the file and at the level of the directories
921 containing it, until no links are left at any level.
924 ;; COUNTER and PREV-DIRS are only used in recursive calls.
925 ;; COUNTER can be a cons cell whose car is the count of how many
926 ;; more links to chase before getting an error.
927 ;; PREV-DIRS can be a cons cell whose car is an alist
928 ;; of truenames we've just recently computed.
942 ;; For speed, remove the ange-ftp completion handler from the list.
943 ;; We know it's not needed here.
944 ;; For even more speed, do this only on the outermost call.
951 ;; andrewi@harlequin.co.uk - none of the following code (except for
952 ;; invoking the file-name handler) currently applies on Windows
953 ;; (ie. there are no native symlinks), but there is an issue with
954 ;; case differences being ignored by the OS, and short "8.3 DOS"
955 ;; name aliases existing for all files. (The short names are not
956 ;; reported by directory-files, but can be used to refer to files.)
957 ;; It seems appropriate for file-truename to resolve these issues in
958 ;; the most natural way, which on Windows is to call the function
959 ;; `w32-long-file-name' - this returns the exact name of a file as
960 ;; it is stored on disk (expanding short name aliases with the full
961 ;; name in the process).
964 ;; For file name that has a special handler, call handler.
965 ;; This is so that ange-ftp can save time by doing a no-op.
968 ;; If filename contains a wildcard, newname will be the old name.
970 ;; If filename exists, use the long name. If it doesn't exist,
971 ;; drill down until we find a directory that exists, and use
972 ;; the long name of that, with the extra non-existent path
973 ;; components concatenated.
975 missing rest)
978 ;; Include the preceding directory separator in the missing
979 ;; part so subsequent recursion on the rest works.
984 ""
989 ;; If this file directly leads to a link, process that iteratively
990 ;; so that we don't use lots of stack.
996 ;; For file name that has a special handler, call handler.
997 ;; This is so that ange-ftp can save time by doing a no-op.
1000 done t)
1002 target dirfile)
1003 ;; Get the truename of the directory.
1005 ;; If these are equal, we have the (or a) root directory.
1007 ;; If this is the same dir we last got the truename for,
1008 ;; save time--don't recalculate.
1018 done t)
1021 done t)
1022 ;; Put it back on the file name.
1024 ;; Is the file name the name of a link?
1027 ;; Yes => chase that link, then start all over
1028 ;; since the link may point to a directory name that uses links.
1029 ;; We can't safely use expand-file-name here
1030 ;; since target might look like foo/../bar where foo
1031 ;; is itself a link. Instead, we handle . and .. above.
1034 target
1036 done nil)
1037 ;; No, we are done!
1039 filename))
1042 "Chase links in FILENAME until a name that is not a link.
1043 Unlike `file-truename', this does not check whether a parent
1044 directory name is a symbolic link.
1045 If the optional argument LIMIT is a number,
1046 it means chase no more than that many links and then stop."
1054 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1057 ;; Handle `..' by hand, since it needs to work in the
1058 ;; target of any directory symlink.
1059 ;; This code is not quite complete; it does not handle
1060 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1064 ;; Chase links in the default dir of the symlink.
1068 ;; Now find the parent of that dir.
1072 newname))
1075 "Create a temporary file.
1076 The returned file name (created by appending some random characters at the end
1077 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1078 is guaranteed to point to a newly created empty file.
1079 You can then use `write-region' to write new data into the file.
1081 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1083 If SUFFIX is non-nil, add that at the end of the file name."
1085 file)
1088 ;; Create temp files with strict access rights. It's easy to
1089 ;; loosen them later, whereas it's impossible to close the
1090 ;; time-window of loose permissions otherwise.
1098 temporary-file-directory)
1100 temporary-file-directory))))
1106 nil)
1108 ;; the file was somehow created by someone else between
1109 ;; `make-temp-name' and `write-region', let's try again.
1110 nil)
1111 file)
1112 ;; Reset the umask.
1116 "Change the encoding of FILE's name from CODING to NEW-CODING.
1117 The value is a new name of FILE.
1118 Signals a `file-already-exists' error if a file of the new name
1119 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1120 is non-nil. A number as fourth arg means request confirmation if
1121 the new name already exists. This is what happens in interactive
1122 use with M-x."
1125 default-file-name-coding-system))
1127 from-coding to-coding)
1129 ;; We provide the default coding only when it seems that
1130 ;; the filename is correctly decoded by the default
1131 ;; coding.
1137 filename default-coding)
1138 default-coding))
1142 ;; We provide the default coding only when a user is going to
1143 ;; change the encoding not from the default coding.
1147 filename from-coding)))
1150 filename from-coding default-coding)
1151 default-coding)))
1155 default-file-name-coding-system))
1156 ;; FILE should have been decoded by DEFAULT-CODING.
1160 ;; Suppress further encoding.
1165 newname))
1166 \f
1168 "Whether confirmation is requested before visiting a new file or buffer.
1169 If nil, confirmation is not requested.
1170 If the value is `after-completion', confirmation is only
1171 requested if the user called `minibuffer-complete' right before
1172 `minibuffer-complete-and-exit'.
1173 Any other non-nil value means to request confirmation.
1175 This affects commands like `switch-to-buffer' and `find-file'."
1183 "Whether to request confirmation before visiting a new file or buffer.
1184 The variable `confirm-nonexistent-file-or-buffer' determines the
1185 return value, which may be passed as the REQUIRE-MATCH arg to
1186 `read-buffer' or `find-file-read-args'."
1194 "Read the name of a buffer to switch to and return as a string.
1195 It is intended for `switch-to-buffer' family of commands since they
1196 need to omit the name of current buffer from the list of completions
1197 and default values."
1202 ;; Since rbts-completion-table is built dynamically, we
1203 ;; can't just add it to the default value of
1204 ;; icomplete-with-completion-tables, so we add it
1205 ;; here manually.
1210 icomplete-with-completion-tables))))
1215 "Select the buffer specified by BUFFER-OR-NAME in another window.
1216 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1217 nil. Return the buffer switched to.
1219 If called interactively, prompt for the buffer name using the
1220 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1221 determines whether to request confirmation before creating a new
1222 buffer.
1224 If BUFFER-OR-NAME is a string and does not identify an existing
1225 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1226 nil, switch to the buffer returned by `other-buffer'.
1228 Optional second argument NORECORD non-nil means do not put this
1229 buffer at the front of the list of recently selected ones.
1231 This uses the function `display-buffer' as a subroutine; see its
1232 documentation for additional customization information."
1236 same-window-buffer-names same-window-regexps)
1240 "Switch to buffer BUFFER-OR-NAME in another frame.
1241 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1242 nil. Return the buffer switched to.
1244 If called interactively, prompt for the buffer name using the
1245 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1246 determines whether to request confirmation before creating a new
1247 buffer.
1249 If BUFFER-OR-NAME is a string and does not identify an existing
1250 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1251 nil, switch to the buffer returned by `other-buffer'.
1253 Optional second arg NORECORD non-nil means do not put this
1254 buffer at the front of the list of recently selected ones.
1256 This uses the function `display-buffer' as a subroutine; see its
1257 documentation for additional customization information."
1261 same-window-buffer-names same-window-regexps)
1265 "Display buffer BUFFER in another frame.
1266 This uses the function `display-buffer' as a subroutine; see
1267 its documentation for additional customization information."
1270 same-window-buffer-names same-window-regexps
1272 new-window)
1274 ;; This may have been here in order to prevent the new frame from hiding
1275 ;; the old frame. But it does more harm than good.
1276 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1277 ;;(lower-frame (window-frame new-window))
1279 ;; This may have been here in order to make sure the old-frame gets the
1280 ;; focus. But not only can it cause an annoying flicker, with some
1281 ;; window-managers it just makes the window invisible, with no easy
1282 ;; way to recover it. --Stef
1283 ;;(make-frame-invisible (window-frame old-window))
1284 ;;(make-frame-visible (window-frame old-window))
1285 ))
1288 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1289 BODY should use the minibuffer at most once.
1290 Recursive uses of the minibuffer are unaffected (FUN is not
1291 called additional times).
1293 This macro actually adds an auxiliary function that calls FUN,
1294 rather than FUN itself, to `minibuffer-setup-hook'."
1300 ;; Clear out this hook so it does not interfere
1301 ;; with any recursive minibuffer usage.
1312 t))
1315 "Edit file FILENAME.
1316 Switch to a buffer visiting file FILENAME,
1317 creating one if none already exists.
1318 Interactively, the default if you just type RET is the current directory,
1319 but the visited file name is available through the minibuffer history:
1320 type M-n to pull it into the minibuffer.
1322 You can visit files on remote machines by specifying something
1323 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1324 also visit local files as a different user by specifying
1325 /sudo::FILE for the file name.
1326 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1327 manual, for more about this.
1329 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1330 expand wildcards (if any) and visit multiple files. You can
1331 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1333 To visit a file without any kind of conversion and without
1344 "Edit file FILENAME, in another window.
1347 an existing one. See the function `display-buffer'.
1349 Interactively, the default if you just type RET is the current directory,
1350 but the visited file name is available through the minibuffer history:
1351 type M-n to pull it into the minibuffer.
1353 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1354 expand wildcards (if any) and visit multiple files."
1367 "Edit file FILENAME, in another frame.
1370 an existing one. See the function `display-buffer'.
1372 Interactively, the default if you just type RET is the current directory,
1373 but the visited file name is available through the minibuffer history:
1374 type M-n to pull it into the minibuffer.
1376 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1377 expand wildcards (if any) and visit multiple files."
1390 "Edit the existing file FILENAME.
1392 file names with wildcards."
1401 "Edit file FILENAME but don't allow changes.
1415 value))
1418 "Edit file FILENAME in another window but don't allow changes.
1432 value))
1435 "Edit file FILENAME in another frame but don't allow changes.
1449 value))
1452 "Find file FILENAME as a replacement for the file in the next window.
1453 This command does not select that window.
1457 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1458 expand wildcards (if any) and replace the file with multiple files."
1469 "Find alternate file: " file-dir nil
1471 t))))
1479 "Find file FILENAME, select its buffer, kill previous buffer.
1480 If the current buffer now contains an empty file that you just visited
1481 \(presumably by mistake), use this command to visit the file you really want.
1485 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1486 expand wildcards (if any) and replace the file with multiple files.
1488 If the current buffer is an indirect buffer, or the base buffer
1489 for one or more indirect buffers, the other buffer(s) are not
1490 killed."
1499 "Find alternate file: " file-dir nil
1501 t)))
1516 ;; Run `kill-buffer-hook' here. It needs to happen before
1517 ;; variables like `buffer-file-name' etc are set to nil below,
1518 ;; because some of the hooks that could be invoked
1519 ;; (e.g., `save-place-to-alist') depend on those variables.
1520 ;;
1521 ;; Note that `kill-buffer-hook' is not what queries whether to
1522 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1523 ;; asks that itself. Thus, there's no need to temporarily do
1524 ;; `(set-buffer-modified-p nil)' before running this hook.
1526 ;; Okay, now we can end-of-life the old buffer.
1533 ;; This prevents us from finding the same buffer
1534 ;; if we specified the same file again.
1538 ;; Likewise for dired buffers.
1542 ;; This executes if find-file gets an error
1543 ;; and does not really find anything.
1544 ;; We put things back as they were.
1545 ;; If find-file actually finds something, we kill obuf below.
1554 ;; We already ran these; don't run them again.
1557 \f
1559 "Create a suitably named buffer for visiting FILENAME, and return it.
1560 FILENAME (sans directory) is used unchanged if that name is free;
1561 otherwise a string <2> or <3> or ... is appended to get an unused name.
1562 Spaces at the start of FILENAME (sans directory) are removed."
1571 "Create and return a buffer with a name based on NAME.
1572 Choose the buffer's name using `generate-new-buffer-name'."
1576 "Regexp to match the automounter prefix in a directory name."
1584 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1586 home directory is a root directory) and removes automounter prefixes
1587 \(see the variable `automount-dir-prefix')."
1588 ;; Get rid of the prefixes added by the automounter.
1595 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1596 ;; To fix this right, we need a `file-name-case-sensitive-p'
1597 ;; function, but we don't have that yet, so just guess.
1600 ;; If any elt of directory-abbrev-alist matches this name,
1601 ;; abbreviate accordingly.
1607 ;; Compute and save the abbreviated homedir name.
1608 ;; We defer computing this until the first time it's needed, to
1609 ;; give time for directory-abbrev-alist to be set properly.
1610 ;; We include a slash at the end, to avoid spurious matches
1611 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1618 ;; If FILENAME starts with the abbreviated homedir,
1619 ;; make it start with `~' instead.
1621 ;; If the home dir is just /, don't change it.
1624 ;; MS-DOS root directories can come with a drive letter;
1625 ;; Novell Netware allows drive letters beyond `Z:'.
1633 filename)))
1636 "List of logical names for which visiting shouldn't save the true dirname."
1641 "Return the buffer visiting file FILENAME (a string).
1642 This is like `get-file-buffer', except that it checks for any buffer
1643 visiting the same file, possibly under a different name.
1644 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1645 and others are ignored.
1646 If there is no such live buffer, return nil."
1659 found)
1669 ;; Verify this buffer's file number
1670 ;; still belongs to its file.
1673 attributes)
1677 found))))
1678 \f
1680 "Non-nil means file-visiting commands should handle wildcards.
1681 For example, if you specify `*.c', that would visit all the files
1682 whose names match the pattern."
1688 "Non-nil means suppress warning messages for symlinked files.
1689 When nil, Emacs prints a warning when visiting a file that is already
1690 visited, but with a different name. Setting this option to t
1691 suppresses this warning."
1697 "Maximum size of file above which a confirmation is requested.
1698 When nil, never request confirmation."
1705 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1706 OP-TYPE specifies the file operation being performed (for message to user)."
1716 "Read file FILENAME into a buffer and return the buffer.
1717 If a buffer exists visiting FILENAME, return that one, but
1718 verify that the file has not changed since visited or saved.
1719 The buffer is not selected, just returned to the caller.
1720 Optional second arg NOWARN non-nil means suppress any warning messages.
1721 Optional third arg RAWFILE non-nil means the file is read literally.
1722 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1723 and visit all the matching files. When wildcards are actually
1724 used and expanded, return a list of buffers that are visiting
1725 the various files."
1732 'find-directory-functions
1735 filename)))
1738 find-file-wildcards
1752 ;; Find any buffer for a file which has same truename.
1754 ;; Let user know if there is a buffer with the same truename.
1758 find-file-suppress-same-file-warnings
1762 ;; Optionally also find that buffer.
1765 ;; Check to see if the file looks uncommonly large.
1769 ;; We are using an existing buffer.
1776 ;; Certain files should be reverted automatically
1777 ;; if they have changed on disk and not in the buffer.
1785 found))
1795 "File %s changed on disk. Discard your edits? "
1800 "File %s changed on disk. Discard your edits in %s? "
1808 ;; Check if a formerly read-only file has become
1809 ;; writable and vice versa, but if the buffer agrees
1810 ;; with the new state of the file, that is ok too.
1818 buffer-file-name
1827 ;; It is confusing to ask whether to visit
1828 ;; non-literally if they have the file in
1829 ;; hexl-mode.
1835 "The file %s is already visited normally,
1836 and you have edited the buffer. Now you have asked to visit it literally,
1837 meaning no coding system handling, format conversion, or local variables.
1838 Emacs can only visit a file in one way at a time.
1840 Do you want to save the file, and visit it literally instead? "
1841 "The file %s is already visited literally,
1842 meaning no coding system handling, format conversion, or local variables.
1843 You have edited the buffer. Now you have asked to visit the file normally,
1844 but Emacs can only visit a file in one way at a time.
1851 rawfile truename number))
1855 "\
1856 Do you want to discard your changes, and visit the file literally now? "
1857 "\
1860 rawfile truename number)
1866 "The file %s is already visited normally.
1867 You have asked to visit it literally,
1868 meaning no coding system decoding, format conversion, or local variables.
1869 But Emacs can only visit a file in one way at a time.
1871 Do you want to revisit the file literally now? "
1872 "The file %s is already visited literally,
1873 meaning no coding system decoding, format conversion, or local variables.
1874 You have asked to visit it normally,
1875 but Emacs can only visit a file in one way at a time.
1880 rawfile truename number)
1883 ;; Return the buffer we are using.
1884 buf)
1885 ;; Create a new buffer.
1887 ;; find-file-noselect-1 may use a different buffer.
1889 rawfile truename number))))))
1895 ;; Needed in case we are re-visiting the file with a different
1896 ;; text representation.
1913 filename)))
1914 ;; Unconditionally set error
1924 filename)))
1925 ;; Run find-file-not-found-functions until one returns non-nil.
1927 ;; If they fail too, set error.
1929 ;; Record the file's truename, and maybe use that as visited name.
1937 ;; Set buffer's default directory to that of the file.
1939 ;; Turn off backup files for certain file names. Since
1940 ;; this is a permanent local, the major mode won't eliminate it.
1955 \f
1957 "Like `insert-file-contents', but only reads in the file literally.
1958 A buffer may be modified in several ways after reading into the buffer,
1959 to Emacs features such as format decoding, character code
1960 conversion, `find-file-hook', automatic uncompression, etc.
1962 This function ensures that none of these modifications will take place."
1970 nil))
1973 inhibit-file-name-handlers))
1986 filename)))
1987 ;; Check whether the file is uncommonly large
1998 "Insert contents of file FILENAME into buffer after point with no conversion.
2000 This function is meant for the user to run interactively.
2001 Don't call it from programs! Use `insert-file-contents-literally' instead.
2002 \(Its calling sequence is different; see its documentation)."
2007 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2012 "Visit file FILENAME with no conversion of any kind.
2013 Format conversion and character code conversion are both disabled,
2014 and multibyte characters are disabled in the resulting buffer.
2015 The major mode used is Fundamental mode regardless of the file name,
2016 and local variable specifications in the file are ignored.
2017 Automatic uncompression and adding a newline at the end of the
2018 file due to `require-final-newline' is also disabled.
2020 You cannot absolutely rely on this function to result in
2021 visiting the file literally. If Emacs already has a buffer
2022 which is visiting the file, you get the existing buffer,
2023 regardless of whether it was created literally or not.
2025 In a Lisp program, if you want to be sure of accessing a file's
2026 contents literally, you should create a temporary buffer and then read
2027 the file contents into it using `insert-file-contents-literally'."
2030 "Find file literally: " nil default-directory
2033 \f
2037 after-find-file-from-revert-buffer
2038 nomodes)
2039 "Called after finding a file and by the default revert function.
2040 Sets buffer mode, parses local variables.
2041 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2042 error in reading the file. WARN non-nil means warn if there
2043 exists an auto-save file more recent than the visited file.
2044 NOAUTO means don't mess with auto-save mode.
2045 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2046 means this call was from `revert-buffer'.
2047 Fifth arg NOMODES non-nil means don't alter the file's modes.
2048 Finishes by calling the functions in `find-file-hook'
2049 unless NOMODES is non-nil."
2052 nil
2062 ;; No need to warn if buffer is auto-saved
2063 ;; under the name of the visited file.
2065 auto-save-visited-file-name))
2068 buffer-file-name))
2088 ;; Make people do a little extra work (C-x C-q)
2089 ;; before altering a backup file.
2092 ;; When a file is marked read-only,
2093 ;; make the buffer read-only even if root is looking at it.
2101 ;; If requested, add a newline at the end of the file.
2111 view-read-only
2117 "Eval BODY and turn any error into a FORMAT message.
2118 FORMAT can have a %s escape which will be replaced with the actual error.
2119 If `debug-on-error' is set, errors are not caught, so that you can
2120 debug them.
2121 Avoid using a large BODY since it is duplicated."
2130 "Choose the major mode for this buffer automatically.
2131 Also sets up any specified local variables of the file.
2132 Uses the visited file name, the -*- line, and the local variables spec.
2134 This function is called automatically from `find-file'. In that case,
2135 we may set up the file-specified mode and local variables,
2136 depending on the value of `enable-local-variables'.
2137 In addition, if `local-enable-local-variables' is nil, we do
2138 not set local variables (though we do notice a mode specified with -*-.)
2140 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2141 or from Lisp without specifying the optional argument FIND-FILE;
2142 in that case, this function acts as if `enable-local-variables' were t."
2150 ;; Turn font lock off and on, to make sure it takes account of
2151 ;; whatever file local variables are relevant to it.
2153 ;; Font-lock-mode (now in font-core.el) can be ON when
2154 ;; font-lock.el still hasn't been loaded.
2164 "Non-nil means to try second pass through `auto-mode-alist'.
2165 This means that if the first case-sensitive search through the alist fails
2166 to find a matching major mode, a second case-insensitive search is made.
2167 On systems with case-insensitive file names, this variable is ignored,
2168 since only a single case-insensitive search through the alist is made."
2174 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2175 ;; c++-mode, java-mode and more) are added through autoload
2176 ;; directives in that file. That way is discouraged since it
2177 ;; spreads out the definition of the initial value.
2212 ;; Less common extensions come here
2213 ;; so more common ones above are found faster.
2253 ;; The list of archive file extensions should be in sync with
2254 ;; `auto-coding-alist' with `no-conversion' coding system.
2260 ;; Mailer puts message to be edited in
2261 ;; /tmp/Re.... or Message
2265 ;; some news reader is reported to use this
2274 ;; .emacs or .gnus or .viper following a directory delimiter in
2275 ;; Unix, MSDOG or VMS syntax.
2278 ;; _emacs following a directory delimiter
2279 ;; in MsDos syntax
2283 ;; Common Lisp ASDF package system.
2302 ;; Windows candidates may be opened case sensitively on Unix
2308 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2310 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2311 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2312 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2313 ;; this has lower priority to avoid matching changelog.sgml etc.
2315 ;; either user's dot-files or under /etc or some such
2317 ;; alas not all ~/.*rc files are like this
2318 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2323 ;; this contains everything twice, with space and with colon :-(
2325 ;; Get rid of any trailing .n.m and try again.
2326 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2327 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2328 ;; Using mode nil rather than `ignore' would let the search continue
2329 ;; through this list (with the shortened name) rather than start over.
2331 ;; The following should come after the ChangeLog pattern
2332 ;; for the sake of ChangeLog.1, etc.
2333 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2336 "Alist of filename patterns vs corresponding major mode functions.
2337 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2338 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2339 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2340 mode function to use. FUNCTION will be called, unless it is nil.
2342 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2343 calling FUNCTION (if it's not nil), we delete the suffix that matched
2344 REGEXP and search the list again for another match.
2346 If the file name matches `inhibit-first-line-modes-regexps',
2347 then `auto-mode-alist' is not processed.
2349 The extensions whose FUNCTION is `archive-mode' should also
2350 appear in `auto-coding-alist' with `no-conversion' coding system.
2352 See also `interpreter-mode-alist', which detects executable script modes
2353 based on the interpreters they specify to run,
2358 "Select Conf mode or XML mode according to start of file."
2368 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2369 ;; and pike-mode) are added through autoload directives in that
2370 ;; file. That way is discouraged since it spreads out the
2371 ;; definition of the initial value.
2409 "Alist mapping interpreter names to major modes.
2410 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2411 Each element looks like (INTERPRETER . MODE).
2412 If INTERPRETER matches the name of the interpreter specified in the first line
2413 of a script, mode MODE is enabled.
2421 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2422 When checking `inhibit-first-line-modes-regexps', we first discard
2428 "Regexp matching interpreters, for file mode determination.
2429 This regular expression is matched against the first line of a file
2430 to determine the file's mode in `set-auto-mode'. If it matches, the file
2431 is assumed to be interpreted by the interpreter matched by the second group
2432 of the regular expression. The mode is then determined as the mode
2436 "Alist of buffer beginnings vs. corresponding major mode functions.
2437 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2438 After visiting a file, if REGEXP matches the text at the beginning of the
2439 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2440 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2441 major mode.
2443 If FUNCTION is nil, then it is not called. (That is a way of saying
2451 ;; The < comes before the groups (but the first) to reduce backtracking.
2452 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2453 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2457 comment-re "*"
2460 . html-mode)
2462 ;; These two must come after html, because they are more general:
2467 . sgml-mode)
2470 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2471 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2472 After visiting a file, if REGEXP matches the text at the beginning of the
2473 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2474 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2475 have not specified a mode for this file.
2481 "Upper limit on `magic-mode-alist' regexp matches.
2485 "Select major mode appropriate for current buffer.
2487 To find the right major mode, this function checks for a -*- mode tag,
2488 checks if it uses an interpreter listed in `interpreter-mode-alist',
2489 matches the buffer beginning against `magic-mode-alist',
2490 compares the filename against the entries in `auto-mode-alist',
2491 then matches the buffer beginning against `magic-fallback-mode-alist'.
2493 It does not check for the `mode:' local variable in the
2494 Local Variables section of the file; for that, use `hack-local-variables'.
2496 If `enable-local-variables' is nil, this function does not check for a
2497 -*- mode tag.
2499 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2500 set the major mode only if that would change it. In other words
2501 we don't actually set it to the same mode the buffer already has."
2502 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2504 ;; Find a -*- mode tag
2511 ;; Find all specifications for the `mode:' variable
2512 ;; and execute them left to right.
2524 modes)))
2525 ;; Simple -*-MODE-*- case.
2528 modes))))
2529 ;; If we found modes to use, invoke them now, outside the save-excursion.
2537 ;; continuing would call minor modes again, toggling them off
2539 ;; If we didn't, look for an interpreter specified in the first line.
2540 ;; As a special case, allow for things like "#!/bin/env perl", which
2541 ;; finds the interpreter anywhere in $PATH.
2548 ;; Map interpreter name to a mode, signalling we're done at the
2549 ;; same time.
2551 interpreter-mode-alist))
2552 ;; If we found an interpreter mode to use, invoke it now.
2555 ;; Next try matching the buffer beginning against magic-mode-alist.
2569 ;; Next compare the filename against the entries in auto-mode-alist.
2574 ;; Remove remote file name identification.
2578 ;; Remove backup-suffixes from file name.
2581 ;; Find first matching alist entry.
2584 ;; System is case-insensitive.
2588 ;; System is case-sensitive.
2590 ;; First match case-sensitively.
2594 ;; Fallback to case-insensitive match.
2608 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2623 ;; When `keep-mode-if-same' is set, we are working on behalf of
2624 ;; set-visited-file-name. In that case, if the major mode specified is the
2625 ;; same one we already have, don't actually reset it. We don't want to lose
2626 ;; minor modes such as Font Lock.
2628 "Apply MODE and return it.
2629 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2630 any aliases and compared to current major mode. If they are the
2631 same, do nothing and return nil."
2637 mode)))
2640 "Find the -*- spec in the buffer.
2641 Call with point at the place to start searching from.
2642 If one is found, set point to the beginning
2643 and return the position of the end.
2644 Otherwise, return nil; point may be changed."
2647 ;; Don't look for -*- if this file name matches any
2648 ;; of the regexps in inhibit-first-line-modes-regexps.
2656 sufs)
2664 ;; If the file begins with "#!"
2665 ;; (exec interpreter magic), look
2666 ;; for mode frobs in the first two
2667 ;; lines. You cannot necessarily
2668 ;; put them in the first line of
2669 ;; such a file without screwing up
2670 ;; the interpreter invocation.
2671 ;; The same holds for
2672 ;; '\"
2673 ;; in man pages (preprocessor
2674 ;; magic for the `man' program).
2685 end))))
2686 \f
2687 ;;; Handling file local variables
2691 file-local-variables-alist dir-local-variables-alist)
2696 "Normal hook run after processing a file's local variables specs.
2697 Major modes can use this to examine user-specified local variables
2701 "List variable-value pairs that are considered safe.
2702 Each element is a cons cell (VAR . VAL), where VAR is a variable
2703 symbol and VAL is a value that is considered safe."
2704 :risky t
2711 "Expressions that are considered safe in an `eval:' local variable.
2712 Add expressions to this list if you want Emacs to evaluate them, when
2713 they appear in an `eval' local variable specification, without first
2714 asking you for confirmation."
2715 :risky t
2720 ;; Risky local variables:
2723 buffer-auto-save-file-name
2724 buffer-file-name
2725 buffer-file-truename
2726 buffer-undo-list
2727 debugger
2728 default-text-properties
2729 eval
2730 exec-directory
2731 exec-path
2732 file-name-handler-alist
2733 frame-title-format
2734 global-mode-string
2735 header-line-format
2736 icon-title-format
2737 inhibit-quit
2738 load-path
2739 max-lisp-eval-depth
2740 max-specpdl-size
2741 minor-mode-map-alist
2742 minor-mode-overriding-map-alist
2743 mode-line-format
2744 mode-name
2745 overriding-local-map
2746 overriding-terminal-local-map
2747 process-environment
2748 standard-input
2749 standard-output
2750 unread-command-events))
2752 ;; Safe local variables:
2753 ;;
2754 ;; For variables defined by major modes, the safety declarations can go into
2755 ;; the major mode's file, since that will be loaded before file variables are
2756 ;; processed.
2757 ;;
2758 ;; For variables defined by minor modes, put the safety declarations in the
2759 ;; file defining the minor mode after the defcustom/defvar using an autoload
2760 ;; cookie, e.g.:
2761 ;;
2762 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2763 ;;
2764 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2765 ;; minor mode file may not be loaded yet.
2766 ;;
2767 ;; For variables defined in the C source code the declaration should go here:
2784 "Alist of file-local variable settings in the current buffer.
2785 Each element in this list has the form (VAR . VALUE), where VAR
2786 is a file-local variable (a symbol) and VALUE is the value
2787 specified. The actual value in the buffer may differ from VALUE,
2792 "Alist of directory-local variable settings in the current buffer.
2793 Each element in this list has the form (VAR . VALUE), where VAR
2794 is a directory-local variable (a symbol) and VALUE is the value
2795 specified in .dir-locals.el. The actual value in the buffer
2796 may differ from VALUE, if it is changed by the major or minor modes,
2801 "Normal hook run before setting file-local variables.
2802 It is called after checking for unsafe/risky variables and
2803 setting `file-local-variables-alist', and before applying the
2804 variables stored in `file-local-variables-alist'. A hook
2805 function is allowed to change the contents of this alist.
2807 This hook is called only if there is at least one file-local
2811 "Get confirmation before setting up local variable values.
2812 ALL-VARS is the list of all variables to be set up.
2813 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2814 RISKY-VARS is the list of those that are marked as risky.
2815 DIR-NAME is a directory name if these settings come from
2816 directory-local variables, or nil otherwise."
2818 nil
2824 prompt char)
2834 ", and variables that are risky (**)."
2841 y -- to apply the local variables list.
2845 ! -- to apply the local variables list, and permanently mark these
2857 ;; Make strings with embedded whitespace easier to read.
2865 ""
2872 done)
2881 ;; read-event returns -1 if we are in a kbd
2882 ;; macro and there are no more events in the
2883 ;; macro. In that case, attempt to get an
2884 ;; event interactively.
2892 ;; When this is called from desktop-restore-file-buffer,
2893 ;; coding-system-for-read may be non-nil. Reset it before
2894 ;; writing to .emacs.
2898 'safe-local-variable-values
2899 safe-local-variable-values))))
2906 "Return local variables specified in the -*- line.
2907 Ignore any specification for `mode:' and `coding:';
2908 `set-auto-mode' should already have handled `mode:',
2909 `set-auto-coding' should already have handled `coding:'.
2911 If MODE-ONLY is non-nil, all we do is check whether the major
2912 mode is specified, returning t if it is specified. Otherwise,
2913 return an alist of elements (VAR . VAL), where VAR is a variable
2914 and VAL is the specified value."
2918 result mode-specified)
2919 ;; Parse the -*- line into the RESULT alist.
2920 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2922 nil)
2924 ;; Simple form: "-*- MODENAME -*-". Already handled.
2926 nil)
2928 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2929 ;; (last ";" is optional).
2934 ;; There used to be a downcase here,
2935 ;; but the manual didn't say so,
2936 ;; and people want to set var names that aren't all lc.
2942 ;; It is traditional to ignore
2943 ;; case when checking for `mode' in set-auto-mode,
2944 ;; so we must do that here as well.
2945 ;; That is inconsistent, but we're stuck with it.
2946 ;; The same can be said for `coding' in set-auto-coding.
2952 'eval
2959 mode-specified
2960 result))))
2963 "Filter local variable settings, querying the user if necessary.
2964 VARIABLES is the alist of variable-value settings. This alist is
2965 filtered based on the values of `ignored-local-variables',
2966 `enable-local-eval', `enable-local-variables', and (if necessary)
2967 user interaction. The results are added to
2968 `file-local-variables-alist', without applying them.
2969 DIR-NAME is a directory name if these settings come from
2970 directory-local variables, or nil otherwise."
2971 ;; Find those variables that we may want to save to
2972 ;; `safe-local-variable-values'.
2978 ;; Ignore any variable in `ignored-local-variables'.
2979 nil)
2980 ;; Obey `enable-local-eval'.
2988 ;; Ignore duplicates (except `mode') in the present list.
2990 ;; Accept known-safe variables.
2994 ;; The variable is either risky or unsafe:
3001 ;; Query, unless all vars are safe or user wants no querying.
3007 risky-vars dir-name))
3018 "Parse and put into effect this buffer's local variables spec.
3019 If MODE-ONLY is non-nil, all we do is check whether the major mode
3020 is specified, returning t if it is specified."
3023 result)
3030 ;; Look for "Local variables:" line in last page.
3038 ;; suffix is what comes after "local variables:" in its line.
3039 ;; prefix is what comes before "local variables:" in its line.
3049 beg)
3053 endpos
3059 nil t))
3060 ;; This used to be an error, but really all it means is
3061 ;; that this may simply not be a local-variables section,
3062 ;; so just ignore it.
3072 ;; Discard the prefix.
3077 ;; Discard the suffix.
3085 ;; Find the variable name; strip whitespace.
3094 val)
3095 ;; Read the variable value.
3106 'eval
3111 ;; Now we've read all the local variables.
3112 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3114 ;; Otherwise, set the variables.
3118 ;; Any 'evals must run in the Right sequence.
3127 "Non-nil if SYM is safe as a file-local variable with value VAL.
3128 It is safe if any of these conditions are met:
3130 * There is a matching entry (SYM . VAL) in the
3131 `safe-local-variable-values' user option.
3133 * The `safe-local-variable' property of SYM is a function that
3134 evaluates to a non-nil value with VAL as an argument."
3138 ;; If the function signals an error, that means it
3139 ;; can't assure us that the value is safe.
3143 "Non-nil if SYM could be dangerous as a file-local variable.
3144 It is dangerous if either of these conditions are met:
3146 * Its `risky-local-variable' property is non-nil.
3152 ;; If this is an alias, check the base name.
3172 "Return t if it is safe to eval EXP when it is found in a file."
3174 ;; Detect certain `put' expressions.
3181 lisp-indent-function
3182 scheme-indent-function))
3183 ;; Only allow safe values (not functions).
3188 ;; Only allow indirect form specs.
3189 ;; During bootstrapping, edebug-basic-spec might not be
3190 ;; defined yet.
3194 ;; Allow expressions that the user requested.
3196 ;; Certain functions can be allowed with safe arguments
3197 ;; or can specify verification functions to try.
3205 ok))
3213 ok)))))))
3216 "Set local variable VAR with value VAL.
3217 If VAR is `mode', call `VAL-mode' as a function unless it's
3218 already the major mode."
3225 ;; A minor mode must be passed an argument.
3226 ;; Otherwise, if the user enables the minor mode in a
3227 ;; major mode hook, this would toggle it off.
3233 ;; Make sure the string has no text properties.
3234 ;; Some text properties can get evaluated in various ways,
3235 ;; so it is risky to put them on with a local variable list.
3239 \f
3240 ;;; Handling directory-local variables, aka project settings.
3246 "List of cached directory roots for directory-local variable classes.
3247 Each element in this list has the form (DIR CLASS MTIME).
3248 DIR is the name of the directory.
3249 CLASS is the name of a variable class (a symbol).
3250 MTIME is the recorded modification time of the directory-local
3251 variables file associated with this entry. This time is a list
3252 of two integers (the same format as `file-attributes'), and is
3253 used to test whether the cache entry is still valid.
3254 Alternatively, MTIME can be nil, which means the entry is always
3258 "Return the variable list for CLASS."
3262 "Collect directory-local variables from MODE-VARIABLES.
3263 VARIABLES is the initial list of variables.
3264 Returns the new list."
3269 ;; If variables are specified more than once, only use the last. (Why?)
3270 ;; The pseudo-variables mode and eval are different (bug#3430).
3273 ;; Need a new cons in case we setcdr later.
3277 "Collect entries from CLASS-VARIABLES into VARIABLES.
3278 ROOT is the root directory of the project.
3279 Return the new variables list."
3287 ;; Don't include this in the previous condition, because we
3288 ;; want to filter all strings before the next condition.
3300 "Declare that the DIRECTORY root is an instance of CLASS.
3301 DIRECTORY is the name of a directory, a string.
3302 CLASS is the name of a project class, a symbol.
3303 MTIME is either the modification time of the directory-local
3304 variables file that defined this class, or nil.
3306 When a file beneath DIRECTORY is visited, the mode-specific
3307 variables from CLASS are applied to the buffer. The variables
3308 for a class are defined using `dir-locals-set-class-variables'."
3315 "Map the type CLASS to a list of variable settings.
3316 CLASS is the project class, a symbol. VARIABLES is a list
3317 that declares directory-local variables for the class.
3318 An element in VARIABLES is either of the form:
3319 (MAJOR-MODE . ALIST)
3320 or
3321 (DIRECTORY . LIST)
3323 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3324 whose elements are of the form (VARIABLE . VALUE).
3326 In the second form, DIRECTORY is a directory name (a string), and
3327 LIST is a list of the form accepted by the function.
3329 When a file is visited, the file's class is found. A directory
3330 may be assigned a class using `dir-locals-set-directory-class'.
3331 Then variables are set in the file's buffer according to the
3332 class' LIST. The list is processed in order.
3334 * If the element is of the form (MAJOR-MODE . ALIST), and the
3335 buffer's major mode is derived from MAJOR-MODE (as determined
3336 by `derived-mode-p'), then all the variables in ALIST are
3337 applied. A MAJOR-MODE of nil may be used to match any buffer.
3338 `make-local-variable' is called for each variable before it is
3339 set.
3341 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3342 is an initial substring of the file's directory, then LIST is
3343 applied by recursively following these rules."
3350 "File that contains directory-local variables.
3351 It has to be constant to enforce uniform values
3355 "Find the directory-local variables for FILE.
3356 This searches upward in the directory tree from FILE.
3357 If the directory root of FILE has been registered in
3358 `dir-locals-directory-cache' and the directory-local variables
3359 file has not been modified, return the matching entry in
3360 `dir-locals-directory-cache'.
3361 Otherwise, if a directory-local variables file is found, return
3362 the file name.
3363 Otherwise, return nil."
3368 dir-locals-file))
3371 ;; `locate-dominating-file' may have abbreviated the name.
3374 ;; Find the best cached value in `dir-locals-directory-cache'.
3387 ;; Check the validity of the cache.
3392 ;; This cache entry is OK.
3393 dir-elt
3394 ;; This cache entry is invalid; clear it.
3397 locals-file)
3398 locals-file))))
3401 "Load a variables FILE and register a new class and instance.
3402 FILE is the name of the file holding the variables to apply.
3403 The new class name is the same as the directory in which FILE
3404 is found. Returns the new class name."
3414 class-name)))
3417 "Read per-directory local variables for the current buffer.
3418 Store the directory-local variables in `dir-local-variables-alist'
3419 and `file-local-variables-alist', without applying them."
3423 ;; Find the variables file.
3446 \f
3449 However, the mode will not be changed if
3450 \(1) a local variables list or the `-*-' line specifies a major mode, or
3452 \ not suitable for ordinary files, or
3453 \(3) the new file name does not particularly specify any mode."
3458 "Change name of file visited in current buffer to FILENAME.
3459 This also renames the buffer to correspond to the new file.
3460 The next time the buffer is saved it will go in the newly specified file.
3461 FILENAME nil or an empty string means mark buffer as not visiting any file.
3462 Remember to delete the initial contents of the minibuffer
3463 if you wish to pass an empty string as the argument.
3465 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3466 confirmation in the case where another buffer is already visiting FILENAME.
3468 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3469 the old visited file has been renamed to the new name FILENAME."
3477 nil
3492 filename)))
3502 ;; If new-name == old-name, renaming would add a spurious <2>
3503 ;; and it's considered as a feature in rename-buffer.
3509 ;; Abbreviate the file names of the buffer.
3518 nil)))
3519 ;; write-file-functions is normally used for things like ftp-find-file
3520 ;; that visit things that are not local files as if they were files.
3521 ;; Changing to visit an ordinary local file instead should flush the hook.
3526 ;; If buffer was read-only because of version control,
3527 ;; that reason is gone now, so make it writable.
3531 ;; Turn off backup files for certain file names.
3532 ;; Since this is a permanent local, the major mode won't eliminate it.
3534 backup-enable-predicate
3540 ;; If auto-save was not already on, turn it on if appropriate.
3544 ;; If auto save is on, start using a new name.
3545 ;; We deliberately don't rename or delete the old auto save
3546 ;; for the old visited file name. This is because perhaps
3547 ;; the user wants to save the new state and then compare with the
3548 ;; previous state from the auto save file.
3551 ;; Rename the old auto save file if any.
3558 ;; Update the major mode, if the file name determines it.
3560 ;; Don't change the mode if it is special.
3563 ;; Don't change the mode if the local variable list specifies it.
3569 "Write current buffer into file FILENAME.
3570 This makes the buffer visit that file, and marks it as not modified.
3572 If you specify just a directory name as FILENAME, that means to use
3573 the default file name but in that directory. You can also yank
3574 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3576 If the buffer is not already visiting a file, the default file name
3577 for the output file is the buffer name.
3579 If optional second arg CONFIRM is non-nil, this function
3580 asks for confirmation before overwriting an existing file.
3581 Interactively, confirmation is required unless you supply a prefix argument."
3582 ;; (interactive "FWrite file: ")
3586 nil nil nil nil)
3590 default-directory)
3591 nil nil))
3595 ;; If arg is just a directory,
3596 ;; use the default file name, but in that directory.
3607 ;; Make buffer writable if file is writable.
3612 ;; It's likely that the VC status at the new location is different from
3613 ;; the one at the old location.
3615 \f
3617 "Make a backup of the disk file visited by the current buffer, if appropriate.
3618 This is normally done before saving the buffer the first time.
3620 A backup may be done by renaming or by copying; see documentation of
3621 variable `make-backup-files'. If it's done by renaming, then the file is
3622 no longer accessible under its old name.
3624 The value is non-nil after a backup was made by renaming.
3625 It has the form (MODES . BACKUPNAME).
3626 MODES is the result of `file-modes' on the original
3627 file; this means that the caller, after saving the buffer, should change
3628 the modes of the new file to agree with the old modes.
3629 BACKUPNAME is the backup file name, which is the old file renamed."
3636 backup-info backupname targets setmodes)
3637 ;; If specified name is a symbolic link, chase it to the target.
3638 ;; Thus we make the backups in the directory where the real file is.
3643 ;; (if (file-directory-p buffer-file-name)
3644 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3648 ;; If have old versions to maybe delete,
3649 ;; ask the user to confirm now, before doing anything.
3650 ;; But don't actually delete til later.
3655 real-file-name)))))
3657 ;; Actually write the back up file.
3660 ; (file-symlink-p buffer-file-name)
3661 backup-by-copying
3662 ;; Don't rename a suid or sgid file.
3677 ;; rename-file should delete old backup.
3681 ;; If trouble writing the backup, write it in ~.
3686 backupname)
3690 ;; Now delete the old versions, if desired.
3697 setmodes)
3704 ;; Create temp files with strict access rights. It's easy to
3705 ;; loosen them later, whereas it's impossible to close the
3706 ;; time-window of loose permissions otherwise.
3709 ;; Try to overwrite old backup first.
3717 nil)
3719 ;; The file was somehow created by someone else between
3720 ;; `delete-file' and `copy-file', so let's try again.
3721 ;; rms says "I think there is also a possible race
3722 ;; condition for making backup files" (emacs-devel 20070821).
3723 nil)))
3724 ;; Reset the umask.
3730 "Return file NAME sans backup versions or strings.
3731 This is a separate procedure so your site-init or startup file can
3732 redefine it.
3733 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3734 we do not remove backup version numbers, only true file version numbers."
3746 "Return t if deleting FILE and rewriting it would preserve the owner."
3751 ;; Return t if the file doesn't exist, since it's true that no
3752 ;; information would be lost by an (attempted) delete and create.
3758 The extension, in a file name, is the part that follows the last `.',
3759 except that a leading `.', if any, doesn't count."
3762 directory)
3766 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3767 ;; we don't want to expand it.
3770 filename))))
3774 The extension, in a file name, is the part that follows the last `.',
3775 excluding version numbers and backup suffixes,
3776 except that a leading `.', if any, doesn't count.
3777 Return nil for extensionless file names such as `foo'.
3778 Return the empty string for file names such as `foo.'.
3780 If PERIOD is non-nil, then the returned value includes the period
3781 that delimits the extension, and if FILENAME has no extension,
3792 "A function to use instead of the default `make-backup-file-name'.
3793 A value of nil gives the default `make-backup-file-name' behavior.
3795 This could be buffer-local to do something special for specific
3796 files. If you define it, you may need to change `backup-file-name-p'
3797 and `file-name-sans-versions' too.
3799 See also `backup-directory-alist'."
3805 "Alist of filename patterns and backup directory names.
3806 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3807 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3808 relative or absolute. If it is absolute, so that all matching files
3809 are backed up into the same directory, the file names in this
3810 directory will be the full name of the file backed up with all
3811 directory separators changed to `!' to prevent clashes. This will not
3812 work correctly if your filesystem truncates the resulting name.
3814 For the common case of all backups going into one directory, the alist
3816 directory name.
3818 If this variable is nil, or it fails to match a filename, the backup
3819 is made in the original file's directory.
3821 On MS-DOS filesystems without long names this variable is always
3822 ignored."
3828 "Default `backup-enable-predicate' function.
3829 Checks for files in `temporary-file-directory',
3830 `small-temporary-file-directory', and /tmp."
3833 ;; Directory is under temporary-file-directory.
3838 ;; Directory is under /tmp.
3843 0 nil
3845 ;; Directory is under small-temporary-file-directory.
3850 "Create the non-numeric backup file name for FILE.
3851 Normally this will just be the file's name with `~' appended.
3852 Customization hooks are provided as follows.
3854 If the variable `make-backup-file-name-function' is non-nil, its value
3855 should be a function which will be called with FILE as its argument;
3856 the resulting name is used.
3858 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3859 the documentation of that variable. If the directory for the backup
3860 doesn't exist, it is created."
3874 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3876 elt backup-directory abs-backup-directory)
3881 alist nil)))
3882 ;; If backup-directory is relative, it should be relative to the
3883 ;; file's directory. By expanding explicitly here, we avoid
3884 ;; depending on default-directory.
3893 abs-backup-directory nil))))
3895 file
3899 ;; Normalize DOSish file names: downcase the drive
3900 ;; letter, if any, and replace the leading "x:" with
3901 ;; "/drive_x".
3904 ;; Replace any invalid file-name characters (for the
3905 ;; case of backing up remote files).
3909 "drive_"
3912 ""
3915 ;; Make the name unique by substituting directory
3916 ;; separators. It may not really be worth bothering about
3917 ;; doubling `!'s in the original name...
3922 backup-directory))
3927 "Return non-nil if FILE is a backup file name (numeric or not).
3928 This is a separate function so you can redefine it for customization.
3929 You may need to redefine `file-name-sans-versions' as well."
3934 ;; This is used in various files.
3935 ;; The usage of backup-extract-version-start is not very clean,
3936 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3938 "Given the name of a numeric backup file, FN, return the backup number.
3939 Uses the free variable `backup-extract-version-start', whose value should be
3940 the index in the name where the version number begins."
3947 "Find a file name for a backup file FN, and suggestions for deletions.
3948 Value is a list whose car is the name for the backup file
3949 and whose cdr is a list of old versions to consider deleting now.
3950 If the value is nil, don't make a backup.
3951 Uses `backup-directory-alist' in the same way as does
3952 `make-backup-file-name'."
3954 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3958 ;; We don't support numbered backups on plain MS-DOS
3959 ;; when long file names are unavailable.
3969 possibilities deserve-versions-p versions)
3972 base-versions
3975 possibilities)
3976 #'<)
3981 kept-old-versions
3982 kept-new-versions
3989 ;; Delete nothing if there is overflow
3990 ;; in the number of versions to keep.
3996 v))))))))))
3999 "Return number of names file FILENAME has."
4002 ;; (defun file-relative-name (filename &optional directory)
4003 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4004 ;; This function returns a relative file name which is equivalent to FILENAME
4005 ;; when used with that default directory as the default.
4006 ;; If this is impossible (which can happen on MSDOS and Windows
4007 ;; when the file name and directory use different drive names)
4008 ;; then it returns FILENAME."
4009 ;; (save-match-data
4010 ;; (let ((fname (expand-file-name filename)))
4011 ;; (setq directory (file-name-as-directory
4012 ;; (expand-file-name (or directory default-directory))))
4013 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4014 ;; ;; drive names, they can't be relative, so return the absolute name.
4015 ;; (if (and (or (eq system-type 'ms-dos)
4016 ;; (eq system-type 'cygwin)
4017 ;; (eq system-type 'windows-nt))
4018 ;; (not (string-equal (substring fname 0 2)
4019 ;; (substring directory 0 2))))
4020 ;; filename
4021 ;; (let ((ancestor ".")
4022 ;; (fname-dir (file-name-as-directory fname)))
4023 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4024 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4025 ;; (setq directory (file-name-directory (substring directory 0 -1))
4026 ;; ancestor (if (equal ancestor ".")
4027 ;; ".."
4028 ;; (concat "../" ancestor))))
4029 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4030 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4031 ;; ;; We matched within FNAME's directory part.
4032 ;; ;; Add the rest of FNAME onto ANCESTOR.
4033 ;; (let ((rest (substring fname (match-end 0))))
4034 ;; (if (and (equal ancestor ".")
4035 ;; (not (equal rest "")))
4036 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4037 ;; rest
4038 ;; (concat (file-name-as-directory ancestor) rest)))
4039 ;; ;; We matched FNAME's directory equivalent.
4040 ;; ancestor))))))
4043 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4044 This function returns a relative file name which is equivalent to FILENAME
4045 when used with that default directory as the default.
4046 If FILENAME and DIRECTORY lie on different machines or on different drives
4047 on a DOS/Windows machine, it returns FILENAME in expanded form."
4051 default-directory))))
4057 ;; Test for different drives on DOS/Windows
4059 ;; Should `cygwin' really be included here? --stef
4062 ;; Test for different remote file system identification
4064 filename
4070 directory nil nil case-fold-search))
4072 directory nil nil case-fold-search))))
4075 ".."
4077 ;; Now ancestor is empty, or .., or ../.., etc.
4079 directory nil nil case-fold-search))
4080 ;; We matched within FILENAME's directory part.
4081 ;; Add the rest of FILENAME onto ANCESTOR.
4084 ;; But don't bother with ANCESTOR if it would give us `./'.
4085 rest
4087 ;; We matched FILENAME's directory equivalent.
4088 ancestor))))))
4089 \f
4091 "Save current buffer in visited file if modified.
4092 Variations are described below.
4094 By default, makes the previous version into a backup file
4095 if previously requested or if this is the first save.
4097 to become a backup when the next save is done.
4099 unconditionally makes the previous version into a backup file.
4101 to become a backup when the next save is done,
4102 and unconditionally makes the previous version into a backup file.
4104 With a numeric argument of 0, never make the previous version
4105 into a backup file.
4107 If a file's name is FOO, the names of its numbered backup versions are
4108 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4109 Numeric backups (rather than FOO~) will be made if value of
4110 `version-control' is not the atom `never' and either there are already
4111 numeric versions of the file being backed up, or `version-control' is
4112 non-nil.
4113 We don't want excessive versions piling up, so there are variables
4114 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4115 and `kept-new-versions', which tells how many newest versions to keep.
4116 Defaults are 2 old versions and 2 new.
4117 `dired-kept-versions' controls dired's clean-directory (.) command.
4118 If `delete-old-versions' is nil, system will query user
4119 before trimming versions. Otherwise it does it silently.
4121 If `vc-make-backup-files' is nil, which is the default,
4122 no backup files are made for files managed by version control.
4123 (This is because the version control system itself records previous versions.)
4125 See the subroutine `basic-save-buffer' for more information."
4131 ;; We used to display the message below only for files > 50KB, but
4132 ;; then Rmail-mbox never displays it due to buffer swapping. If
4133 ;; the test is ever re-introduced, be sure to handle saving of
4134 ;; Rmail files.
4141 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4142 Normally delete only if the file was written by this Emacs since
4143 the last real save, but optional arg FORCE non-nil means delete anyway."
4157 "Normal hook that is run before a buffer is saved to its file."
4163 "Normal hook that is run after a buffer is saved to its file."
4169 "If non-nil, use this coding system for saving the buffer.
4170 More precisely, use this coding system in place of the
4171 value of `buffer-file-coding-system', when saving the buffer.
4172 Calling `write-region' for any purpose other than saving the buffer
4173 will still use `buffer-file-coding-system'; this variable has no effect
4180 "Save the current buffer in its visited file, if it has been modified.
4181 The hooks `write-contents-functions' and `write-file-functions' get a chance
4182 to do the job of saving; if they do not, then the buffer is saved in
4183 the visited file in the usual way.
4184 Before and after saving the buffer, this function runs
4185 `before-save-hook' and `after-save-hook', respectively."
4188 ;; In an indirect buffer, save its base buffer instead.
4193 setmodes)
4194 ;; If buffer has no file name, ask user for one.
4201 ;; Signal an error if the user specified the name of an
4202 ;; existing directory.
4205 filename))
4207 ;; Signal an error if the specified name refers to a
4208 ;; non-existing directory.
4238 ;; Support VC version backups.
4244 ;; If a hook returned t, file is already "written".
4245 ;; Otherwise, write it the usual way now.
4247 ;; Now we have saved the current buffer. Let's make sure
4248 ;; that buffer-file-coding-system is fixed to what
4249 ;; actually used for saving by binding it locally.
4259 ;; If the auto-save file was recent before this command,
4260 ;; delete it now.
4262 ;; Support VC `implicit' locking.
4267 ;; This does the "real job" of writing a buffer into its visited file
4268 ;; and making a backup file. This is what is normally done
4269 ;; but inhibited if one of write-file-functions returns non-nil.
4270 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4282 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4296 buffer-file-name)))
4310 ;; Write temp name, then rename it.
4311 ;; This requires write access to the containing dir,
4312 ;; which is why we don't try it if we don't have that access.
4314 tempname succeed
4317 ;; Create temp files with strict access rights. It's easy to
4318 ;; loosen them later, whereas it's impossible to close the
4319 ;; time-window of loose permissions otherwise.
4324 ;; Try various temporary names.
4325 ;; This code follows the example of make-temp-file,
4326 ;; but it calls write-region in the appropriate way
4327 ;; for saving the buffer.
4333 ;; Pass in nil&nil rather than point-min&max
4334 ;; cause we're saving the whole buffer.
4335 ;; write-region-annotate-functions may use it.
4337 tempname nil realname
4339 nil)
4341 ;; The file was somehow created by someone else between
4342 ;; `make-temp-name' and `write-region', let's try again.
4343 nil)
4345 ;; Reset the umask.
4347 ;; If we failed, restore the buffer's modtime.
4350 ;; Since we have created an entirely new file,
4351 ;; make sure it gets the right permission bits set.
4355 buffer-file-name)))
4356 ;; We succeeded in writing the temp file,
4357 ;; so rename it.
4359 ;; If file not writable, see if we can make it writable
4360 ;; temporarily while we write it.
4361 ;; But no need to do so if we have just backed it up
4362 ;; (setmodes is set) because that says we're superseding.
4364 ;; Change the mode back, after writing.
4370 ;; Pass in nil&nil rather than point-min&max to indicate
4371 ;; we're saving the buffer rather than just a region.
4372 ;; write-region-annotate-functions may make us of it.
4374 buffer-file-name nil t buffer-file-truename)
4376 ;; If we get an error writing the new file, and we made
4377 ;; the backup by renaming, undo the backing-up.
4382 setmodes))
4385 "View the differences between BUFFER and its associated file.
4386 This requires the external program `diff' to be in your `exec-path'."
4400 ;; Display that message for 1 second so that user can read it
4401 ;; in the minibuffer.
4403 ;; return always nil, so that save-buffers-kill-emacs will not move
4404 ;; over to the next unsaved buffer when calling `d'.
4405 nil)
4408 `((?\C-r
4415 ;; Return nil to ask about BUF again.
4416 nil)
4428 ;; Return nil to ask about BUF again.
4429 nil)
4439 "Save some modified file-visiting buffers. Asks user about each one.
4440 You can answer `y' to save, `n' not to save, `C-r' to look at the
4441 buffer in question with `view-buffer' before deciding or `d' to
4442 view the differences using `diff-buffer-with-file'.
4444 Optional argument (the prefix) non-nil means save all with no questions.
4445 Optional second argument PRED determines which buffers are considered:
4446 If PRED is nil, all the file-visiting buffers are considered.
4447 If PRED is t, then certain non-file buffers will also be considered.
4448 If PRED is a zero-argument function, it indicates for each buffer whether
4449 to consider it or not when called with that buffer current.
4451 See `save-some-buffers-action-alist' if you want to
4452 change the additional actions you can take on files."
4456 files-done abbrevs-done)
4458 ;; First save any buffers that we're supposed to save unconditionally.
4459 ;; That way the following code won't ask about them.
4464 ;; Ask about those buffers that merit it,
4465 ;; and record the number thus saved.
4469 ;; Note that killing some buffers may kill others via
4470 ;; hooks (e.g. Rmail and its viewing buffer).
4483 t
4495 save-some-buffers-action-alist))
4496 ;; Maybe to save abbrevs, and record whether
4497 ;; we either saved them or asked to.
4503 abbrev-file-name)))
4505 ;; Don't keep bothering user if he says no.
4510 "(Some special files were saved without asking)"
4512 \f
4514 "Mark current buffer as unmodified, not needing to be saved.
4517 It is not a good idea to use this function in Lisp programs, because it
4518 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4525 "Change whether this buffer is read-only.
4526 With prefix argument ARG, make the buffer read-only if ARG is
4527 positive, otherwise make it writable. If buffer is read-only
4528 and `view-read-only' is non-nil, enter view mode."
4533 nil ; do nothing.
4534 ;; Toggle.
4541 ;; If view-mode is already active, `view-mode-enter' is a nop.
4553 "Insert contents of file FILENAME into buffer after point.
4554 Set mark after the inserted text.
4556 This function is meant for the user to run interactively.
4557 Don't call it from programs! Use `insert-file-contents' instead.
4558 \(Its calling sequence is different; see its documentation)."
4563 "Append the contents of the region to the end of file FILENAME.
4564 When called from a function, expects three arguments,
4565 START, END and FILENAME. START and END are normally buffer positions
4566 specifying the part of the buffer to write.
4567 If START is nil, that means to use the entire buffer contents.
4568 If START is a string, then output that string to the file
4569 instead of any buffer contents; END is ignored.
4571 This does character code conversion and applies annotations
4572 like `write-region' does."
4577 "Return most recent backup file for FILENAME or nil if no backups exist."
4578 ;; `make-backup-file-name' will get us the right directory for
4579 ;; ordinary or numeric backups. It might create a directory for
4580 ;; backups as a side-effect, according to `backup-directory-alist'.
4587 tem)
4596 newest))
4599 "Rename current buffer to a similar name not already taken.
4600 This function is useful for creating multiple shell process buffers
4601 or multiple mail buffers, etc."
4609 ;; If the existing buffer name has a <NNN>,
4610 ;; which isn't part of the file name (if any),
4611 ;; then get rid of that.
4617 "Create the directory DIR and any nonexistent parent dirs.
4618 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4620 Interactively, the default choice of directory to create
4621 is the current default directory for file names.
4622 That is useful when you have visited a file in a nonexistent directory.
4624 Noninteractively, the second (optional) argument PARENTS says whether
4625 to create parent directories if they don't exist. Interactively,
4626 this happens by default."
4629 nil nil)
4630 t))
4631 ;; If default-directory is a remote directory,
4632 ;; make sure we find its make-directory handler.
4640 create-list)
4642 ;; If directory is its own parent, then we can't
4643 ;; keep looping forever
4658 "Delete the directory named DIRECTORY. Does not follow symlinks.
4659 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well."
4663 "Delete directory: "
4664 default-directory default-directory nil nil))))
4669 nil))))
4670 ;; If default-directory is a remote directory, make sure we find its
4671 ;; delete-directory handler.
4678 ;; Only move non-empty dir to trash if recursive deletion was
4679 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4680 ;; case, where the operation fails in delete-directory-internal.
4681 ;; As `move-file-to-trash' trashes directories (empty or
4682 ;; otherwise) as a unit, we do not need to recurse here.
4684 ;; Check if directory is empty apart from "." and "..".
4689 ;; Otherwise, call outselves recursively if needed.
4693 ;; This test is equivalent to
4694 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4695 ;; but more efficient
4699 ;; We do not want to delete "." and "..".
4705 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4706 If NEWNAME names an existing directory, copy DIRECTORY as subdirectory there.
4708 This function always sets the file modes of the output files to match
4709 the corresponding input file.
4711 The third arg KEEP-TIME non-nil means give the output files the same
4712 last-modified time as the old ones. (This works on only some systems.)
4714 A prefix arg makes KEEP-TIME non-nil.
4716 Noninteractively, the last argument PARENTS says whether to
4717 create parent directories if they don't exist. Interactively,
4718 this happens by default."
4725 default-directory default-directory nil nil)
4726 current-prefix-arg t)))
4727 ;; If default-directory is a remote directory, make sure we find its
4728 ;; copy-directory handler.
4734 ;; Compute target name.
4739 ;; Copy recursively.
4751 ;; We do not want to copy "." and "..".
4754 ;; Set directory attributes.
4758 \f
4761 "Function to use to revert this buffer, or nil to do the default.
4762 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4767 "Function to use to insert contents when reverting this buffer.
4768 Gets two args, first the nominal file name to use,
4769 and second, t if reading the auto-save file.
4774 "Function to check whether a non-file buffer needs reverting.
4775 This should be a function with one optional argument NOCONFIRM.
4776 Auto Revert Mode passes t for NOCONFIRM. The function should return
4777 non-nil if the buffer should be reverted. A return value of
4778 `fast' means that the need for reverting was not checked, but
4779 that reverting the buffer is fast. The buffer is current when
4780 this function is called.
4782 The idea behind the NOCONFIRM argument is that it should be
4783 non-nil if the buffer is going to be reverted without asking the
4784 user. In such situations, one has to be careful with potentially
4785 time consuming operations.
4787 For more information on how this variable is used by Auto Revert mode,
4791 "Normal hook for `revert-buffer' to run before reverting.
4792 If `revert-buffer-function' is used to override the normal revert
4796 "Normal hook for `revert-buffer' to run after reverting.
4797 Note that the hook value that it runs is the value that was in effect
4798 before reverting; that makes a difference if you have buffer-local
4799 hook functions.
4801 If `revert-buffer-function' is used to override the normal revert
4807 "Replace current buffer text with the text of the visited file on disk.
4808 This undoes all changes since the file was visited or saved.
4809 With a prefix argument, offer to revert from latest auto-save file, if
4810 that is more recent than the visited file.
4812 This command also implements an interface for special buffers
4813 that contain text which doesn't come from a file, but reflects
4814 some other data instead (e.g. Dired buffers, `buffer-list'
4815 buffers). This is done via the variable `revert-buffer-function'.
4816 In these cases, it should reconstruct the buffer contents from the
4817 appropriate data.
4819 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4820 to revert from the auto-save file when this is nil. Note that the
4821 sense of this argument is the reverse of the prefix argument, for the
4822 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4823 to nil.
4825 Optional second argument NOCONFIRM means don't ask for confirmation
4826 at all. \(The variable `revert-without-query' offers another way to
4827 revert buffers without querying for confirmation.)
4829 Optional third argument PRESERVE-MODES non-nil means don't alter
4830 the files modes. Normally we reinitialize them using `normal-mode'.
4832 If the value of `revert-buffer-function' is non-nil, it is called to
4833 do all the work for this command. Otherwise, the hooks
4834 `before-revert-hook' and `after-revert-hook' are run at the beginning
4835 and the end, and if `revert-buffer-insert-file-contents-function' is
4836 non-nil, it is called instead of rereading visited file contents."
4838 ;; I admit it's odd to reverse the sense of the prefix argument, but
4839 ;; there is a lot of code out there which assumes that the first
4840 ;; argument should be t to avoid consulting the auto-save file, and
4841 ;; there's no straightforward way to encourage authors to notice a
4842 ;; reversal of the argument sense. So I'm just changing the user
4843 ;; interface, but leaving the programmatic interface the same.
4851 buffer-auto-save-file-name
4856 buffer-auto-save-file-name
4857 buffer-file-name)))
4867 file-name)))
4869 ;; If file was backed up but has changed since,
4870 ;; we should make another backup.
4874 ;; Effectively copy the after-revert-hook status,
4875 ;; since after-find-file will clobber it.
4878 after-revert-hook))
4883 ;; Get rid of all undo records for this buffer.
4885 ;; Don't make undo records for the reversion.
4888 file-name auto-save-p)))
4891 "File %s no longer exists!"
4893 file-name))
4896 "File %s no longer readable!"
4898 file-name))
4900 ;; Bind buffer-file-name to nil
4901 ;; so that we don't try to lock the file.
4907 ;; Auto-saved file should be read by Emacs'
4908 ;; internal coding.
4912 buffer-file-coding-system-explicit
4915 coding-system-for-read
4917 coding-system-for-read)
4919 ;; As a coding system suitable for multibyte
4920 ;; buffer is specified, make the current
4921 ;; buffer multibyte.
4924 ;; This force after-insert-file-set-coding
4925 ;; (called from insert-file-contents) to set
4926 ;; buffer-file-coding-system to a proper value.
4929 ;; Note that this preserves point in an intelligent way.
4933 nil nil t))
4935 nil nil t)))))
4936 ;; Recompute the truename in case changes in symlinks
4937 ;; have changed the truename.
4941 ;; Run after-revert-hook as it was before we reverted.
4945 local-hook)
4948 t))))))
4951 "Recover the visited file--get contents from its last auto-save file."
4956 "Visit file FILE, but get contents from its last auto-save file."
4957 ;; Actually putting the file name in the minibuffer should be used
4958 ;; only rarely.
4959 ;; Not just because users often use the default.
4979 ;; Use insert-directory-safely, not insert-directory,
4980 ;; because these files might not exist. In particular,
4981 ;; FILE might not exist if the auto-save file was for
4982 ;; a buffer that didn't visit a file, such as "*mail*".
4983 ;; The code in v20.x called `ls' directly, so we need
4984 ;; to emulate what `ls' did in that case.
4990 ;; Keep the current buffer-file-coding-system.
4992 ;; Auto-saved file should be read with special coding.
5001 "Recover auto save files from a previous Emacs session.
5002 This command first displays a Dired buffer showing you the
5003 previous sessions that you could recover from.
5004 To choose one, move point to the proper line and then type C-c C-c.
5005 Then you'll be asked about a number of files to recover."
5015 auto-save-list-file-prefix)))
5016 t)
5025 ;; Each line starts with a space
5026 ;; so that Font Lock mode won't highlight the first character.
5035 "Choose one saved session to recover auto-save files from.
5036 This command is used in the special Dired buffer created by
5039 ;; Get the name of the session file to recover from.
5041 files
5047 ;; Read in the auto-save-list file.
5050 ;; Loop thru the text of that file
5051 ;; and get out the names of the files to recover.
5055 ;; This is a pair of lines for a non-file-visiting buffer.
5056 ;; Get the auto-save file name and manufacture
5057 ;; a "visited file name" from that.
5060 ;; If there is no auto-save file name, the
5061 ;; auto-save-list file is probably corrupted.
5074 ;; This pair of lines is a file-visiting
5075 ;; buffer. Use the visited file name.
5085 ;; Ignore a file if its auto-save file does not exist now.
5089 ;; The file contains a pair of line for each auto-saved buffer.
5090 ;; The first line of the pair contains the visited file name
5091 ;; or is empty if the buffer was not visiting a file.
5092 ;; The second line is the auto-save file name.
5100 files
5106 "Kill BUFFER if confirmed."
5114 "Kill some buffers. Asks the user whether to kill each one of them.
5115 Non-interactively, if optional argument LIST is non-nil, it
5116 specifies the list of buffers to kill, asking for approval for each one."
5124 ; if we killed the base buffer.
5131 "Kill buffers whose name matches the specified REGEXP.
5132 The optional second argument indicates whether to kill internal buffers too."
5141 \f
5143 "Toggle auto-saving of contents of current buffer.
5144 With prefix argument ARG, turn auto-saving on if positive, else off."
5149 ;; If auto-save is off because buffer has shrunk,
5150 ;; then toggling should turn it on.
5155 buffer-file-name
5157 ;; If -1 was stored here, to temporarily turn off saving,
5158 ;; turn it back on.
5164 buffer-auto-save-file-name)
5167 "Adjust current buffer's auto save file name for current conditions.
5168 Also rename any existing auto save file, if it was made in this session."
5180 "Return file name to use for auto-saves of current buffer.
5181 Does not consider `auto-save-visited-file-name' as that variable is checked
5182 before calling this function. You can redefine this for customization.
5183 See also `auto-save-file-name-p'."
5191 result uniq)
5192 ;; Apply user-specified translations
5193 ;; to the file name.
5197 filename)
5207 filename))))
5212 ;; We truncate the file name to DOS 8+3 limits
5213 ;; before doing anything else, because the regexp
5214 ;; passed to string-match below cannot handle
5215 ;; extensions longer than 3 characters, multiple
5216 ;; dots, and other atrocities.
5221 fn)
5226 "#"
5229 ;; Make sure auto-save file names don't contain characters
5230 ;; invalid for the underlying filesystem.
5232 ;; Don't modify remote (ange-ftp) filenames
5235 result))))
5237 ;; Deal with buffers that don't have any associated files. (Mail
5238 ;; mode tends to create a good number of these.)
5242 file-name)
5243 ;; Restrict the characters used in the file name to those which
5244 ;; are known to be safe on all filesystems, url-encoding the
5245 ;; rest.
5246 ;; We do this on all platforms, because even if we are not
5247 ;; running on DOS/Windows, the current directory may be on a
5248 ;; mounted VFAT filesystem, such as a USB memory stick.
5252 ;; For multibyte characters, this will produce more than
5253 ;; 2 hex digits, so is not true URL encoding.
5257 ;; Generate the file name.
5263 ;; Try a few alternative directories, to get one we can
5264 ;; write it.
5270 ;; Don't modify remote (ange-ftp) filenames
5272 ;; The call to convert-standard-filename is in case
5273 ;; buffer-name includes characters not allowed by the
5274 ;; DOS/Windows filesystems. make-temp-file writes to the
5275 ;; file it creates, so we must fix the file name _before_
5276 ;; make-temp-file is called.
5278 fname))
5280 ;; make-temp-file creates the file,
5281 ;; but we don't want it to exist until we do an auto-save.
5285 file-name)))
5288 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5289 FILENAME should lack slashes. You can redefine this for customization."
5291 \f
5293 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5294 The generated regexp will match a filename only if the filename
5295 matches that wildcard according to shell rules. Only wildcards known
5296 by `sh' are supported."
5298 ;; Copy the initial run of non-special characters.
5301 ;; If no special characters, we're almost done.
5305 j)
5307 result
5328 ;; Found "[^". Insert a `\0' character
5329 ;; (which cannot happen in a filename)
5330 ;; into the character class, so that `^'
5331 ;; is not the first character after `[',
5332 ;; and thus non-special in a regexp.
5337 ;; I don't think `]' can appear in a
5338 ;; character class in a wildcard, but
5339 ;; let's be general here.
5346 i
5359 ;; Shell wildcards should match the entire filename,
5360 ;; not its part. Make the regexp say so.
5362 \f
5365 "Switches for `list-directory' to pass to `ls' for brief listing."
5371 "Switches for `list-directory' to pass to `ls' for verbose listing."
5376 "Expand wildcard pattern PATTERN.
5377 This returns a list of file names which match the pattern.
5379 If PATTERN is written as an absolute file name,
5380 the values are absolute also.
5382 If PATTERN is written as a relative file name, it is interpreted
5383 relative to the current default directory, `default-directory'.
5384 The file names returned are normally also relative to the current
5385 default directory. However, if FULL is non-nil, they are absolute."
5389 ;; A list of all dirs that DIRPART specifies.
5390 ;; This can be more than one dir
5391 ;; if DIRPART contains wildcards.
5395 dirpart)))
5399 contents)
5404 ;; Filter out "." and ".."
5409 name))
5416 this-dir-contents)
5417 this-dir-contents)
5418 contents))))
5420 contents)))
5422 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5426 "Display a list of files in or matching DIRNAME, a la `ls'.
5427 DIRNAME is globbed by the shell if necessary.
5428 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5429 Actions controlled by variables `list-directory-brief-switches'
5430 and `list-directory-verbose-switches'."
5434 nil default-directory nil)
5435 pfx)))
5437 list-directory-brief-switches))
5438 buffer)
5450 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5458 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5460 PATTERN is assumed to represent a file-name wildcard suitable for the
5461 underlying filesystem. For Unix and GNU/Linux, each character from the
5463 the parts of the pattern which don't include wildcard characters are
5464 quoted with double quotes.
5467 on Windows), so PATTERN can use them to quote wildcard characters that
5468 need to be passed verbatim to shell commands."
5472 ;; DOS/Windows don't allow `"' in file names. So if the
5473 ;; argument has quotes, we can safely assume it is already
5474 ;; quoted by the caller.
5476 ;; We quote [&()#$'] in case their shell is a port of a
5477 ;; Unixy shell. We quote [,=+] because stock DOS and
5478 ;; Windows shells require that in some cases, such as
5479 ;; passing arguments to batch files that use positional
5480 ;; arguments like %1.
5482 pattern
5485 end)
5502 pattern))))
5509 "Program to get the amount of free space on a file system.
5510 We assume the output has the format of `df'.
5511 The value of this variable must be just a command name or file name;
5512 if you want to specify options, use `directory-free-space-args'.
5514 A value of nil disables this feature.
5516 If the function `file-system-info' is defined, it is always used in
5517 preference to the program given by this variable."
5523 "Options to use when running `directory-free-space-program'."
5528 "Return the amount of free space on directory DIR's file system.
5529 The result is a string that gives the number of free 1KB blocks,
5530 or nil if the system call or the program which retrieve the information
5531 fail. It returns also nil when DIR is a remote directory.
5533 This function calls `file-system-info' if it is available, or invokes the
5534 program specified by `directory-free-space-program' if that is non-nil."
5536 ;; Try to find the number of free blocks. Non-Posix systems don't
5537 ;; always have df, but might have an equivalent system call.
5546 ;; Avoid failure if the default directory does
5547 ;; not exist (Bug#2631, Bug#3911).
5550 nil t nil
5551 directory-free-space-args
5552 dir)
5554 ;; Usual format is a header line followed by a line of
5555 ;; numbers.
5560 ;; Move to the end of the "available blocks" number.
5563 ;; Copy it into AVAILABLE.
5568 ;; The following expression replaces `dired-move-to-filename-regexp'.
5572 ;; In some locales, month abbreviations are as short as 2 letters,
5573 ;; and they can be followed by ".".
5574 ;; In Breton, a month name can include a quote character.
5587 s "+"
5590 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5591 ;; omits the Kanji characters after month and day-of-month.
5592 ;; On Mac OS X 10.3, the date format in East Asian locales is
5593 ;; day-of-month digits followed by month digits.
5599 ;; The "[0-9]" below requires the previous column to end in a digit.
5600 ;; This avoids recognizing `1 may 1997' as a date in the line:
5601 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5603 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5605 ;; For non-iso date formats, we add the ".*" in order to find
5606 ;; the last possible match. This avoids recognizing
5607 ;; `jservice 10 1024' as a date in the line:
5608 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5610 ;; vc dired listings provide the state or blanks between file
5611 ;; permissions and date. The state is always surrounded by
5612 ;; parantheses:
5613 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5614 ;; This is not supported yet.
5619 "Regular expression to match up to the file name in a directory listing.
5620 The default value is designed to recognize dates and times
5625 ;; insert-directory
5626 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5627 ;; FULL-DIRECTORY-P is nil.
5628 ;; The single line of output must display FILE's name as it was
5629 ;; given, namely, an absolute path name.
5630 ;; - must insert exactly one line for each file if WILDCARD or
5631 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5632 ;; before the file lines, plus optional text after the file lines.
5633 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5634 ;; allowed.
5635 ;; File lines should display the basename.
5636 ;; - must be consistent with
5637 ;; - functions dired-move-to-filename, (these two define what a file line is)
5638 ;; dired-move-to-end-of-filename,
5639 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5640 ;; dired-insert-headerline
5641 ;; dired-after-subdir-garbage (defines what a "total" line is)
5642 ;; - variable dired-subdir-regexp
5643 ;; - may be passed "--dired" as the first argument in SWITCHES.
5644 ;; Filename handlers might have to remove this switch if their
5645 ;; "ls" command does not support it.
5647 "Insert directory listing for FILE, formatted according to SWITCHES.
5648 Leaves point after the inserted text.
5649 SWITCHES may be a string of options, or a list of strings
5650 representing individual options.
5651 Optional third arg WILDCARD means treat FILE as shell wildcard.
5652 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5653 switches do not contain `d', so that a full listing is expected.
5655 This works by running a directory listing program
5656 whose name is in the variable `insert-directory-program'.
5657 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5659 When SWITCHES contains the long `--dired' option, this function
5660 treats it specially, for the sake of dired. However, the
5661 normally equivalent short `-D' option is just passed on to
5662 `insert-directory-program', as any other option."
5663 ;; We need the directory in order to find the right handler.
5668 wildcard full-directory-p)
5671 ;; Read the actual directory using `insert-directory-program'.
5672 ;; RESULT gets the status code.
5674 ;; putting text property `dired-filename, decode one
5675 ;; bunch by one to preserve that property.
5677 ;; This is to control encoding the arguments in call-process.
5681 default-file-name-coding-system))))
5684 ;; Run ls in the directory part of the file pattern
5685 ;; using the last component as argument.
5692 shell-file-name nil t nil
5693 "-c"
5695 ""
5697 insert-directory-program
5698 " -d "
5700 switches
5702 " -- "
5703 ;; Quote some characters that have
5704 ;; special meanings in shells; but
5705 ;; don't quote the wildcards--we want
5706 ;; them to be special. We also
5707 ;; currently don't quote the quoting
5708 ;; characters in case people want to
5709 ;; use them explicitly to quote
5710 ;; wildcard characters.
5712 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5713 ;; directory if FILE is a symbolic link.
5720 insert-directory-program nil t nil
5724 ;; Split the switches at any spaces so we can
5725 ;; pass separate options as separate args.
5727 ;; Avoid lossage if FILE starts with `-'.
5735 file))))))))
5737 ;; If we got "//DIRED//" in the output, it means we got a real
5738 ;; directory listing, even if `ls' returned nonzero.
5739 ;; So ignore any errors.
5752 ;; The first time ls returns an error,
5753 ;; find the version numbers of ls,
5754 ;; and set insert-directory-ls-version
5755 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5756 ;; is equal or if the info cannot be obtained.
5757 ;; (That can mean it isn't GNU ls.)
5767 comparison)
5783 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5787 ;; If `insert-directory-program' failed, signal an error.
5789 ;; Delete the error message it may have output.
5791 ;; On non-Posix systems, we cannot open a directory, so
5792 ;; don't even try, because that will always result in
5793 ;; the ubiquitous "Access denied". Instead, show the
5794 ;; command line so the user can try to guess what went wrong.
5799 insert-directory-program
5801 file result)
5802 ;; Unix. Access the file to get a suitable error.
5809 ;; The following overshoots by one line for an empty
5810 ;; directory listed with "--dired", but without "-a"
5811 ;; switch, where the ls output contains a
5812 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5813 ;; We take care of that case later.
5821 error-lines)
5822 ;; Find all the lines that are error messages,
5823 ;; and record the bounds of each one.
5830 ;; Now read the numeric positions of file names.
5837 error-lines))
5840 error-lines)))
5842 ;; End is followed by \n or by " -> ".
5844 ;; It seems that we can't trust ls's output as to
5845 ;; byte positions of filenames.
5851 ;; Take care of the case where the ls output contains a
5852 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5853 ;; and we went one line too far back (see above).
5858 ;; Now decode what read if necessary.
5860 file-name-coding-system
5861 default-file-name-coding-system
5863 coding-no-eol
5864 val pos)
5868 ;; If no coding system is specified or detection is
5869 ;; requested, detect the coding.
5883 ;; Force no eol conversion on a file name, so
5884 ;; that CR is preserved.
5892 ;; Try to insert the amount of free space.
5895 ;; First find the line to put it on.
5899 ;; Replace "total" with "used", to avoid confusion.
5905 "Convert `ls --dired' file name position value POS to a buffer position.
5906 File name position values returned in ls --dired output
5907 count only stdout; they don't count the error messages sent to stderr.
5908 So this function converts to them to real buffer positions.
5909 ERROR-LINES is a list of buffer positions of error message lines,
5910 of the form (START END)."
5914 pos)
5918 "Insert directory listing for FILE, formatted according to SWITCHES.
5920 Like `insert-directory', but if FILE does not exist, it inserts a
5921 message to that effect instead of signaling an error."
5924 ;; Simulate the message printed by `ls'.
5928 "Functions to call with no arguments to query about killing Emacs.
5929 If any of these functions returns nil, killing Emacs is cancelled.
5930 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5934 "How to ask for confirmation when leaving Emacs.
5935 If nil, the default, don't ask at all. If the value is non-nil, it should
5936 be a predicate function such as `yes-or-no-p'."
5944 "Offer to save each buffer, then kill this Emacs process.
5945 With prefix ARG, silently save all file-visiting buffers, then kill."
5954 ;; process-list is not defined on MSDOS.
5956 active)
5965 ;; Query the user for other things, perhaps.
5972 "Offer to save each buffer, then kill the current connection.
5973 If the current frame has no client, kill Emacs itself.
5975 With prefix ARG, silently save all file-visiting buffers, then kill.
5977 If emacsclient was started with a list of filenames to edit, then
5978 only these files will be asked to be saved."
5983 \f
5984 ;; We use /: as a prefix to "quote" a file name
5985 ;; so that magic file name handlers will not apply to it.
5989 file-name-handler-alist))
5991 ;; We depend on being the last handler on the list,
5992 ;; so that anything else which does need handling
5993 ;; has been handled already.
5994 ;; So it is safe for us to inhibit *all* magic file name handlers.
6003 default-directory))
6004 ;; Get a list of the indices of the args which are file names.
6007 ;; The first six are special because they
6008 ;; return a file name. We want to include the /:
6009 ;; in the return value.
6010 ;; So just avoid stripping it in the first place.
6017 ;; `identity' means just return the first arg
6018 ;; not stripped of its quoting.
6020 ;; `add' means add "/:" to the result.
6022 ;; `quote' means add "/:" to buffer-file-name.
6024 ;; `unquote-then-quote' means set buffer-file-name
6025 ;; temporarily to unquoted filename.
6027 ;; List the arguments which are filenames.
6035 ;; For all other operations, treat the first argument only
6036 ;; as the file name.
6038 method
6039 ;; Copy ARGUMENTS so we can replace elements in it.
6043 ;; Strip off the /: from the file names that have it.
6051 "/"
6067 res))
6070 \f
6071 ;; Symbolic modes and read-file-modes.
6074 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6075 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6076 Others, or All) for whom to produce the mask.
6077 The bit-mask that is returned extracts from mode bits the access rights
6078 for the specified category of users."
6086 "Convert CHAR to a numeric value of mode bits.
6087 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6088 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6095 ;; Rights relative to the previous file modes.
6106 "Convert a symbolic mode string specification to an equivalent number.
6108 WHO-MASK is the bit-mask specifying the category of users to which to
6109 apply the access permissions. See `file-modes-char-to-who'.
6110 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6111 RIGHTS request to add, remove, or set permissions based on existing ones,
6118 char-right)
6125 num-rights
6129 op char-right)))
6130 num-rights))
6133 "Convert symbolic file modes to numeric file modes.
6134 MODES is the string to convert, it should match
6137 notation.
6138 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6139 MODES request to add, remove, or set permissions based on existing ones,
6153 num-who num-modes)
6156 num-modes)))
6159 "Read file modes in octal or symbolic notation and return its numeric value.
6160 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6161 ORIG-FILE is the name of a file on whose mode bits to base returned
6162 permissions if what user types requests to add, remove, or set permissions
6178 nil nil default)))
6184 \f
6185 ;; Trashcan handling.
6187 "Directory for `move-file-to-trash' to move files and directories to.
6188 This directory is only used when the function `system-move-file-to-trash'
6189 is not defined.
6190 Relative paths are interpreted relative to `default-directory'.
6191 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6201 "Move the file (or directory) named FILENAME to the trash.
6202 When `delete-by-moving-to-trash' is non-nil, this function is
6203 called by `delete-file' and `delete-directory' instead of
6204 deleting files outright.
6206 If the function `system-move-file-to-trash' is defined, call it
6207 with FILENAME as an argument.
6208 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6209 directory.
6210 Otherwise, trash FILENAME using the freedesktop.org conventions,
6211 like the GNOME, KDE and XFCE desktop environments. Emacs only
6215 ;; If `trash-directory' is non-nil, move the file there.
6219 trash-dir)))
6220 ;; We can't trash a parent directory of trash-directory.
6223 trash-dir filename))
6226 ;; Ensure that the trashed file-name is unique.
6233 ;; If `system-move-file-to-trash' is defined, use it.
6236 ;; Otherwise, use the freedesktop.org method, as specified at
6237 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6248 ;; Check if we have permissions to delete.
6252 ;; The trashed file cannot be the trash dir or its parent.
6255 trash-files-dir filename))
6258 trash-info-dir filename))
6260 ;; Ensure that the trash directory exists; otherwise, create it.
6269 ;; Try to move to trash with .trashinfo undo information
6274 ;; Perform url-encoding on FN. For compatibility with
6275 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6276 ;; for path separators.
6281 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6282 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6295 fn))
6300 ;; Attempt to make .trashinfo file, trying up to 5
6301 ;; times. The .trashinfo file is opened with O_EXCL,
6302 ;; as per trash-spec 0.7, even if that can be a problem
6303 ;; on old NFS versions...
6307 trash-files-dir))
6309 success info-fn)
6314 trash-info-dir))
6322 ;; Uniqify new-fn. (Some file managers do not
6323 ;; like Emacs-style backup file names---e.g. bug
6324 ;; 170956 in Konqueror bug tracker.)
6329 ;; Finally, try to move the file to the trashcan.
6333 \f
6358 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6359 ;;; files.el ends here