| blob | bb49f44fda52f853925ebe7b2bb77c8681223a45 |
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, 2006,
5 ;; 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
7 ;; Maintainer: FSF
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Defines most of Emacs's file- and directory-handling functions,
28 ;; including basic file visiting, backup generation, link handling,
29 ;; ITS-id version control, load- and write-hook handling, and the like.
31 ;;; Code:
38 "Backups of edited data files."
42 "Finding files."
47 "Non-nil means delete auto-save file when a buffer is saved or killed.
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
55 nil
56 "Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 FROM with TO when it appears in a directory name. This replacement is
59 done when setting up the default directory of a newly visited file.
62 FROM and TO should be equivalent names, which refer to the
63 same directory. Do not use `~' in the TO strings;
64 they should be ordinary absolute directory names.
66 Use this feature when you have directories which you normally refer to
67 via absolute symbolic links. Make TO the name of the link, and FROM
68 the name it is linked to."
77 "Non-nil means make a backup of a file the first time it is saved.
78 This can be done by renaming the file or by copying.
80 Renaming means that Emacs renames the existing file so that it is a
81 backup file, then writes the buffer into a new file. Any other names
82 that the old file had will now refer to the backup file. The new file
83 is owned by you and its group is defaulted.
85 Copying means that Emacs copies the existing file into the backup
86 file, then writes the buffer on top of the existing file. Any other
87 names that the old file had will now refer to the new (edited) file.
88 The file's owner and group are unchanged.
90 The choice of renaming or copying is controlled by the variables
91 `backup-by-copying', `backup-by-copying-when-linked',
92 `backup-by-copying-when-mismatch' and
93 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
97 ;; Do this so that local variables based on the file name
98 ;; are not overridden by the major mode.
100 "Non-nil means don't make a backup, regardless of the other parameters.
101 This variable is intended for use by making it local to a buffer.
106 "Non-nil means always use copying to create backup files.
107 See documentation of variable `make-backup-files'."
112 "Non-nil means use copying to create backups for files with multiple names.
113 This causes the alternate names to refer to the latest version as edited.
114 This variable is relevant only if `backup-by-copying' is nil."
119 "Non-nil means create backups by copying if this preserves owner or group.
120 Renaming may still be used (subject to control of other variables)
121 when it would not result in changing the owner or group of the file;
122 that is, for files which are owned by you and whose group matches
123 the default for a new file created there by you.
124 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.
193 ;; FIXME ? Should there be Ftemporary_file_directory to do the
194 ;; following more robustly (cf set_local_socket in emacsclient.c).
195 ;; It could be used elsewhere, eg Fcall_process_region, server-socket-dir.
196 ;; See bug#7135.
205 ;; This handles "getconf: Unrecognized variable..."
207 tmp))
211 "The directory for writing temporary files."
213 ;; Darwin section added 24.1, does not seem worth :version bump.
219 "The directory for writing small temporary files.
220 If non-nil, this directory is used instead of `temporary-file-directory'
221 by programs that create small temporary files. This is for systems that
222 have fast storage with limited space, such as a RAM disk."
227 ;; The system null device. (Should reference NULL_DEVICE from C.)
255 "Non-nil means protect against I/O errors while saving files.
256 Some modes set this non-nil in particular buffers.
258 This feature works by writing the new contents into a temporary file
259 and then renaming the temporary file to replace the original.
260 In this way, any I/O error in writing leaves the original untouched,
261 and there is never any instant where the file is nonexistent.
263 Note that this feature forces backups to be made by copying.
264 Yet, at the same time, saving a precious file
265 breaks any hard links between it and other files.
267 This feature is advisory: for example, if the directory in which the
268 file is being saved is not writable, Emacs may ignore a non-nil value
269 of `file-precious-flag' and write directly into the file.
271 See also: `break-hardlink-on-save'."
276 "Non-nil means when saving a file that exists under several names
277 \(i.e., has multiple hardlinks), break the hardlink associated with
278 `buffer-file-name' and write to a new file, so that the other
279 instances of the file are not affected by the save.
281 If `buffer-file-name' refers to a symlink, do not break the symlink.
283 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
284 For example, if the directory in which a file is being saved is not
285 itself writable, then error instead of saving in some
286 hardlink-nonbreaking way.
288 See also `backup-by-copying' and `backup-by-copying-when-linked'."
294 "Control use of version numbers for backup files.
295 When t, make numeric backup versions unconditionally.
296 When nil, make them for files that have some already.
297 The value `never' means do not make them."
307 "When cleaning directory, number of versions to keep."
313 "If t, delete excess backup versions silently.
314 If nil, ask confirmation. Any other value prevents any trimming."
321 "Number of oldest versions to keep when a new numbered backup is made."
327 "Number of newest versions to keep when a new numbered backup is made.
328 Includes the new backup. Must be > 0"
334 "Whether to add a newline automatically at the end of the file.
336 A value of t means do this only when the file is about to be saved.
337 A value of `visit' means do this right after the file is visited.
338 A value of `visit-save' means do it at both of those times.
339 Any other non-nil value means ask user whether to add a newline, when saving.
340 A value of nil means don't add newlines.
342 Certain major modes set this locally to the value obtained
343 from `mode-require-final-newline'."
352 "Whether to add a newline at end of file, in certain major modes.
353 Those modes set `require-final-newline' to this value when you enable them.
354 They do so because they are often used for files that are supposed
355 to end in newlines, and the question is how to arrange that.
357 A value of t means do this only when the file is about to be saved.
358 A value of `visit' means do this right after the file is visited.
359 A value of `visit-save' means do it at both of those times.
360 Any other non-nil value means ask user whether to add a newline, when saving.
362 A value of nil means do not add newlines. That is a risky choice in this
363 variable since this value is used for modes for files that ought to have
364 final newlines. So if you set this to nil, you must explicitly check and
365 add a final newline, whenever you save a file that really needs one."
375 "Non-nil says by default do auto-saving of every file-visiting buffer."
381 ;; Don't put "\\2" inside expand-file-name, since it will be
382 ;; transformed to "/2" on DOS/Windows.
384 "Transforms to apply to buffer file name before making auto-save file name.
385 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
386 REGEXP is a regular expression to match against the file name.
387 If it matches, `replace-match' is used to replace the
388 matching part with REPLACEMENT.
389 If the optional element UNIQUIFY is non-nil, the auto-save file name is
390 constructed by taking the directory part of the replaced file-name,
391 concatenated with the buffer file name with all directory separators
392 changed to `!' to prevent clashes. This will not work
393 correctly if your filesystem truncates the resulting name.
395 All the transforms in the list are tried, in the order they are listed.
396 When one transform applies, its result is final;
397 no further transforms are tried.
399 The default value is set up to put the auto-save file into the
400 temporary directory (see the variable `temporary-file-directory') for
401 editing a remote file.
403 On MS-DOS filesystems without long names this variable is always
404 ignored."
412 "Non-nil means save word abbrevs too when files are saved.
413 If `silently', don't ask the user before saving."
418 "Non-nil means allow `find-file' to visit directories.
419 To visit the directory, `find-file' runs `find-directory-functions'."
424 "List of functions to try in sequence to visit a directory.
425 Each function is called with the directory name as the sole argument
426 and should return either a buffer or nil."
430 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
432 "List of functions to try in sequence to get a file name at point.
433 Each function should return either nil or a file name found at the
434 location of point in the current buffer."
438 ;;;It is not useful to make this a local variable.
439 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
441 "List of functions to be called for `find-file' on nonexistent file.
442 These functions are called as soon as the error is detected.
443 Variable `buffer-file-name' is already set up.
448 ;;;It is not useful to make this a local variable.
449 ;;;(put 'find-file-hooks 'permanent-local t)
452 "List of functions to be called after a buffer is loaded from a file.
453 The buffer's local variables (if any) will have been processed before the
454 functions are called."
461 "List of functions to be called before writing out a buffer to a file.
462 If one of them returns non-nil, the file is considered already written
463 and the rest are not called.
464 These hooks are considered to pertain to the visited file.
465 So any buffer-local binding of this variable is discarded if you change
467 change the major mode.
469 This hook is not run if any of the functions in
470 `write-contents-functions' returns non-nil. Both hooks pertain
471 to how to save a buffer to file, for instance, choosing a suitable
472 coding system and setting mode bits. (See Info
473 node `(elisp)Saving Buffers'.) To perform various checks or
484 "List of functions to be called before writing out a buffer to a file.
485 If one of them returns non-nil, the file is considered already written
486 and the rest are not called and neither are the functions in
487 `write-file-functions'.
489 This variable is meant to be used for hooks that pertain to the
490 buffer's contents, not to the particular visited file; thus,
491 `set-visited-file-name' does not clear this variable; but changing the
492 major mode does clear it.
494 For hooks that _do_ pertain to the particular visited file, use
495 `write-file-functions'. Both this variable and
496 `write-file-functions' relate to how a buffer is saved to file.
497 To perform various checks or updates before the buffer is saved,
504 "Control use of local variables in files you visit.
505 The value can be t, nil, :safe, :all, or something else.
507 A value of t means file local variables specifications are obeyed
508 if all the specified variable values are safe; if any values are
509 not safe, Emacs queries you, once, whether to set them all.
510 \(When you say yes to certain values, they are remembered as safe.)
512 :safe means set the safe variables, and ignore the rest.
513 :all means set all variables, whether safe or not.
514 (Don't set it permanently to :all.)
515 A value of nil means always ignore the file local variables.
517 Any other value means always query you once whether to set them all.
518 \(When you say yes to certain values, they are remembered as safe, but
521 This variable also controls use of major modes specified in
522 a -*- line.
525 always obeys file local variable specifications and the -*- line,
526 and ignores this variable."
527 :risky t
536 "Like `enable-local-variables' but meant for buffer-local bindings.
537 The meaningful values are nil and non-nil. The default is non-nil.
538 If a major mode sets this to nil, buffer-locally, then any local
539 variables list in the file will be ignored.
541 This variable does not affect the use of major modes
546 The value can be t, nil or something else.
547 A value of t means obey `eval' variables.
548 A value of nil means ignore them; anything else means query."
549 :risky t
555 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
564 "Non-nil means buffers visiting files read-only do so in view mode.
565 In fact, this means that all read-only buffers normally have
566 View mode enabled, including buffers that are read-only because
567 you visit a file you cannot alter, and buffers you make read-only
573 "History list of file names entered in the minibuffer.
575 Maximum length of the history list is determined by the value
577 \f
580 "Provides support for ange-ftp host name completion.
581 Runs the usual ange-ftp hook, but only for completion operations."
582 ;; Having this here avoids the need to load ange-ftp when it's not
583 ;; really in use.
589 inhibit-file-name-handlers)))
597 "Convert a standard file's name to something suitable for the OS.
598 This means to guarantee valid names and perhaps to canonicalize
599 certain patterns.
601 FILENAME should be an absolute file name since the conversion rules
602 sometimes vary depending on the position in the file name. E.g. c:/foo
603 is a valid DOS file name, but c:/bar/c:/foo is not.
605 This function's standard definition is trivial; it just returns
606 the argument. However, on Windows and DOS, replace invalid
607 characters. On DOS, make sure to obey the 8.3 limitations.
608 In the native Windows build, turn Cygwin names into native names,
609 and also turn slashes into backslashes if the shell requires it (see
610 `w32-shell-dos-semantics').
612 See Info node `(elisp)Standard File Names' for more details."
617 ;; Replace invalid filename characters with !
621 name))
629 "Read directory name, prompting with PROMPT and completing in directory DIR.
630 Value is not expanded---you must call `expand-file-name' yourself.
631 Default name to DEFAULT-DIRNAME if user exits with the same
632 non-empty string that was inserted by this function.
633 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
634 or just DIR if INITIAL is nil.)
635 If the user exits with an empty minibuffer, this function returns
636 an empty string. (This can only happen if the user erased the
637 pre-inserted contents or if `insert-default-directory' is nil.)
638 Fourth arg MUSTMATCH non-nil means require existing directory's name.
639 Non-nil and non-t means also require confirmation after completion.
640 Fifth arg INITIAL specifies text to start with.
641 DIR should be an absolute directory name. It defaults to
642 the value of `default-directory'."
647 dir))
648 mustmatch initial
651 \f
653 "Show the current default directory."
658 "Value of the CDPATH environment variable, as a list.
662 "Explode a search path into a list of directory names.
663 Directories are separated by occurrences of `path-separator'
664 \(which is colon in GNU and GNU-like systems)."
665 ;; We could use split-string here.
673 nil
678 cd-list)))
681 "Change current directory to given absolute file name DIR."
682 ;; Put the name into directory syntax now,
683 ;; because otherwise expand-file-name may give some bad results.
685 ;; We used to additionally call abbreviate-file-name here, for an
686 ;; unknown reason. Problem is that most buffers are setup
687 ;; without going through cd-absolute and don't call
688 ;; abbreviate-file-name on their default-directory, so the few that
689 ;; do end up using a superficially different directory.
701 "Make DIR become the current buffer's default directory.
702 If your environment includes a `CDPATH' variable, try each one of
703 that list of directories (separated by occurrences of
704 `path-separator') when resolving a relative directory name.
705 The path separator is colon in GNU and GNU-like systems."
708 default-directory default-directory
724 cd-path)
725 nil))
729 "Load the Lisp file named FILE."
730 ;; This is a case where .elc makes a lot of sense.
737 "Search for FILENAME through PATH.
738 If found, return the absolute file name of FILENAME, with its suffixes;
739 otherwise return nil.
740 PATH should be a list of directories to look in, like the lists in
741 `exec-path' or `load-path'.
742 If SUFFIXES is non-nil, it should be a list of suffixes to append to
745 If non-nil, PREDICATE is used instead of `file-readable-p'.
746 PREDICATE can also be an integer to pass to the `access' system call,
747 in which case file-name handlers are ignored. This usage is deprecated.
749 For compatibility, PREDICATE can also be one of the symbols
750 `executable', `readable', `writable', or `exists', or a list of
751 one or more of those symbols."
762 "Do completion for file names passed to `locate-file'."
765 ;; FIXME: maybe we should use completion-file-name-table instead,
766 ;; tho at least for `load', the arg is passed through
767 ;; substitute-in-file-name for historical reasons.
777 ;; If we have files like "foo.el" and "foo.elc", we could load one of
778 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
779 ;; preferred way. So if we list all 3, that gives a lot of redundant
780 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
781 ;; the user does want to pay attention to the extension. We try to
782 ;; diffuse this tension by stripping the suffix, except when the
783 ;; result is a single element (i.e. usually we only list "foo" unless
784 ;; it's the only remaining element in the list, in which case we do
785 ;; list "foo", "foo.elc" and "foo.el").
796 string-file dir))
801 ;; Switching from names to names+fullnames creates a non-monotonicity
802 ;; which can cause problems with things like partial-completion.
803 ;; To minimize the problem, filter out completion-regexp-list, so that
804 ;; M-x load-library RET t/x.e TAB finds some files.
807 ;; Remove duplicates of the first element, so that we can easily check
808 ;; if `names' really only contains a single element.
811 ;; There's no more than one matching non-suffixed element, so expand
812 ;; the list by adding the suffixed elements as well.
815 string-dir names string-file pred action)))))
818 "Do completion for file names passed to `locate-file'.
819 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
822 string nil action))
827 "Regexp of directory names which stop the search in `locate-dominating-file'.
828 Any directory whose name matches this regexp will be treated like
829 a kind of root directory by `locate-dominating-file' which will stop its search
830 when it bumps into it.
831 The default regexp prevents fruitless and time-consuming attempts to find
832 special files in directories in which filenames are interpreted as hostnames,
835 ;; (defun locate-dominating-files (file regexp)
836 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
837 ;; Stop at the first parent where a matching file is found and return the list
838 ;; of files that that match in this directory."
839 ;; (catch 'found
840 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
841 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
842 ;; (let ((user nil)
843 ;; ;; Abbreviate, so as to stop when we cross ~/.
844 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
845 ;; files)
846 ;; (while (and dir
847 ;; ;; As a heuristic, we stop looking up the hierarchy of
848 ;; ;; directories as soon as we find a directory belonging to
849 ;; ;; another user. This should save us from looking in
850 ;; ;; things like /net and /afs. This assumes that all the
851 ;; ;; files inside a project belong to the same user.
852 ;; (let ((prev-user user))
853 ;; (setq user (nth 2 (file-attributes dir)))
854 ;; (or (null prev-user) (equal user prev-user))))
855 ;; (if (setq files (condition-case nil
856 ;; (directory-files dir 'full regexp 'nosort)
857 ;; (error nil)))
858 ;; (throw 'found files)
859 ;; (if (equal dir
860 ;; (setq dir (file-name-directory
861 ;; (directory-file-name dir))))
862 ;; (setq dir nil))))
863 ;; nil)))
866 "Look up the directory hierarchy from FILE for a file named NAME.
867 Stop at the first parent directory containing a file NAME,
868 and return the directory. Return nil if not found."
869 ;; We used to use the above locate-dominating-files code, but the
870 ;; directory-files call is very costly, so we're much better off doing
871 ;; multiple calls using the code in here.
872 ;;
873 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
874 ;; `name' in /home or in /.
878 ;; `user' is not initialized outside the loop because
879 ;; `file' may not exist, so we may have to walk up part of the
880 ;; hierarchy before we find the "initial UID".
882 try)
885 ;; FIXME: Disabled this heuristic because it is sometimes
886 ;; inappropriate.
887 ;; As a heuristic, we stop looking up the hierarchy of
888 ;; directories as soon as we find a directory belonging
889 ;; to another user. This should save us from looking in
890 ;; things like /net and /afs. This assumes that all the
891 ;; files inside a project belong to the same user.
892 ;; (let ((prev-user user))
893 ;; (setq user (nth 2 (file-attributes file)))
894 ;; (and prev-user (not (equal user prev-user))))
902 root))
906 "Search for COMMAND in `exec-path' and return the absolute file name.
907 Return nil if COMMAND is not found anywhere in `exec-path'."
908 ;; Use 1 rather than file-executable-p to better match the behavior of
909 ;; call-process.
913 "Load the Emacs Lisp library named LIBRARY.
914 This is an interface to the function `load'. LIBRARY is searched
915 for in `load-path', both with and without `load-suffixes' (as
916 well as `load-file-rep-suffixes').
918 See Info node `(emacs)Lisp Libraries' for more details.
919 See `load-file' for a different interface to `load'."
923 load-path
928 "Test whether FILE specifies a location on a remote system.
929 Returns nil or a string identifying the remote connection (ideally
930 a prefix of FILE). For example, the remote identification for filename
933 less reliable than accessing local files.
934 Furthermore, relative file names do not work across remote connections.
936 IDENTIFICATION specifies which part of the identification shall
937 be returned as string. IDENTIFICATION can be the symbol
938 `method', `user', `host' or `localname'; any other value is
939 handled like nil and means to return the complete identification
940 string.
942 If CONNECTED is non-nil, the function returns an identification only
943 if FILE is located on a remote system, and a connection is established
944 to that remote system.
946 `file-remote-p' will never open a connection on its own."
950 nil)))
953 "Whether to use the remote file-name cache for read access.
955 When `nil', always use the cached values.
956 When `t', never use them.
957 A number means use them for that amount of seconds since they were
958 cached.
960 File attributes of remote files are cached for better performance.
961 If they are changed out of Emacs' control, the cached values
962 become invalid, and must be invalidated.
964 In case a remote file is checked regularly, it might be
965 reasonable to let-bind this variable to a value less then the
966 time period between two checks.
967 Example:
969 \(defun display-time-file-nonempty-p \(file)
970 \(let \(\(remote-file-name-inhibit-cache \(- display-time-interval 5)))
971 \(and \(file-exists-p file)
972 \(< 0 \(nth 7 \(file-attributes \(file-chase-links file)))))))"
983 "Copy the file FILE into a temporary file on this machine.
984 Returns the name of the local copy, or nil, if FILE is directly
985 accessible."
986 ;; This formerly had an optional BUFFER argument that wasn't used by
987 ;; anything.
991 nil)))
994 "Return the truename of FILENAME, which should be absolute.
995 The truename of a file name is found by chasing symbolic links
996 both at the level of the file and at the level of the directories
997 containing it, until no links are left at any level.
1000 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1001 ;; COUNTER can be a cons cell whose car is the count of how many
1002 ;; more links to chase before getting an error.
1003 ;; PREV-DIRS can be a cons cell whose car is an alist
1004 ;; of truenames we've just recently computed.
1018 ;; For speed, remove the ange-ftp completion handler from the list.
1019 ;; We know it's not needed here.
1020 ;; For even more speed, do this only on the outermost call.
1027 ;; andrewi@harlequin.co.uk - none of the following code (except for
1028 ;; invoking the file-name handler) currently applies on Windows
1029 ;; (ie. there are no native symlinks), but there is an issue with
1030 ;; case differences being ignored by the OS, and short "8.3 DOS"
1031 ;; name aliases existing for all files. (The short names are not
1032 ;; reported by directory-files, but can be used to refer to files.)
1033 ;; It seems appropriate for file-truename to resolve these issues in
1034 ;; the most natural way, which on Windows is to call the function
1035 ;; `w32-long-file-name' - this returns the exact name of a file as
1036 ;; it is stored on disk (expanding short name aliases with the full
1037 ;; name in the process).
1040 ;; For file name that has a special handler, call handler.
1041 ;; This is so that ange-ftp can save time by doing a no-op.
1044 ;; If filename contains a wildcard, newname will be the old name.
1046 ;; If filename exists, use the long name. If it doesn't exist,
1047 ;; drill down until we find a directory that exists, and use
1048 ;; the long name of that, with the extra non-existent path
1049 ;; components concatenated.
1051 missing rest)
1054 ;; Include the preceding directory separator in the missing
1055 ;; part so subsequent recursion on the rest works.
1060 ""
1065 ;; If this file directly leads to a link, process that iteratively
1066 ;; so that we don't use lots of stack.
1072 ;; For file name that has a special handler, call handler.
1073 ;; This is so that ange-ftp can save time by doing a no-op.
1076 done t)
1078 target dirfile)
1079 ;; Get the truename of the directory.
1081 ;; If these are equal, we have the (or a) root directory.
1083 ;; If this is the same dir we last got the truename for,
1084 ;; save time--don't recalculate.
1094 done t)
1097 done t)
1098 ;; Put it back on the file name.
1100 ;; Is the file name the name of a link?
1103 ;; Yes => chase that link, then start all over
1104 ;; since the link may point to a directory name that uses links.
1105 ;; We can't safely use expand-file-name here
1106 ;; since target might look like foo/../bar where foo
1107 ;; is itself a link. Instead, we handle . and .. above.
1110 target
1112 done nil)
1113 ;; No, we are done!
1115 filename))
1118 "Chase links in FILENAME until a name that is not a link.
1119 Unlike `file-truename', this does not check whether a parent
1120 directory name is a symbolic link.
1121 If the optional argument LIMIT is a number,
1122 it means chase no more than that many links and then stop."
1130 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1133 ;; Handle `..' by hand, since it needs to work in the
1134 ;; target of any directory symlink.
1135 ;; This code is not quite complete; it does not handle
1136 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1140 ;; Chase links in the default dir of the symlink.
1144 ;; Now find the parent of that dir.
1148 newname))
1151 "Create a temporary file.
1152 The returned file name (created by appending some random characters at the end
1153 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1154 is guaranteed to point to a newly created empty file.
1155 You can then use `write-region' to write new data into the file.
1157 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1159 If SUFFIX is non-nil, add that at the end of the file name."
1161 file)
1164 ;; Create temp files with strict access rights. It's easy to
1165 ;; loosen them later, whereas it's impossible to close the
1166 ;; time-window of loose permissions otherwise.
1174 temporary-file-directory)
1176 temporary-file-directory))))
1182 nil)
1184 ;; the file was somehow created by someone else between
1185 ;; `make-temp-name' and `write-region', let's try again.
1186 nil)
1187 file)
1188 ;; Reset the umask.
1192 "Change the encoding of FILE's name from CODING to NEW-CODING.
1193 The value is a new name of FILE.
1194 Signals a `file-already-exists' error if a file of the new name
1195 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1196 is non-nil. A number as fourth arg means request confirmation if
1197 the new name already exists. This is what happens in interactive
1198 use with M-x."
1201 default-file-name-coding-system))
1203 from-coding to-coding)
1205 ;; We provide the default coding only when it seems that
1206 ;; the filename is correctly decoded by the default
1207 ;; coding.
1213 filename default-coding)
1214 default-coding))
1218 ;; We provide the default coding only when a user is going to
1219 ;; change the encoding not from the default coding.
1223 filename from-coding)))
1226 filename from-coding default-coding)
1227 default-coding)))
1231 default-file-name-coding-system))
1232 ;; FILE should have been decoded by DEFAULT-CODING.
1236 ;; Suppress further encoding.
1241 newname))
1242 \f
1244 "Whether confirmation is requested before visiting a new file or buffer.
1245 If nil, confirmation is not requested.
1246 If the value is `after-completion', confirmation is only
1247 requested if the user called `minibuffer-complete' right before
1248 `minibuffer-complete-and-exit'.
1249 Any other non-nil value means to request confirmation.
1251 This affects commands like `switch-to-buffer' and `find-file'."
1259 "Whether to request confirmation before visiting a new file or buffer.
1260 The variable `confirm-nonexistent-file-or-buffer' determines the
1261 return value, which may be passed as the REQUIRE-MATCH arg to
1262 `read-buffer' or `find-file-read-args'."
1270 "Read the name of a buffer to switch to and return as a string.
1271 It is intended for `switch-to-buffer' family of commands since they
1272 need to omit the name of current buffer from the list of completions
1273 and default values."
1278 ;; Since rbts-completion-table is built dynamically, we
1279 ;; can't just add it to the default value of
1280 ;; icomplete-with-completion-tables, so we add it
1281 ;; here manually.
1286 icomplete-with-completion-tables))))
1291 "Select the buffer specified by BUFFER-OR-NAME in another window.
1292 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1293 nil. Return the buffer switched to.
1295 If called interactively, prompt for the buffer name using the
1296 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1297 determines whether to request confirmation before creating a new
1298 buffer.
1300 If BUFFER-OR-NAME is a string and does not identify an existing
1301 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1302 nil, switch to the buffer returned by `other-buffer'.
1304 Optional second argument NORECORD non-nil means do not put this
1305 buffer at the front of the list of recently selected ones.
1307 This uses the function `display-buffer' as a subroutine; see its
1308 documentation for additional customization information."
1312 same-window-buffer-names same-window-regexps)
1316 "Switch to buffer BUFFER-OR-NAME in another frame.
1317 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1318 nil. Return the buffer switched to.
1320 If called interactively, prompt for the buffer name using the
1321 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1322 determines whether to request confirmation before creating a new
1323 buffer.
1325 If BUFFER-OR-NAME is a string and does not identify an existing
1326 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1327 nil, switch to the buffer returned by `other-buffer'.
1329 Optional second arg NORECORD non-nil means do not put this
1330 buffer at the front of the list of recently selected ones.
1332 This uses the function `display-buffer' as a subroutine; see its
1333 documentation for additional customization information."
1337 same-window-buffer-names same-window-regexps)
1341 "Display buffer BUFFER in another frame.
1342 This uses the function `display-buffer' as a subroutine; see
1343 its documentation for additional customization information."
1346 same-window-buffer-names same-window-regexps
1348 new-window)
1350 ;; This may have been here in order to prevent the new frame from hiding
1351 ;; the old frame. But it does more harm than good.
1352 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1353 ;;(lower-frame (window-frame new-window))
1355 ;; This may have been here in order to make sure the old-frame gets the
1356 ;; focus. But not only can it cause an annoying flicker, with some
1357 ;; window-managers it just makes the window invisible, with no easy
1358 ;; way to recover it. --Stef
1359 ;;(make-frame-invisible (window-frame old-window))
1360 ;;(make-frame-visible (window-frame old-window))
1361 ))
1364 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1365 BODY should use the minibuffer at most once.
1366 Recursive uses of the minibuffer are unaffected (FUN is not
1367 called additional times).
1369 This macro actually adds an auxiliary function that calls FUN,
1370 rather than FUN itself, to `minibuffer-setup-hook'."
1376 ;; Clear out this hook so it does not interfere
1377 ;; with any recursive minibuffer usage.
1388 t))
1391 "Edit file FILENAME.
1392 Switch to a buffer visiting file FILENAME,
1393 creating one if none already exists.
1394 Interactively, the default if you just type RET is the current directory,
1395 but the visited file name is available through the minibuffer history:
1396 type M-n to pull it into the minibuffer.
1398 You can visit files on remote machines by specifying something
1399 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1400 also visit local files as a different user by specifying
1401 /sudo::FILE for the file name.
1402 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1403 manual, for more about this.
1405 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1406 expand wildcards (if any) and visit multiple files. You can
1407 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1409 To visit a file without any kind of conversion and without
1420 "Edit file FILENAME, in another window.
1423 an existing one. See the function `display-buffer'.
1425 Interactively, the default if you just type RET is the current directory,
1426 but the visited file name is available through the minibuffer history:
1427 type M-n to pull it into the minibuffer.
1429 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1430 expand wildcards (if any) and visit multiple files."
1443 "Edit file FILENAME, in another frame.
1446 an existing one. See the function `display-buffer'.
1448 Interactively, the default if you just type RET is the current directory,
1449 but the visited file name is available through the minibuffer history:
1450 type M-n to pull it into the minibuffer.
1452 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1453 expand wildcards (if any) and visit multiple files."
1466 "Edit the existing file FILENAME.
1468 file names with wildcards."
1477 "Edit file FILENAME but don't allow changes.
1491 value))
1494 "Edit file FILENAME in another window but don't allow changes.
1508 value))
1511 "Edit file FILENAME in another frame but don't allow changes.
1525 value))
1528 "Find file FILENAME as a replacement for the file in the next window.
1529 This command does not select that window.
1533 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1534 expand wildcards (if any) and replace the file with multiple files."
1545 "Find alternate file: " file-dir nil
1547 t))))
1555 "Find file FILENAME, select its buffer, kill previous buffer.
1556 If the current buffer now contains an empty file that you just visited
1557 \(presumably by mistake), use this command to visit the file you really want.
1561 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1562 expand wildcards (if any) and replace the file with multiple files.
1564 If the current buffer is an indirect buffer, or the base buffer
1565 for one or more indirect buffers, the other buffer(s) are not
1566 killed."
1575 "Find alternate file: " file-dir nil
1577 t)))
1592 ;; Run `kill-buffer-hook' here. It needs to happen before
1593 ;; variables like `buffer-file-name' etc are set to nil below,
1594 ;; because some of the hooks that could be invoked
1595 ;; (e.g., `save-place-to-alist') depend on those variables.
1596 ;;
1597 ;; Note that `kill-buffer-hook' is not what queries whether to
1598 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1599 ;; asks that itself. Thus, there's no need to temporarily do
1600 ;; `(set-buffer-modified-p nil)' before running this hook.
1602 ;; Okay, now we can end-of-life the old buffer.
1609 ;; This prevents us from finding the same buffer
1610 ;; if we specified the same file again.
1614 ;; Likewise for dired buffers.
1618 ;; This executes if find-file gets an error
1619 ;; and does not really find anything.
1620 ;; We put things back as they were.
1621 ;; If find-file actually finds something, we kill obuf below.
1630 ;; We already ran these; don't run them again.
1633 \f
1635 "Create a suitably named buffer for visiting FILENAME, and return it.
1636 FILENAME (sans directory) is used unchanged if that name is free;
1637 otherwise a string <2> or <3> or ... is appended to get an unused name.
1638 Spaces at the start of FILENAME (sans directory) are removed."
1647 "Create and return a buffer with a name based on NAME.
1648 Choose the buffer's name using `generate-new-buffer-name'."
1652 "Regexp to match the automounter prefix in a directory name."
1660 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1662 home directory is a root directory) and removes automounter prefixes
1663 \(see the variable `automount-dir-prefix')."
1664 ;; Get rid of the prefixes added by the automounter.
1671 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1672 ;; To fix this right, we need a `file-name-case-sensitive-p'
1673 ;; function, but we don't have that yet, so just guess.
1676 ;; If any elt of directory-abbrev-alist matches this name,
1677 ;; abbreviate accordingly.
1683 ;; Compute and save the abbreviated homedir name.
1684 ;; We defer computing this until the first time it's needed, to
1685 ;; give time for directory-abbrev-alist to be set properly.
1686 ;; We include a slash at the end, to avoid spurious matches
1687 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1694 ;; If FILENAME starts with the abbreviated homedir,
1695 ;; make it start with `~' instead.
1697 ;; If the home dir is just /, don't change it.
1700 ;; MS-DOS root directories can come with a drive letter;
1701 ;; Novell Netware allows drive letters beyond `Z:'.
1709 filename)))
1712 "List of logical names for which visiting shouldn't save the true dirname."
1717 "Return the buffer visiting file FILENAME (a string).
1718 This is like `get-file-buffer', except that it checks for any buffer
1719 visiting the same file, possibly under a different name.
1720 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1721 and others are ignored.
1722 If there is no such live buffer, return nil."
1735 found)
1745 ;; Verify this buffer's file number
1746 ;; still belongs to its file.
1749 attributes)
1753 found))))
1754 \f
1756 "Non-nil means file-visiting commands should handle wildcards.
1757 For example, if you specify `*.c', that would visit all the files
1758 whose names match the pattern."
1764 "Non-nil means suppress warning messages for symlinked files.
1765 When nil, Emacs prints a warning when visiting a file that is already
1766 visited, but with a different name. Setting this option to t
1767 suppresses this warning."
1773 "Maximum size of file above which a confirmation is requested.
1774 When nil, never request confirmation."
1781 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1782 OP-TYPE specifies the file operation being performed (for message to user)."
1792 "Read file FILENAME into a buffer and return the buffer.
1793 If a buffer exists visiting FILENAME, return that one, but
1794 verify that the file has not changed since visited or saved.
1795 The buffer is not selected, just returned to the caller.
1796 Optional second arg NOWARN non-nil means suppress any warning messages.
1797 Optional third arg RAWFILE non-nil means the file is read literally.
1798 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1799 and visit all the matching files. When wildcards are actually
1800 used and expanded, return a list of buffers that are visiting
1801 the various files."
1808 'find-directory-functions
1811 filename)))
1814 find-file-wildcards
1828 ;; Find any buffer for a file which has same truename.
1830 ;; Let user know if there is a buffer with the same truename.
1834 find-file-suppress-same-file-warnings
1838 ;; Optionally also find that buffer.
1841 ;; Check to see if the file looks uncommonly large.
1845 ;; We are using an existing buffer.
1852 ;; Certain files should be reverted automatically
1853 ;; if they have changed on disk and not in the buffer.
1861 found))
1871 "File %s changed on disk. Discard your edits? "
1876 "File %s changed on disk. Discard your edits in %s? "
1884 ;; Check if a formerly read-only file has become
1885 ;; writable and vice versa, but if the buffer agrees
1886 ;; with the new state of the file, that is ok too.
1894 buffer-file-name
1903 ;; It is confusing to ask whether to visit
1904 ;; non-literally if they have the file in
1905 ;; hexl-mode.
1911 "The file %s is already visited normally,
1912 and you have edited the buffer. Now you have asked to visit it literally,
1913 meaning no coding system handling, format conversion, or local variables.
1914 Emacs can only visit a file in one way at a time.
1916 Do you want to save the file, and visit it literally instead? "
1917 "The file %s is already visited literally,
1918 meaning no coding system handling, format conversion, or local variables.
1919 You have edited the buffer. Now you have asked to visit the file normally,
1920 but Emacs can only visit a file in one way at a time.
1927 rawfile truename number))
1931 "\
1932 Do you want to discard your changes, and visit the file literally now? "
1933 "\
1936 rawfile truename number)
1942 "The file %s is already visited normally.
1943 You have asked to visit it literally,
1944 meaning no coding system decoding, format conversion, or local variables.
1945 But Emacs can only visit a file in one way at a time.
1947 Do you want to revisit the file literally now? "
1948 "The file %s is already visited literally,
1949 meaning no coding system decoding, format conversion, or local variables.
1950 You have asked to visit it normally,
1951 but Emacs can only visit a file in one way at a time.
1956 rawfile truename number)
1959 ;; Return the buffer we are using.
1960 buf)
1961 ;; Create a new buffer.
1963 ;; find-file-noselect-1 may use a different buffer.
1965 rawfile truename number))))))
1971 ;; Needed in case we are re-visiting the file with a different
1972 ;; text representation.
1989 filename)))
1990 ;; Unconditionally set error
2000 filename)))
2001 ;; Run find-file-not-found-functions until one returns non-nil.
2003 ;; If they fail too, set error.
2005 ;; Record the file's truename, and maybe use that as visited name.
2013 ;; Set buffer's default directory to that of the file.
2015 ;; Turn off backup files for certain file names. Since
2016 ;; this is a permanent local, the major mode won't eliminate it.
2031 \f
2033 "Like `insert-file-contents', but only reads in the file literally.
2034 A buffer may be modified in several ways after reading into the buffer,
2035 to Emacs features such as format decoding, character code
2036 conversion, `find-file-hook', automatic uncompression, etc.
2038 This function ensures that none of these modifications will take place."
2046 nil))
2049 inhibit-file-name-handlers))
2062 filename)))
2063 ;; Check whether the file is uncommonly large
2074 "Insert contents of file FILENAME into buffer after point with no conversion.
2076 This function is meant for the user to run interactively.
2077 Don't call it from programs! Use `insert-file-contents-literally' instead.
2078 \(Its calling sequence is different; see its documentation)."
2083 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2088 "Visit file FILENAME with no conversion of any kind.
2089 Format conversion and character code conversion are both disabled,
2090 and multibyte characters are disabled in the resulting buffer.
2091 The major mode used is Fundamental mode regardless of the file name,
2092 and local variable specifications in the file are ignored.
2093 Automatic uncompression and adding a newline at the end of the
2094 file due to `require-final-newline' is also disabled.
2096 You cannot absolutely rely on this function to result in
2097 visiting the file literally. If Emacs already has a buffer
2098 which is visiting the file, you get the existing buffer,
2099 regardless of whether it was created literally or not.
2101 In a Lisp program, if you want to be sure of accessing a file's
2102 contents literally, you should create a temporary buffer and then read
2103 the file contents into it using `insert-file-contents-literally'."
2106 "Find file literally: " nil default-directory
2109 \f
2113 after-find-file-from-revert-buffer
2114 nomodes)
2115 "Called after finding a file and by the default revert function.
2116 Sets buffer mode, parses local variables.
2117 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2118 error in reading the file. WARN non-nil means warn if there
2119 exists an auto-save file more recent than the visited file.
2120 NOAUTO means don't mess with auto-save mode.
2121 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2122 means this call was from `revert-buffer'.
2123 Fifth arg NOMODES non-nil means don't alter the file's modes.
2124 Finishes by calling the functions in `find-file-hook'
2125 unless NOMODES is non-nil."
2128 nil
2138 ;; No need to warn if buffer is auto-saved
2139 ;; under the name of the visited file.
2141 auto-save-visited-file-name))
2144 buffer-file-name))
2164 ;; Make people do a little extra work (C-x C-q)
2165 ;; before altering a backup file.
2168 ;; When a file is marked read-only,
2169 ;; make the buffer read-only even if root is looking at it.
2177 ;; If requested, add a newline at the end of the file.
2187 view-read-only
2193 "Eval BODY and turn any error into a FORMAT message.
2194 FORMAT can have a %s escape which will be replaced with the actual error.
2195 If `debug-on-error' is set, errors are not caught, so that you can
2196 debug them.
2197 Avoid using a large BODY since it is duplicated."
2206 "Choose the major mode for this buffer automatically.
2207 Also sets up any specified local variables of the file.
2208 Uses the visited file name, the -*- line, and the local variables spec.
2210 This function is called automatically from `find-file'. In that case,
2211 we may set up the file-specified mode and local variables,
2212 depending on the value of `enable-local-variables'.
2213 In addition, if `local-enable-local-variables' is nil, we do
2214 not set local variables (though we do notice a mode specified with -*-.)
2216 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2217 or from Lisp without specifying the optional argument FIND-FILE;
2218 in that case, this function acts as if `enable-local-variables' were t."
2226 ;; Turn font lock off and on, to make sure it takes account of
2227 ;; whatever file local variables are relevant to it.
2229 ;; Font-lock-mode (now in font-core.el) can be ON when
2230 ;; font-lock.el still hasn't been loaded.
2240 "Non-nil means to try second pass through `auto-mode-alist'.
2241 This means that if the first case-sensitive search through the alist fails
2242 to find a matching major mode, a second case-insensitive search is made.
2243 On systems with case-insensitive file names, this variable is ignored,
2244 since only a single case-insensitive search through the alist is made."
2250 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2251 ;; c++-mode, java-mode and more) are added through autoload
2252 ;; directives in that file. That way is discouraged since it
2253 ;; spreads out the definition of the initial value.
2297 ;; Less common extensions come here
2298 ;; so more common ones above are found faster.
2306 ;; Besides .gdbinit, gdb documents other names to be usable for init
2307 ;; files, cross-debuggers can use something like
2308 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2309 ;; don't interfere with each other.
2347 ;; The list of archive file extensions should be in sync with
2348 ;; `auto-coding-alist' with `no-conversion' coding system.
2354 ;; Mailer puts message to be edited in
2355 ;; /tmp/Re.... or Message
2358 ;; some news reader is reported to use this
2367 ;; .emacs or .gnus or .viper following a directory delimiter in
2368 ;; Unix, MSDOG or VMS syntax.
2371 ;; _emacs following a directory delimiter
2372 ;; in MsDos syntax
2376 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2377 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2378 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2381 ;; .xs is also used for ld scripts, but seems to be more commonly
2382 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2384 ;; Explained in binutils ld/genscripts.sh. Eg:
2385 ;; A .x script file is the default script.
2386 ;; A .xr script is for linking without relocation (-r flag). Etc.
2390 ;; Common Lisp ASDF package system.
2408 ;; Windows candidates may be opened case sensitively on Unix
2414 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2416 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2417 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2418 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2419 ;; this has lower priority to avoid matching changelog.sgml etc.
2421 ;; either user's dot-files or under /etc or some such
2423 ;; alas not all ~/.*rc files are like this
2424 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2429 ;; this contains everything twice, with space and with colon :-(
2431 ;; Get rid of any trailing .n.m and try again.
2432 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2433 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2434 ;; Using mode nil rather than `ignore' would let the search continue
2435 ;; through this list (with the shortened name) rather than start over.
2437 ;; The following should come after the ChangeLog pattern
2438 ;; for the sake of ChangeLog.1, etc.
2439 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2442 "Alist of filename patterns vs corresponding major mode functions.
2443 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2444 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2445 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2446 mode function to use. FUNCTION will be called, unless it is nil.
2448 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2449 calling FUNCTION (if it's not nil), we delete the suffix that matched
2450 REGEXP and search the list again for another match.
2452 If the file name matches `inhibit-first-line-modes-regexps',
2453 then `auto-mode-alist' is not processed.
2455 The extensions whose FUNCTION is `archive-mode' should also
2456 appear in `auto-coding-alist' with `no-conversion' coding system.
2458 See also `interpreter-mode-alist', which detects executable script modes
2459 based on the interpreters they specify to run,
2464 "Select Conf mode or XML mode according to start of file."
2474 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2475 ;; and pike-mode) are added through autoload directives in that
2476 ;; file. That way is discouraged since it spreads out the
2477 ;; definition of the initial value.
2516 "Alist mapping interpreter names to major modes.
2517 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2518 Each element looks like (INTERPRETER . MODE).
2519 If INTERPRETER matches the name of the interpreter specified in the first line
2520 of a script, mode MODE is enabled.
2528 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2529 When checking `inhibit-first-line-modes-regexps', we first discard
2535 "Regexp matching interpreters, for file mode determination.
2536 This regular expression is matched against the first line of a file
2537 to determine the file's mode in `set-auto-mode'. If it matches, the file
2538 is assumed to be interpreted by the interpreter matched by the second group
2539 of the regular expression. The mode is then determined as the mode
2543 "Alist of buffer beginnings vs. corresponding major mode functions.
2544 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2545 After visiting a file, if REGEXP matches the text at the beginning of the
2546 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2547 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2548 major mode.
2550 If FUNCTION is nil, then it is not called. (That is a way of saying
2558 ;; The < comes before the groups (but the first) to reduce backtracking.
2559 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2560 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2564 comment-re "*"
2567 . html-mode)
2569 ;; These two must come after html, because they are more general:
2574 . sgml-mode)
2577 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2578 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2579 After visiting a file, if REGEXP matches the text at the beginning of the
2580 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2581 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2582 have not specified a mode for this file.
2588 "Upper limit on `magic-mode-alist' regexp matches.
2592 "Select major mode appropriate for current buffer.
2594 To find the right major mode, this function checks for a -*- mode tag,
2595 checks if it uses an interpreter listed in `interpreter-mode-alist',
2596 matches the buffer beginning against `magic-mode-alist',
2597 compares the filename against the entries in `auto-mode-alist',
2598 then matches the buffer beginning against `magic-fallback-mode-alist'.
2600 It does not check for the `mode:' local variable in the
2601 Local Variables section of the file; for that, use `hack-local-variables'.
2603 If `enable-local-variables' is nil, this function does not check for a
2604 -*- mode tag.
2606 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2607 set the major mode only if that would change it. In other words
2608 we don't actually set it to the same mode the buffer already has."
2609 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2611 ;; Find a -*- mode tag
2618 ;; Find all specifications for the `mode:' variable
2619 ;; and execute them left to right.
2631 modes)))
2632 ;; Simple -*-MODE-*- case.
2635 modes))))
2636 ;; If we found modes to use, invoke them now, outside the save-excursion.
2644 ;; continuing would call minor modes again, toggling them off
2646 ;; If we didn't, look for an interpreter specified in the first line.
2647 ;; As a special case, allow for things like "#!/bin/env perl", which
2648 ;; finds the interpreter anywhere in $PATH.
2655 ;; Map interpreter name to a mode, signalling we're done at the
2656 ;; same time.
2658 interpreter-mode-alist))
2659 ;; If we found an interpreter mode to use, invoke it now.
2662 ;; Next try matching the buffer beginning against magic-mode-alist.
2676 ;; Next compare the filename against the entries in auto-mode-alist.
2681 ;; Remove remote file name identification.
2685 ;; Remove backup-suffixes from file name.
2688 ;; Find first matching alist entry.
2691 ;; System is case-insensitive.
2695 ;; System is case-sensitive.
2697 ;; First match case-sensitively.
2701 ;; Fallback to case-insensitive match.
2715 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2730 ;; When `keep-mode-if-same' is set, we are working on behalf of
2731 ;; set-visited-file-name. In that case, if the major mode specified is the
2732 ;; same one we already have, don't actually reset it. We don't want to lose
2733 ;; minor modes such as Font Lock.
2735 "Apply MODE and return it.
2736 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2737 any aliases and compared to current major mode. If they are the
2738 same, do nothing and return nil."
2744 mode)))
2747 "Find the -*- spec in the buffer.
2748 Call with point at the place to start searching from.
2749 If one is found, set point to the beginning
2750 and return the position of the end.
2751 Otherwise, return nil; point may be changed."
2754 ;; Don't look for -*- if this file name matches any
2755 ;; of the regexps in inhibit-first-line-modes-regexps.
2763 sufs)
2771 ;; If the file begins with "#!"
2772 ;; (exec interpreter magic), look
2773 ;; for mode frobs in the first two
2774 ;; lines. You cannot necessarily
2775 ;; put them in the first line of
2776 ;; such a file without screwing up
2777 ;; the interpreter invocation.
2778 ;; The same holds for
2779 ;; '\"
2780 ;; in man pages (preprocessor
2781 ;; magic for the `man' program).
2792 end))))
2793 \f
2794 ;;; Handling file local variables
2798 file-local-variables-alist dir-local-variables-alist)
2803 "Normal hook run after processing a file's local variables specs.
2804 Major modes can use this to examine user-specified local variables
2808 "List variable-value pairs that are considered safe.
2809 Each element is a cons cell (VAR . VAL), where VAR is a variable
2810 symbol and VAL is a value that is considered safe."
2811 :risky t
2818 "Expressions that are considered safe in an `eval:' local variable.
2819 Add expressions to this list if you want Emacs to evaluate them, when
2820 they appear in an `eval' local variable specification, without first
2821 asking you for confirmation."
2822 :risky t
2827 ;; Risky local variables:
2830 buffer-auto-save-file-name
2831 buffer-file-name
2832 buffer-file-truename
2833 buffer-undo-list
2834 debugger
2835 default-text-properties
2836 eval
2837 exec-directory
2838 exec-path
2839 file-name-handler-alist
2840 frame-title-format
2841 global-mode-string
2842 header-line-format
2843 icon-title-format
2844 inhibit-quit
2845 load-path
2846 max-lisp-eval-depth
2847 max-specpdl-size
2848 minor-mode-map-alist
2849 minor-mode-overriding-map-alist
2850 mode-line-format
2851 mode-name
2852 overriding-local-map
2853 overriding-terminal-local-map
2854 process-environment
2855 standard-input
2856 standard-output
2857 unread-command-events))
2859 ;; Safe local variables:
2860 ;;
2861 ;; For variables defined by major modes, the safety declarations can go into
2862 ;; the major mode's file, since that will be loaded before file variables are
2863 ;; processed.
2864 ;;
2865 ;; For variables defined by minor modes, put the safety declarations in the
2866 ;; file defining the minor mode after the defcustom/defvar using an autoload
2867 ;; cookie, e.g.:
2868 ;;
2869 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2870 ;;
2871 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2872 ;; minor mode file may not be loaded yet.
2873 ;;
2874 ;; For variables defined in the C source code the declaration should go here:
2895 "Alist of file-local variable settings in the current buffer.
2896 Each element in this list has the form (VAR . VALUE), where VAR
2897 is a file-local variable (a symbol) and VALUE is the value
2898 specified. The actual value in the buffer may differ from VALUE,
2903 "Alist of directory-local variable settings in the current buffer.
2904 Each element in this list has the form (VAR . VALUE), where VAR
2905 is a directory-local variable (a symbol) and VALUE is the value
2906 specified in .dir-locals.el. The actual value in the buffer
2907 may differ from VALUE, if it is changed by the major or minor modes,
2912 "Normal hook run before setting file-local variables.
2913 It is called after checking for unsafe/risky variables and
2914 setting `file-local-variables-alist', and before applying the
2915 variables stored in `file-local-variables-alist'. A hook
2916 function is allowed to change the contents of this alist.
2918 This hook is called only if there is at least one file-local
2922 "Get confirmation before setting up local variable values.
2923 ALL-VARS is the list of all variables to be set up.
2924 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2925 RISKY-VARS is the list of those that are marked as risky.
2926 DIR-NAME is a directory name if these settings come from
2927 directory-local variables, or nil otherwise."
2929 nil
2935 prompt char)
2945 ", and variables that are risky (**)."
2952 y -- to apply the local variables list.
2956 ! -- to apply the local variables list, and permanently mark these
2968 ;; Make strings with embedded whitespace easier to read.
2976 ""
2983 done)
2992 ;; read-event returns -1 if we are in a kbd
2993 ;; macro and there are no more events in the
2994 ;; macro. In that case, attempt to get an
2995 ;; event interactively.
3003 ;; When this is called from desktop-restore-file-buffer,
3004 ;; coding-system-for-read may be non-nil. Reset it before
3005 ;; writing to .emacs.
3009 'safe-local-variable-values
3010 safe-local-variable-values))))
3017 "Return local variables specified in the -*- line.
3018 Ignore any specification for `mode:' and `coding:';
3019 `set-auto-mode' should already have handled `mode:',
3020 `set-auto-coding' should already have handled `coding:'.
3022 If MODE-ONLY is non-nil, all we do is check whether the major
3023 mode is specified, returning t if it is specified. Otherwise,
3024 return an alist of elements (VAR . VAL), where VAR is a variable
3025 and VAL is the specified value."
3029 result mode-specified)
3030 ;; Parse the -*- line into the RESULT alist.
3031 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
3033 nil)
3035 ;; Simple form: "-*- MODENAME -*-". Already handled.
3037 nil)
3039 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3040 ;; (last ";" is optional).
3045 ;; There used to be a downcase here,
3046 ;; but the manual didn't say so,
3047 ;; and people want to set var names that aren't all lc.
3053 ;; It is traditional to ignore
3054 ;; case when checking for `mode' in set-auto-mode,
3055 ;; so we must do that here as well.
3056 ;; That is inconsistent, but we're stuck with it.
3057 ;; The same can be said for `coding' in set-auto-coding.
3063 'eval
3070 mode-specified
3071 result))))
3074 "Filter local variable settings, querying the user if necessary.
3075 VARIABLES is the alist of variable-value settings. This alist is
3076 filtered based on the values of `ignored-local-variables',
3077 `enable-local-eval', `enable-local-variables', and (if necessary)
3078 user interaction. The results are added to
3079 `file-local-variables-alist', without applying them.
3080 DIR-NAME is a directory name if these settings come from
3081 directory-local variables, or nil otherwise."
3082 ;; Find those variables that we may want to save to
3083 ;; `safe-local-variable-values'.
3089 ;; Ignore any variable in `ignored-local-variables'.
3090 nil)
3091 ;; Obey `enable-local-eval'.
3099 ;; Ignore duplicates (except `mode') in the present list.
3101 ;; Accept known-safe variables.
3105 ;; The variable is either risky or unsafe:
3112 ;; Query, unless all vars are safe or user wants no querying.
3118 risky-vars dir-name))
3129 "Parse and put into effect this buffer's local variables spec.
3130 If MODE-ONLY is non-nil, all we do is check whether the major mode
3131 is specified, returning t if it is specified."
3134 result)
3141 ;; Look for "Local variables:" line in last page.
3149 ;; suffix is what comes after "local variables:" in its line.
3150 ;; prefix is what comes before "local variables:" in its line.
3160 beg)
3164 endpos
3170 nil t))
3171 ;; This used to be an error, but really all it means is
3172 ;; that this may simply not be a local-variables section,
3173 ;; so just ignore it.
3183 ;; Discard the prefix.
3188 ;; Discard the suffix.
3196 ;; Find the variable name; strip whitespace.
3205 val)
3206 ;; Read the variable value.
3217 'eval
3222 ;; Now we've read all the local variables.
3223 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3225 ;; Otherwise, set the variables.
3232 ;; Any 'evals must run in the Right sequence.
3241 "Non-nil if SYM is safe as a file-local variable with value VAL.
3242 It is safe if any of these conditions are met:
3244 * There is a matching entry (SYM . VAL) in the
3245 `safe-local-variable-values' user option.
3247 * The `safe-local-variable' property of SYM is a function that
3248 evaluates to a non-nil value with VAL as an argument."
3254 "Non-nil if SYM could be dangerous as a file-local variable.
3255 It is dangerous if either of these conditions are met:
3257 * Its `risky-local-variable' property is non-nil.
3263 ;; If this is an alias, check the base name.
3283 "Return t if it is safe to eval EXP when it is found in a file."
3285 ;; Detect certain `put' expressions.
3292 lisp-indent-function
3293 scheme-indent-function))
3294 ;; Only allow safe values (not functions).
3299 ;; Only allow indirect form specs.
3300 ;; During bootstrapping, edebug-basic-spec might not be
3301 ;; defined yet.
3305 ;; Allow expressions that the user requested.
3307 ;; Certain functions can be allowed with safe arguments
3308 ;; or can specify verification functions to try.
3316 ok))
3324 ok)))))))
3327 "Set local variable VAR with value VAL.
3328 If VAR is `mode', call `VAL-mode' as a function unless it's
3329 already the major mode."
3336 ;; A minor mode must be passed an argument.
3337 ;; Otherwise, if the user enables the minor mode in a
3338 ;; major mode hook, this would toggle it off.
3344 ;; Make sure the string has no text properties.
3345 ;; Some text properties can get evaluated in various ways,
3346 ;; so it is risky to put them on with a local variable list.
3350 \f
3351 ;;; Handling directory-local variables, aka project settings.
3357 "List of cached directory roots for directory-local variable classes.
3358 Each element in this list has the form (DIR CLASS MTIME).
3359 DIR is the name of the directory.
3360 CLASS is the name of a variable class (a symbol).
3361 MTIME is the recorded modification time of the directory-local
3362 variables file associated with this entry. This time is a list
3363 of two integers (the same format as `file-attributes'), and is
3364 used to test whether the cache entry is still valid.
3365 Alternatively, MTIME can be nil, which means the entry is always
3369 "Return the variable list for CLASS."
3373 "Collect directory-local variables from MODE-VARIABLES.
3374 VARIABLES is the initial list of variables.
3375 Returns the new list."
3380 ;; If variables are specified more than once, only use the last. (Why?)
3381 ;; The pseudo-variables mode and eval are different (bug#3430).
3384 ;; Need a new cons in case we setcdr later.
3388 "Collect entries from CLASS-VARIABLES into VARIABLES.
3389 ROOT is the root directory of the project.
3390 Return the new variables list."
3398 ;; Don't include this in the previous condition, because we
3399 ;; want to filter all strings before the next condition.
3411 "Declare that the DIRECTORY root is an instance of CLASS.
3412 DIRECTORY is the name of a directory, a string.
3413 CLASS is the name of a project class, a symbol.
3414 MTIME is either the modification time of the directory-local
3415 variables file that defined this class, or nil.
3417 When a file beneath DIRECTORY is visited, the mode-specific
3418 variables from CLASS are applied to the buffer. The variables
3419 for a class are defined using `dir-locals-set-class-variables'."
3426 "Map the type CLASS to a list of variable settings.
3427 CLASS is the project class, a symbol. VARIABLES is a list
3428 that declares directory-local variables for the class.
3429 An element in VARIABLES is either of the form:
3430 (MAJOR-MODE . ALIST)
3431 or
3432 (DIRECTORY . LIST)
3434 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3435 whose elements are of the form (VARIABLE . VALUE).
3437 In the second form, DIRECTORY is a directory name (a string), and
3438 LIST is a list of the form accepted by the function.
3440 When a file is visited, the file's class is found. A directory
3441 may be assigned a class using `dir-locals-set-directory-class'.
3442 Then variables are set in the file's buffer according to the
3443 class' LIST. The list is processed in order.
3445 * If the element is of the form (MAJOR-MODE . ALIST), and the
3446 buffer's major mode is derived from MAJOR-MODE (as determined
3447 by `derived-mode-p'), then all the variables in ALIST are
3448 applied. A MAJOR-MODE of nil may be used to match any buffer.
3449 `make-local-variable' is called for each variable before it is
3450 set.
3452 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3453 is an initial substring of the file's directory, then LIST is
3454 applied by recursively following these rules."
3461 "File that contains directory-local variables.
3462 It has to be constant to enforce uniform values
3466 "Find the directory-local variables for FILE.
3467 This searches upward in the directory tree from FILE.
3468 If the directory root of FILE has been registered in
3469 `dir-locals-directory-cache' and the directory-local variables
3470 file has not been modified, return the matching entry in
3471 `dir-locals-directory-cache'.
3472 Otherwise, if a directory-local variables file is found, return
3473 the file name.
3474 Otherwise, return nil."
3479 dir-locals-file))
3482 ;; `locate-dominating-file' may have abbreviated the name.
3485 ;; Find the best cached value in `dir-locals-directory-cache'.
3498 ;; Check the validity of the cache.
3503 ;; This cache entry is OK.
3504 dir-elt
3505 ;; This cache entry is invalid; clear it.
3508 locals-file)
3509 locals-file))))
3512 "Load a variables FILE and register a new class and instance.
3513 FILE is the name of the file holding the variables to apply.
3514 The new class name is the same as the directory in which FILE
3515 is found. Returns the new class name."
3525 class-name)))
3528 "Read per-directory local variables for the current buffer.
3529 Store the directory-local variables in `dir-local-variables-alist'
3530 and `file-local-variables-alist', without applying them."
3533 ;; Find the variables file.
3539 (setq dir-name (if (buffer-file-name) (file-name-directory (buffer-file-name)) default-directory))
3560 \f
3563 However, the mode will not be changed if
3564 \(1) a local variables list or the `-*-' line specifies a major mode, or
3566 \ not suitable for ordinary files, or
3567 \(3) the new file name does not particularly specify any mode."
3572 "Change name of file visited in current buffer to FILENAME.
3573 This also renames the buffer to correspond to the new file.
3574 The next time the buffer is saved it will go in the newly specified file.
3575 FILENAME nil or an empty string means mark buffer as not visiting any file.
3576 Remember to delete the initial contents of the minibuffer
3577 if you wish to pass an empty string as the argument.
3579 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3580 confirmation in the case where another buffer is already visiting FILENAME.
3582 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3583 the old visited file has been renamed to the new name FILENAME."
3591 nil
3606 filename)))
3616 ;; If new-name == old-name, renaming would add a spurious <2>
3617 ;; and it's considered as a feature in rename-buffer.
3623 ;; Abbreviate the file names of the buffer.
3632 nil)))
3633 ;; write-file-functions is normally used for things like ftp-find-file
3634 ;; that visit things that are not local files as if they were files.
3635 ;; Changing to visit an ordinary local file instead should flush the hook.
3640 ;; If buffer was read-only because of version control,
3641 ;; that reason is gone now, so make it writable.
3645 ;; Turn off backup files for certain file names.
3646 ;; Since this is a permanent local, the major mode won't eliminate it.
3648 backup-enable-predicate
3654 ;; If auto-save was not already on, turn it on if appropriate.
3658 ;; If auto save is on, start using a new name.
3659 ;; We deliberately don't rename or delete the old auto save
3660 ;; for the old visited file name. This is because perhaps
3661 ;; the user wants to save the new state and then compare with the
3662 ;; previous state from the auto save file.
3665 ;; Rename the old auto save file if any.
3672 ;; Update the major mode, if the file name determines it.
3674 ;; Don't change the mode if it is special.
3677 ;; Don't change the mode if the local variable list specifies it.
3683 "Write current buffer into file FILENAME.
3684 This makes the buffer visit that file, and marks it as not modified.
3686 If you specify just a directory name as FILENAME, that means to use
3687 the default file name but in that directory. You can also yank
3688 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3690 If the buffer is not already visiting a file, the default file name
3691 for the output file is the buffer name.
3693 If optional second arg CONFIRM is non-nil, this function
3694 asks for confirmation before overwriting an existing file.
3695 Interactively, confirmation is required unless you supply a prefix argument."
3696 ;; (interactive "FWrite file: ")
3700 nil nil nil nil)
3704 default-directory)
3705 nil nil))
3709 ;; If arg is just a directory,
3710 ;; use the default file name, but in that directory.
3721 ;; Make buffer writable if file is writable.
3726 ;; It's likely that the VC status at the new location is different from
3727 ;; the one at the old location.
3729 \f
3731 "Make a backup of the disk file visited by the current buffer, if appropriate.
3732 This is normally done before saving the buffer the first time.
3734 A backup may be done by renaming or by copying; see documentation of
3735 variable `make-backup-files'. If it's done by renaming, then the file is
3736 no longer accessible under its old name.
3738 The value is non-nil after a backup was made by renaming.
3739 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3740 MODES is the result of `file-modes' on the original
3741 file; this means that the caller, after saving the buffer, should change
3742 the modes of the new file to agree with the old modes.
3743 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3744 file; this means that the caller, after saving the buffer, should change
3745 the SELinux context of the new file to agree with the old context.
3746 BACKUPNAME is the backup file name, which is the old file renamed."
3753 backup-info backupname targets setmodes)
3754 ;; If specified name is a symbolic link, chase it to the target.
3755 ;; Thus we make the backups in the directory where the real file is.
3760 ;; (if (file-directory-p buffer-file-name)
3761 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3765 ;; If have old versions to maybe delete,
3766 ;; ask the user to confirm now, before doing anything.
3767 ;; But don't actually delete til later.
3772 real-file-name)))))
3775 ;; Actually write the back up file.
3778 ; (file-symlink-p buffer-file-name)
3779 backup-by-copying
3780 ;; Don't rename a suid or sgid file.
3795 ;; rename-file should delete old backup.
3799 ;; If trouble writing the backup, write it in ~.
3804 backupname)
3808 ;; Now delete the old versions, if desired.
3815 setmodes)
3822 ;; Create temp files with strict access rights. It's easy to
3823 ;; loosen them later, whereas it's impossible to close the
3824 ;; time-window of loose permissions otherwise.
3827 ;; Try to overwrite old backup first.
3835 nil)
3837 ;; The file was somehow created by someone else between
3838 ;; `delete-file' and `copy-file', so let's try again.
3839 ;; rms says "I think there is also a possible race
3840 ;; condition for making backup files" (emacs-devel 20070821).
3841 nil)))
3842 ;; Reset the umask.
3850 "Return file NAME sans backup versions or strings.
3851 This is a separate procedure so your site-init or startup file can
3852 redefine it.
3853 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3854 we do not remove backup version numbers, only true file version numbers."
3866 "Return t if deleting FILE and rewriting it would preserve the owner."
3871 ;; Return t if the file doesn't exist, since it's true that no
3872 ;; information would be lost by an (attempted) delete and create.
3878 The extension, in a file name, is the part that follows the last `.',
3879 except that a leading `.', if any, doesn't count."
3882 directory)
3886 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3887 ;; we don't want to expand it.
3890 filename))))
3894 The extension, in a file name, is the part that follows the last `.',
3895 excluding version numbers and backup suffixes,
3896 except that a leading `.', if any, doesn't count.
3897 Return nil for extensionless file names such as `foo'.
3898 Return the empty string for file names such as `foo.'.
3900 If PERIOD is non-nil, then the returned value includes the period
3901 that delimits the extension, and if FILENAME has no extension,
3912 "A function to use instead of the default `make-backup-file-name'.
3913 A value of nil gives the default `make-backup-file-name' behavior.
3915 This could be buffer-local to do something special for specific
3916 files. If you define it, you may need to change `backup-file-name-p'
3917 and `file-name-sans-versions' too.
3919 See also `backup-directory-alist'."
3925 "Alist of filename patterns and backup directory names.
3926 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3927 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3928 relative or absolute. If it is absolute, so that all matching files
3929 are backed up into the same directory, the file names in this
3930 directory will be the full name of the file backed up with all
3931 directory separators changed to `!' to prevent clashes. This will not
3932 work correctly if your filesystem truncates the resulting name.
3934 For the common case of all backups going into one directory, the alist
3936 directory name.
3938 If this variable is nil, or it fails to match a filename, the backup
3939 is made in the original file's directory.
3941 On MS-DOS filesystems without long names this variable is always
3942 ignored."
3948 "Default `backup-enable-predicate' function.
3949 Checks for files in `temporary-file-directory',
3950 `small-temporary-file-directory', and /tmp."
3953 ;; Directory is under temporary-file-directory.
3958 ;; Directory is under /tmp.
3963 0 nil
3965 ;; Directory is under small-temporary-file-directory.
3970 "Create the non-numeric backup file name for FILE.
3971 Normally this will just be the file's name with `~' appended.
3972 Customization hooks are provided as follows.
3974 If the variable `make-backup-file-name-function' is non-nil, its value
3975 should be a function which will be called with FILE as its argument;
3976 the resulting name is used.
3978 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3979 the documentation of that variable. If the directory for the backup
3980 doesn't exist, it is created."
3994 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3996 elt backup-directory abs-backup-directory)
4001 alist nil)))
4002 ;; If backup-directory is relative, it should be relative to the
4003 ;; file's directory. By expanding explicitly here, we avoid
4004 ;; depending on default-directory.
4013 abs-backup-directory nil))))
4015 file
4019 ;; Normalize DOSish file names: downcase the drive
4020 ;; letter, if any, and replace the leading "x:" with
4021 ;; "/drive_x".
4024 ;; Replace any invalid file-name characters (for the
4025 ;; case of backing up remote files).
4029 "drive_"
4032 ""
4035 ;; Make the name unique by substituting directory
4036 ;; separators. It may not really be worth bothering about
4037 ;; doubling `!'s in the original name...
4042 backup-directory))
4047 "Return non-nil if FILE is a backup file name (numeric or not).
4048 This is a separate function so you can redefine it for customization.
4049 You may need to redefine `file-name-sans-versions' as well."
4054 ;; This is used in various files.
4055 ;; The usage of backup-extract-version-start is not very clean,
4056 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4058 "Given the name of a numeric backup file, FN, return the backup number.
4059 Uses the free variable `backup-extract-version-start', whose value should be
4060 the index in the name where the version number begins."
4067 "Find a file name for a backup file FN, and suggestions for deletions.
4068 Value is a list whose car is the name for the backup file
4069 and whose cdr is a list of old versions to consider deleting now.
4070 If the value is nil, don't make a backup.
4071 Uses `backup-directory-alist' in the same way as does
4072 `make-backup-file-name'."
4074 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4078 ;; We don't support numbered backups on plain MS-DOS
4079 ;; when long file names are unavailable.
4089 possibilities deserve-versions-p versions)
4092 base-versions
4095 possibilities)
4096 #'<)
4101 kept-old-versions
4102 kept-new-versions
4109 ;; Delete nothing if there is overflow
4110 ;; in the number of versions to keep.
4116 v))))))))))
4119 "Return number of names file FILENAME has."
4122 ;; (defun file-relative-name (filename &optional directory)
4123 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4124 ;; This function returns a relative file name which is equivalent to FILENAME
4125 ;; when used with that default directory as the default.
4126 ;; If this is impossible (which can happen on MSDOS and Windows
4127 ;; when the file name and directory use different drive names)
4128 ;; then it returns FILENAME."
4129 ;; (save-match-data
4130 ;; (let ((fname (expand-file-name filename)))
4131 ;; (setq directory (file-name-as-directory
4132 ;; (expand-file-name (or directory default-directory))))
4133 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4134 ;; ;; drive names, they can't be relative, so return the absolute name.
4135 ;; (if (and (or (eq system-type 'ms-dos)
4136 ;; (eq system-type 'cygwin)
4137 ;; (eq system-type 'windows-nt))
4138 ;; (not (string-equal (substring fname 0 2)
4139 ;; (substring directory 0 2))))
4140 ;; filename
4141 ;; (let ((ancestor ".")
4142 ;; (fname-dir (file-name-as-directory fname)))
4143 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4144 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4145 ;; (setq directory (file-name-directory (substring directory 0 -1))
4146 ;; ancestor (if (equal ancestor ".")
4147 ;; ".."
4148 ;; (concat "../" ancestor))))
4149 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4150 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4151 ;; ;; We matched within FNAME's directory part.
4152 ;; ;; Add the rest of FNAME onto ANCESTOR.
4153 ;; (let ((rest (substring fname (match-end 0))))
4154 ;; (if (and (equal ancestor ".")
4155 ;; (not (equal rest "")))
4156 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4157 ;; rest
4158 ;; (concat (file-name-as-directory ancestor) rest)))
4159 ;; ;; We matched FNAME's directory equivalent.
4160 ;; ancestor))))))
4163 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4164 This function returns a relative file name which is equivalent to FILENAME
4165 when used with that default directory as the default.
4166 If FILENAME and DIRECTORY lie on different machines or on different drives
4167 on a DOS/Windows machine, it returns FILENAME in expanded form."
4171 default-directory))))
4177 ;; Test for different drives on DOS/Windows
4179 ;; Should `cygwin' really be included here? --stef
4182 ;; Test for different remote file system identification
4184 filename
4190 directory nil nil case-fold-search))
4192 directory nil nil case-fold-search))))
4195 ".."
4197 ;; Now ancestor is empty, or .., or ../.., etc.
4199 directory nil nil case-fold-search))
4200 ;; We matched within FILENAME's directory part.
4201 ;; Add the rest of FILENAME onto ANCESTOR.
4204 ;; But don't bother with ANCESTOR if it would give us `./'.
4205 rest
4207 ;; We matched FILENAME's directory equivalent.
4208 ancestor))))))
4209 \f
4211 "Save current buffer in visited file if modified.
4212 Variations are described below.
4214 By default, makes the previous version into a backup file
4215 if previously requested or if this is the first save.
4217 to become a backup when the next save is done.
4219 unconditionally makes the previous version into a backup file.
4221 to become a backup when the next save is done,
4222 and unconditionally makes the previous version into a backup file.
4224 With a numeric argument of 0, never make the previous version
4225 into a backup file.
4227 If a file's name is FOO, the names of its numbered backup versions are
4228 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4229 Numeric backups (rather than FOO~) will be made if value of
4230 `version-control' is not the atom `never' and either there are already
4231 numeric versions of the file being backed up, or `version-control' is
4232 non-nil.
4233 We don't want excessive versions piling up, so there are variables
4234 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4235 and `kept-new-versions', which tells how many newest versions to keep.
4236 Defaults are 2 old versions and 2 new.
4237 `dired-kept-versions' controls dired's clean-directory (.) command.
4238 If `delete-old-versions' is nil, system will query user
4239 before trimming versions. Otherwise it does it silently.
4241 If `vc-make-backup-files' is nil, which is the default,
4242 no backup files are made for files managed by version control.
4243 (This is because the version control system itself records previous versions.)
4245 See the subroutine `basic-save-buffer' for more information."
4251 ;; We used to display the message below only for files > 50KB, but
4252 ;; then Rmail-mbox never displays it due to buffer swapping. If
4253 ;; the test is ever re-introduced, be sure to handle saving of
4254 ;; Rmail files.
4261 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4262 Normally delete only if the file was written by this Emacs since
4263 the last real save, but optional arg FORCE non-nil means delete anyway."
4277 "Normal hook that is run before a buffer is saved to its file."
4283 "Normal hook that is run after a buffer is saved to its file."
4289 "If non-nil, use this coding system for saving the buffer.
4290 More precisely, use this coding system in place of the
4291 value of `buffer-file-coding-system', when saving the buffer.
4292 Calling `write-region' for any purpose other than saving the buffer
4293 will still use `buffer-file-coding-system'; this variable has no effect
4300 "Save the current buffer in its visited file, if it has been modified.
4301 The hooks `write-contents-functions' and `write-file-functions' get a chance
4302 to do the job of saving; if they do not, then the buffer is saved in
4303 the visited file in the usual way.
4304 Before and after saving the buffer, this function runs
4305 `before-save-hook' and `after-save-hook', respectively."
4308 ;; In an indirect buffer, save its base buffer instead.
4313 setmodes)
4314 ;; If buffer has no file name, ask user for one.
4321 ;; Signal an error if the user specified the name of an
4322 ;; existing directory.
4325 filename))
4327 ;; Signal an error if the specified name refers to a
4328 ;; non-existing directory.
4358 ;; Support VC version backups.
4364 ;; If a hook returned t, file is already "written".
4365 ;; Otherwise, write it the usual way now.
4367 ;; Now we have saved the current buffer. Let's make sure
4368 ;; that buffer-file-coding-system is fixed to what
4369 ;; actually used for saving by binding it locally.
4381 ;; If the auto-save file was recent before this command,
4382 ;; delete it now.
4384 ;; Support VC `implicit' locking.
4389 ;; This does the "real job" of writing a buffer into its visited file
4390 ;; and making a backup file. This is what is normally done
4391 ;; but inhibited if one of write-file-functions returns non-nil.
4392 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4404 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4418 buffer-file-name)))
4432 ;; Write temp name, then rename it.
4433 ;; This requires write access to the containing dir,
4434 ;; which is why we don't try it if we don't have that access.
4436 tempname succeed
4439 ;; Create temp files with strict access rights. It's easy to
4440 ;; loosen them later, whereas it's impossible to close the
4441 ;; time-window of loose permissions otherwise.
4446 ;; Try various temporary names.
4447 ;; This code follows the example of make-temp-file,
4448 ;; but it calls write-region in the appropriate way
4449 ;; for saving the buffer.
4455 ;; Pass in nil&nil rather than point-min&max
4456 ;; cause we're saving the whole buffer.
4457 ;; write-region-annotate-functions may use it.
4459 tempname nil realname
4461 nil)
4463 ;; The file was somehow created by someone else between
4464 ;; `make-temp-name' and `write-region', let's try again.
4465 nil)
4467 ;; Reset the umask.
4469 ;; If we failed, restore the buffer's modtime.
4472 ;; Since we have created an entirely new file,
4473 ;; make sure it gets the right permission bits set.
4478 buffer-file-name)))
4479 ;; We succeeded in writing the temp file,
4480 ;; so rename it.
4482 ;; If file not writable, see if we can make it writable
4483 ;; temporarily while we write it.
4484 ;; But no need to do so if we have just backed it up
4485 ;; (setmodes is set) because that says we're superseding.
4487 ;; Change the mode back, after writing.
4490 buffer-file-name))
4496 ;; Pass in nil&nil rather than point-min&max to indicate
4497 ;; we're saving the buffer rather than just a region.
4498 ;; write-region-annotate-functions may make us of it.
4500 buffer-file-name nil t buffer-file-truename)
4502 ;; If we get an error writing the new file, and we made
4503 ;; the backup by renaming, undo the backing-up.
4508 setmodes))
4511 "View the differences between BUFFER and its associated file.
4512 This requires the external program `diff' to be in your `exec-path'."
4526 ;; Display that message for 1 second so that user can read it
4527 ;; in the minibuffer.
4529 ;; return always nil, so that save-buffers-kill-emacs will not move
4530 ;; over to the next unsaved buffer when calling `d'.
4531 nil)
4534 `((?\C-r
4541 ;; Return nil to ask about BUF again.
4542 nil)
4554 ;; Return nil to ask about BUF again.
4555 nil)
4565 "Save some modified file-visiting buffers. Asks user about each one.
4566 You can answer `y' to save, `n' not to save, `C-r' to look at the
4567 buffer in question with `view-buffer' before deciding or `d' to
4568 view the differences using `diff-buffer-with-file'.
4570 Optional argument (the prefix) non-nil means save all with no questions.
4571 Optional second argument PRED determines which buffers are considered:
4572 If PRED is nil, all the file-visiting buffers are considered.
4573 If PRED is t, then certain non-file buffers will also be considered.
4574 If PRED is a zero-argument function, it indicates for each buffer whether
4575 to consider it or not when called with that buffer current.
4577 See `save-some-buffers-action-alist' if you want to
4578 change the additional actions you can take on files."
4582 files-done abbrevs-done)
4584 ;; First save any buffers that we're supposed to save unconditionally.
4585 ;; That way the following code won't ask about them.
4590 ;; Ask about those buffers that merit it,
4591 ;; and record the number thus saved.
4595 ;; Note that killing some buffers may kill others via
4596 ;; hooks (e.g. Rmail and its viewing buffer).
4609 t
4621 save-some-buffers-action-alist))
4622 ;; Maybe to save abbrevs, and record whether
4623 ;; we either saved them or asked to.
4629 abbrev-file-name)))
4631 ;; Don't keep bothering user if he says no.
4636 "(Some special files were saved without asking)"
4638 \f
4640 "Mark current buffer as unmodified, not needing to be saved.
4643 It is not a good idea to use this function in Lisp programs, because it
4644 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4651 "Change whether this buffer is read-only.
4652 With prefix argument ARG, make the buffer read-only if ARG is
4653 positive, otherwise make it writable. If buffer is read-only
4654 and `view-read-only' is non-nil, enter view mode."
4659 nil ; do nothing.
4660 ;; Toggle.
4667 ;; If view-mode is already active, `view-mode-enter' is a nop.
4679 "Insert contents of file FILENAME into buffer after point.
4680 Set mark after the inserted text.
4682 This function is meant for the user to run interactively.
4683 Don't call it from programs! Use `insert-file-contents' instead.
4684 \(Its calling sequence is different; see its documentation)."
4689 "Append the contents of the region to the end of file FILENAME.
4690 When called from a function, expects three arguments,
4691 START, END and FILENAME. START and END are normally buffer positions
4692 specifying the part of the buffer to write.
4693 If START is nil, that means to use the entire buffer contents.
4694 If START is a string, then output that string to the file
4695 instead of any buffer contents; END is ignored.
4697 This does character code conversion and applies annotations
4698 like `write-region' does."
4703 "Return most recent backup file for FILENAME or nil if no backups exist."
4704 ;; `make-backup-file-name' will get us the right directory for
4705 ;; ordinary or numeric backups. It might create a directory for
4706 ;; backups as a side-effect, according to `backup-directory-alist'.
4713 tem)
4722 newest))
4725 "Rename current buffer to a similar name not already taken.
4726 This function is useful for creating multiple shell process buffers
4727 or multiple mail buffers, etc."
4735 ;; If the existing buffer name has a <NNN>,
4736 ;; which isn't part of the file name (if any),
4737 ;; then get rid of that.
4743 "Create the directory DIR and optionally any nonexistent parent dirs.
4744 If DIR already exists as a directory, signal an error, unless
4745 PARENTS is non-nil.
4747 Interactively, the default choice of directory to create is the
4748 current buffer's default directory. That is useful when you have
4749 visited a file in a nonexistent directory.
4751 Noninteractively, the second (optional) argument PARENTS, if
4752 non-nil, says whether to create parent directories that don't
4753 exist. Interactively, this happens by default."
4756 nil nil)
4757 t))
4758 ;; If default-directory is a remote directory,
4759 ;; make sure we find its make-directory handler.
4767 create-list)
4769 ;; If directory is its own parent, then we can't
4770 ;; keep looping forever
4785 "Delete the directory named DIRECTORY. Does not follow symlinks.
4786 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4787 TRASH non-nil means to trash the directory instead, provided
4788 `delete-by-moving-to-trash' is non-nil.
4790 When called interactively, TRASH is t if no prefix argument is
4791 given. With a prefix argument, TRASH is nil."
4798 "Move directory to trash: "
4800 default-directory default-directory nil nil))))
4806 nil)
4808 ;; If default-directory is a remote directory, make sure we find its
4809 ;; delete-directory handler.
4816 ;; Only move non-empty dir to trash if recursive deletion was
4817 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4818 ;; case, where the operation fails in delete-directory-internal.
4819 ;; As `move-file-to-trash' trashes directories (empty or
4820 ;; otherwise) as a unit, we do not need to recurse here.
4822 ;; Check if directory is empty apart from "." and "..".
4827 ;; Otherwise, call outselves recursively if needed.
4831 ;; This test is equivalent to
4832 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4833 ;; but more efficient
4837 ;; We do not want to delete "." and "..".
4843 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4844 If NEWNAME names an existing directory, copy DIRECTORY as subdirectory there.
4846 This function always sets the file modes of the output files to match
4847 the corresponding input file.
4849 The third arg KEEP-TIME non-nil means give the output files the same
4850 last-modified time as the old ones. (This works on only some systems.)
4852 A prefix arg makes KEEP-TIME non-nil.
4854 Noninteractively, the last argument PARENTS says whether to
4855 create parent directories if they don't exist. Interactively,
4856 this happens by default."
4863 default-directory default-directory nil nil)
4864 current-prefix-arg t)))
4865 ;; If default-directory is a remote directory, make sure we find its
4866 ;; copy-directory handler.
4872 ;; Compute target name.
4877 ;; Copy recursively.
4889 ;; We do not want to copy "." and "..".
4892 ;; Set directory attributes.
4896 \f
4899 "Function to use to revert this buffer, or nil to do the default.
4900 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4905 "Function to use to insert contents when reverting this buffer.
4906 Gets two args, first the nominal file name to use,
4907 and second, t if reading the auto-save file.
4912 "Function to check whether a non-file buffer needs reverting.
4913 This should be a function with one optional argument NOCONFIRM.
4914 Auto Revert Mode passes t for NOCONFIRM. The function should return
4915 non-nil if the buffer should be reverted. A return value of
4916 `fast' means that the need for reverting was not checked, but
4917 that reverting the buffer is fast. The buffer is current when
4918 this function is called.
4920 The idea behind the NOCONFIRM argument is that it should be
4921 non-nil if the buffer is going to be reverted without asking the
4922 user. In such situations, one has to be careful with potentially
4923 time consuming operations.
4925 For more information on how this variable is used by Auto Revert mode,
4929 "Normal hook for `revert-buffer' to run before reverting.
4930 If `revert-buffer-function' is used to override the normal revert
4934 "Normal hook for `revert-buffer' to run after reverting.
4935 Note that the hook value that it runs is the value that was in effect
4936 before reverting; that makes a difference if you have buffer-local
4937 hook functions.
4939 If `revert-buffer-function' is used to override the normal revert
4945 "Replace current buffer text with the text of the visited file on disk.
4946 This undoes all changes since the file was visited or saved.
4947 With a prefix argument, offer to revert from latest auto-save file, if
4948 that is more recent than the visited file.
4950 This command also implements an interface for special buffers
4951 that contain text which doesn't come from a file, but reflects
4952 some other data instead (e.g. Dired buffers, `buffer-list'
4953 buffers). This is done via the variable `revert-buffer-function'.
4954 In these cases, it should reconstruct the buffer contents from the
4955 appropriate data.
4957 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4958 to revert from the auto-save file when this is nil. Note that the
4959 sense of this argument is the reverse of the prefix argument, for the
4960 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4961 to nil.
4963 Optional second argument NOCONFIRM means don't ask for confirmation
4964 at all. \(The variable `revert-without-query' offers another way to
4965 revert buffers without querying for confirmation.)
4967 Optional third argument PRESERVE-MODES non-nil means don't alter
4968 the files modes. Normally we reinitialize them using `normal-mode'.
4970 If the value of `revert-buffer-function' is non-nil, it is called to
4971 do all the work for this command. Otherwise, the hooks
4972 `before-revert-hook' and `after-revert-hook' are run at the beginning
4973 and the end, and if `revert-buffer-insert-file-contents-function' is
4974 non-nil, it is called instead of rereading visited file contents."
4976 ;; I admit it's odd to reverse the sense of the prefix argument, but
4977 ;; there is a lot of code out there which assumes that the first
4978 ;; argument should be t to avoid consulting the auto-save file, and
4979 ;; there's no straightforward way to encourage authors to notice a
4980 ;; reversal of the argument sense. So I'm just changing the user
4981 ;; interface, but leaving the programmatic interface the same.
4989 buffer-auto-save-file-name
4994 buffer-auto-save-file-name
4995 buffer-file-name)))
5005 file-name)))
5007 ;; If file was backed up but has changed since,
5008 ;; we should make another backup.
5012 ;; Effectively copy the after-revert-hook status,
5013 ;; since after-find-file will clobber it.
5016 after-revert-hook))
5021 ;; Get rid of all undo records for this buffer.
5023 ;; Don't make undo records for the reversion.
5026 file-name auto-save-p)))
5029 "File %s no longer exists!"
5031 file-name))
5034 "File %s no longer readable!"
5036 file-name))
5038 ;; Bind buffer-file-name to nil
5039 ;; so that we don't try to lock the file.
5045 ;; Auto-saved file should be read by Emacs'
5046 ;; internal coding.
5050 buffer-file-coding-system-explicit
5053 coding-system-for-read
5055 coding-system-for-read)
5057 ;; As a coding system suitable for multibyte
5058 ;; buffer is specified, make the current
5059 ;; buffer multibyte.
5062 ;; This force after-insert-file-set-coding
5063 ;; (called from insert-file-contents) to set
5064 ;; buffer-file-coding-system to a proper value.
5067 ;; Note that this preserves point in an intelligent way.
5071 nil nil t))
5073 nil nil t)))))
5074 ;; Recompute the truename in case changes in symlinks
5075 ;; have changed the truename.
5079 ;; Run after-revert-hook as it was before we reverted.
5083 local-hook)
5086 t))))))
5089 "Recover the visited file--get contents from its last auto-save file."
5094 "Visit file FILE, but get contents from its last auto-save file."
5095 ;; Actually putting the file name in the minibuffer should be used
5096 ;; only rarely.
5097 ;; Not just because users often use the default.
5117 ;; Use insert-directory-safely, not insert-directory,
5118 ;; because these files might not exist. In particular,
5119 ;; FILE might not exist if the auto-save file was for
5120 ;; a buffer that didn't visit a file, such as "*mail*".
5121 ;; The code in v20.x called `ls' directly, so we need
5122 ;; to emulate what `ls' did in that case.
5128 ;; Keep the current buffer-file-coding-system.
5130 ;; Auto-saved file should be read with special coding.
5139 "Recover auto save files from a previous Emacs session.
5140 This command first displays a Dired buffer showing you the
5141 previous sessions that you could recover from.
5142 To choose one, move point to the proper line and then type C-c C-c.
5143 Then you'll be asked about a number of files to recover."
5153 auto-save-list-file-prefix)))
5154 t)
5163 ;; Each line starts with a space
5164 ;; so that Font Lock mode won't highlight the first character.
5173 "Choose one saved session to recover auto-save files from.
5174 This command is used in the special Dired buffer created by
5177 ;; Get the name of the session file to recover from.
5179 files
5185 ;; Read in the auto-save-list file.
5188 ;; Loop thru the text of that file
5189 ;; and get out the names of the files to recover.
5193 ;; This is a pair of lines for a non-file-visiting buffer.
5194 ;; Get the auto-save file name and manufacture
5195 ;; a "visited file name" from that.
5198 ;; If there is no auto-save file name, the
5199 ;; auto-save-list file is probably corrupted.
5212 ;; This pair of lines is a file-visiting
5213 ;; buffer. Use the visited file name.
5223 ;; Ignore a file if its auto-save file does not exist now.
5227 ;; The file contains a pair of line for each auto-saved buffer.
5228 ;; The first line of the pair contains the visited file name
5229 ;; or is empty if the buffer was not visiting a file.
5230 ;; The second line is the auto-save file name.
5238 files
5244 "Kill BUFFER if confirmed."
5252 "Kill some buffers. Asks the user whether to kill each one of them.
5253 Non-interactively, if optional argument LIST is non-nil, it
5254 specifies the list of buffers to kill, asking for approval for each one."
5262 ; if we killed the base buffer.
5269 "Kill buffers whose name matches the specified REGEXP.
5270 The optional second argument indicates whether to kill internal buffers too."
5279 \f
5281 "Adjust current buffer's auto save file name for current conditions.
5282 Also rename any existing auto save file, if it was made in this session."
5294 "Return file name to use for auto-saves of current buffer.
5295 Does not consider `auto-save-visited-file-name' as that variable is checked
5296 before calling this function. You can redefine this for customization.
5297 See also `auto-save-file-name-p'."
5305 result uniq)
5306 ;; Apply user-specified translations
5307 ;; to the file name.
5311 filename)
5321 filename))))
5326 ;; We truncate the file name to DOS 8+3 limits
5327 ;; before doing anything else, because the regexp
5328 ;; passed to string-match below cannot handle
5329 ;; extensions longer than 3 characters, multiple
5330 ;; dots, and other atrocities.
5335 fn)
5340 "#"
5343 ;; Make sure auto-save file names don't contain characters
5344 ;; invalid for the underlying filesystem.
5346 ;; Don't modify remote (ange-ftp) filenames
5349 result))))
5351 ;; Deal with buffers that don't have any associated files. (Mail
5352 ;; mode tends to create a good number of these.)
5356 file-name)
5357 ;; Restrict the characters used in the file name to those which
5358 ;; are known to be safe on all filesystems, url-encoding the
5359 ;; rest.
5360 ;; We do this on all platforms, because even if we are not
5361 ;; running on DOS/Windows, the current directory may be on a
5362 ;; mounted VFAT filesystem, such as a USB memory stick.
5366 ;; For multibyte characters, this will produce more than
5367 ;; 2 hex digits, so is not true URL encoding.
5371 ;; Generate the file name.
5377 ;; Try a few alternative directories, to get one we can
5378 ;; write it.
5384 ;; Don't modify remote (ange-ftp) filenames
5386 ;; The call to convert-standard-filename is in case
5387 ;; buffer-name includes characters not allowed by the
5388 ;; DOS/Windows filesystems. make-temp-file writes to the
5389 ;; file it creates, so we must fix the file name _before_
5390 ;; make-temp-file is called.
5392 fname))
5394 ;; make-temp-file creates the file,
5395 ;; but we don't want it to exist until we do an auto-save.
5399 file-name)))
5402 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5403 FILENAME should lack slashes. You can redefine this for customization."
5405 \f
5407 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5408 The generated regexp will match a filename only if the filename
5409 matches that wildcard according to shell rules. Only wildcards known
5410 by `sh' are supported."
5412 ;; Copy the initial run of non-special characters.
5415 ;; If no special characters, we're almost done.
5419 j)
5421 result
5442 ;; Found "[^". Insert a `\0' character
5443 ;; (which cannot happen in a filename)
5444 ;; into the character class, so that `^'
5445 ;; is not the first character after `[',
5446 ;; and thus non-special in a regexp.
5451 ;; I don't think `]' can appear in a
5452 ;; character class in a wildcard, but
5453 ;; let's be general here.
5460 i
5473 ;; Shell wildcards should match the entire filename,
5474 ;; not its part. Make the regexp say so.
5476 \f
5479 "Switches for `list-directory' to pass to `ls' for brief listing."
5485 "Switches for `list-directory' to pass to `ls' for verbose listing."
5490 "Expand wildcard pattern PATTERN.
5491 This returns a list of file names which match the pattern.
5493 If PATTERN is written as an absolute file name,
5494 the values are absolute also.
5496 If PATTERN is written as a relative file name, it is interpreted
5497 relative to the current default directory, `default-directory'.
5498 The file names returned are normally also relative to the current
5499 default directory. However, if FULL is non-nil, they are absolute."
5503 ;; A list of all dirs that DIRPART specifies.
5504 ;; This can be more than one dir
5505 ;; if DIRPART contains wildcards.
5509 dirpart)))
5513 contents)
5518 ;; Filter out "." and ".."
5523 name))
5530 this-dir-contents)
5531 this-dir-contents)
5532 contents))))
5534 contents)))
5536 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5540 "Display a list of files in or matching DIRNAME, a la `ls'.
5541 DIRNAME is globbed by the shell if necessary.
5542 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5543 Actions controlled by variables `list-directory-brief-switches'
5544 and `list-directory-verbose-switches'."
5548 nil default-directory nil)
5549 pfx)))
5551 list-directory-brief-switches))
5552 buffer)
5564 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5572 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5574 PATTERN is assumed to represent a file-name wildcard suitable for the
5575 underlying filesystem. For Unix and GNU/Linux, each character from the
5577 the parts of the pattern which don't include wildcard characters are
5578 quoted with double quotes.
5581 on Windows), so PATTERN can use them to quote wildcard characters that
5582 need to be passed verbatim to shell commands."
5586 ;; DOS/Windows don't allow `"' in file names. So if the
5587 ;; argument has quotes, we can safely assume it is already
5588 ;; quoted by the caller.
5590 ;; We quote [&()#$'] in case their shell is a port of a
5591 ;; Unixy shell. We quote [,=+] because stock DOS and
5592 ;; Windows shells require that in some cases, such as
5593 ;; passing arguments to batch files that use positional
5594 ;; arguments like %1.
5596 pattern
5599 end)
5616 pattern))))
5623 "Program to get the amount of free space on a file system.
5624 We assume the output has the format of `df'.
5625 The value of this variable must be just a command name or file name;
5626 if you want to specify options, use `directory-free-space-args'.
5628 A value of nil disables this feature.
5630 If the function `file-system-info' is defined, it is always used in
5631 preference to the program given by this variable."
5637 "Options to use when running `directory-free-space-program'."
5642 "Return the amount of free space on directory DIR's file system.
5643 The return value is a string describing the amount of free
5644 space (normally, the number of free 1KB blocks).
5646 This function calls `file-system-info' if it is available, or
5647 invokes the program specified by `directory-free-space-program'
5648 and `directory-free-space-args'. If the system call or program
5649 is unsuccessful, or if DIR is a remote directory, this function
5650 returns nil."
5652 ;; Try to find the number of free blocks. Non-Posix systems don't
5653 ;; always have df, but might have an equivalent system call.
5662 ;; Avoid failure if the default directory does
5663 ;; not exist (Bug#2631, Bug#3911).
5666 nil t nil
5667 directory-free-space-args
5668 dir)
5670 ;; Assume that the "available" column is before the
5671 ;; "capacity" column. Find the "%" and scan backward.
5675 "[[:space:]]+[^[:space:]]+%[^%]*$"
5682 ;; The following expression replaces `dired-move-to-filename-regexp'.
5686 ;; In some locales, month abbreviations are as short as 2 letters,
5687 ;; and they can be followed by ".".
5688 ;; In Breton, a month name can include a quote character.
5701 s "+"
5704 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5705 ;; omits the Kanji characters after month and day-of-month.
5706 ;; On Mac OS X 10.3, the date format in East Asian locales is
5707 ;; day-of-month digits followed by month digits.
5713 ;; The "[0-9]" below requires the previous column to end in a digit.
5714 ;; This avoids recognizing `1 may 1997' as a date in the line:
5715 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5717 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5719 ;; For non-iso date formats, we add the ".*" in order to find
5720 ;; the last possible match. This avoids recognizing
5721 ;; `jservice 10 1024' as a date in the line:
5722 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5724 ;; vc dired listings provide the state or blanks between file
5725 ;; permissions and date. The state is always surrounded by
5726 ;; parantheses:
5727 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5728 ;; This is not supported yet.
5733 "Regular expression to match up to the file name in a directory listing.
5734 The default value is designed to recognize dates and times
5739 ;; insert-directory
5740 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5741 ;; FULL-DIRECTORY-P is nil.
5742 ;; The single line of output must display FILE's name as it was
5743 ;; given, namely, an absolute path name.
5744 ;; - must insert exactly one line for each file if WILDCARD or
5745 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5746 ;; before the file lines, plus optional text after the file lines.
5747 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5748 ;; allowed.
5749 ;; File lines should display the basename.
5750 ;; - must be consistent with
5751 ;; - functions dired-move-to-filename, (these two define what a file line is)
5752 ;; dired-move-to-end-of-filename,
5753 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5754 ;; dired-insert-headerline
5755 ;; dired-after-subdir-garbage (defines what a "total" line is)
5756 ;; - variable dired-subdir-regexp
5757 ;; - may be passed "--dired" as the first argument in SWITCHES.
5758 ;; Filename handlers might have to remove this switch if their
5759 ;; "ls" command does not support it.
5761 "Insert directory listing for FILE, formatted according to SWITCHES.
5762 Leaves point after the inserted text.
5763 SWITCHES may be a string of options, or a list of strings
5764 representing individual options.
5765 Optional third arg WILDCARD means treat FILE as shell wildcard.
5766 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5767 switches do not contain `d', so that a full listing is expected.
5769 This works by running a directory listing program
5770 whose name is in the variable `insert-directory-program'.
5771 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5773 When SWITCHES contains the long `--dired' option, this function
5774 treats it specially, for the sake of dired. However, the
5775 normally equivalent short `-D' option is just passed on to
5776 `insert-directory-program', as any other option."
5777 ;; We need the directory in order to find the right handler.
5782 wildcard full-directory-p)
5785 ;; Read the actual directory using `insert-directory-program'.
5786 ;; RESULT gets the status code.
5788 ;; putting text property `dired-filename, decode one
5789 ;; bunch by one to preserve that property.
5791 ;; This is to control encoding the arguments in call-process.
5795 default-file-name-coding-system))))
5798 ;; Run ls in the directory part of the file pattern
5799 ;; using the last component as argument.
5806 shell-file-name nil t nil
5807 "-c"
5809 ""
5811 insert-directory-program
5812 " -d "
5814 switches
5816 " -- "
5817 ;; Quote some characters that have
5818 ;; special meanings in shells; but
5819 ;; don't quote the wildcards--we want
5820 ;; them to be special. We also
5821 ;; currently don't quote the quoting
5822 ;; characters in case people want to
5823 ;; use them explicitly to quote
5824 ;; wildcard characters.
5826 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5827 ;; directory if FILE is a symbolic link.
5834 insert-directory-program nil t nil
5838 ;; Split the switches at any spaces so we can
5839 ;; pass separate options as separate args.
5841 ;; Avoid lossage if FILE starts with `-'.
5849 file))))))))
5851 ;; If we got "//DIRED//" in the output, it means we got a real
5852 ;; directory listing, even if `ls' returned nonzero.
5853 ;; So ignore any errors.
5866 ;; The first time ls returns an error,
5867 ;; find the version numbers of ls,
5868 ;; and set insert-directory-ls-version
5869 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5870 ;; is equal or if the info cannot be obtained.
5871 ;; (That can mean it isn't GNU ls.)
5881 comparison)
5897 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5901 ;; If `insert-directory-program' failed, signal an error.
5903 ;; Delete the error message it may have output.
5905 ;; On non-Posix systems, we cannot open a directory, so
5906 ;; don't even try, because that will always result in
5907 ;; the ubiquitous "Access denied". Instead, show the
5908 ;; command line so the user can try to guess what went wrong.
5913 insert-directory-program
5915 file result)
5916 ;; Unix. Access the file to get a suitable error.
5923 ;; The following overshoots by one line for an empty
5924 ;; directory listed with "--dired", but without "-a"
5925 ;; switch, where the ls output contains a
5926 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5927 ;; We take care of that case later.
5935 error-lines)
5936 ;; Find all the lines that are error messages,
5937 ;; and record the bounds of each one.
5944 ;; Now read the numeric positions of file names.
5951 error-lines))
5954 error-lines)))
5956 ;; End is followed by \n or by " -> ".
5958 ;; It seems that we can't trust ls's output as to
5959 ;; byte positions of filenames.
5965 ;; Take care of the case where the ls output contains a
5966 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5967 ;; and we went one line too far back (see above).
5972 ;; Now decode what read if necessary.
5974 file-name-coding-system
5975 default-file-name-coding-system
5977 coding-no-eol
5978 val pos)
5982 ;; If no coding system is specified or detection is
5983 ;; requested, detect the coding.
5997 ;; Force no eol conversion on a file name, so
5998 ;; that CR is preserved.
6006 ;; Try to insert the amount of free space.
6009 ;; First find the line to put it on.
6013 ;; Replace "total" with "used", to avoid confusion.
6019 "Convert `ls --dired' file name position value POS to a buffer position.
6020 File name position values returned in ls --dired output
6021 count only stdout; they don't count the error messages sent to stderr.
6022 So this function converts to them to real buffer positions.
6023 ERROR-LINES is a list of buffer positions of error message lines,
6024 of the form (START END)."
6028 pos)
6032 "Insert directory listing for FILE, formatted according to SWITCHES.
6034 Like `insert-directory', but if FILE does not exist, it inserts a
6035 message to that effect instead of signaling an error."
6038 ;; Simulate the message printed by `ls'.
6042 "Functions to call with no arguments to query about killing Emacs.
6043 If any of these functions returns nil, killing Emacs is cancelled.
6044 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6048 "How to ask for confirmation when leaving Emacs.
6049 If nil, the default, don't ask at all. If the value is non-nil, it should
6050 be a predicate function such as `yes-or-no-p'."
6058 "Offer to save each buffer, then kill this Emacs process.
6059 With prefix ARG, silently save all file-visiting buffers, then kill."
6068 ;; process-list is not defined on MSDOS.
6070 active)
6079 ;; Query the user for other things, perhaps.
6086 "Offer to save each buffer, then kill the current connection.
6087 If the current frame has no client, kill Emacs itself.
6089 With prefix ARG, silently save all file-visiting buffers, then kill.
6091 If emacsclient was started with a list of filenames to edit, then
6092 only these files will be asked to be saved."
6097 \f
6098 ;; We use /: as a prefix to "quote" a file name
6099 ;; so that magic file name handlers will not apply to it.
6103 file-name-handler-alist))
6105 ;; We depend on being the last handler on the list,
6106 ;; so that anything else which does need handling
6107 ;; has been handled already.
6108 ;; So it is safe for us to inhibit *all* magic file name handlers.
6117 default-directory))
6118 ;; Get a list of the indices of the args which are file names.
6121 ;; The first six are special because they
6122 ;; return a file name. We want to include the /:
6123 ;; in the return value.
6124 ;; So just avoid stripping it in the first place.
6131 ;; `identity' means just return the first arg
6132 ;; not stripped of its quoting.
6134 ;; `add' means add "/:" to the result.
6136 ;; `quote' means add "/:" to buffer-file-name.
6138 ;; `unquote-then-quote' means set buffer-file-name
6139 ;; temporarily to unquoted filename.
6141 ;; List the arguments which are filenames.
6149 ;; For all other operations, treat the first argument only
6150 ;; as the file name.
6152 method
6153 ;; Copy ARGUMENTS so we can replace elements in it.
6157 ;; Strip off the /: from the file names that have it.
6165 "/"
6181 res))
6184 \f
6185 ;; Symbolic modes and read-file-modes.
6188 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6189 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6190 Others, or All) for whom to produce the mask.
6191 The bit-mask that is returned extracts from mode bits the access rights
6192 for the specified category of users."
6200 "Convert CHAR to a numeric value of mode bits.
6201 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6202 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6209 ;; Rights relative to the previous file modes.
6220 "Convert a symbolic mode string specification to an equivalent number.
6222 WHO-MASK is the bit-mask specifying the category of users to which to
6223 apply the access permissions. See `file-modes-char-to-who'.
6224 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6225 RIGHTS request to add, remove, or set permissions based on existing ones,
6232 char-right)
6239 num-rights
6243 op char-right)))
6244 num-rights))
6247 "Convert symbolic file modes to numeric file modes.
6248 MODES is the string to convert, it should match
6251 notation.
6252 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6253 MODES request to add, remove, or set permissions based on existing ones,
6267 num-who num-modes)
6270 num-modes)))
6273 "Read file modes in octal or symbolic notation and return its numeric value.
6274 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6275 ORIG-FILE is the name of a file on whose mode bits to base returned
6276 permissions if what user types requests to add, remove, or set permissions
6292 nil nil default)))
6298 \f
6299 ;; Trashcan handling.
6301 "Directory for `move-file-to-trash' to move files and directories to.
6302 This directory is only used when the function `system-move-file-to-trash'
6303 is not defined.
6304 Relative paths are interpreted relative to `default-directory'.
6305 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6315 "Move the file (or directory) named FILENAME to the trash.
6316 When `delete-by-moving-to-trash' is non-nil, this function is
6317 called by `delete-file' and `delete-directory' instead of
6318 deleting files outright.
6320 If the function `system-move-file-to-trash' is defined, call it
6321 with FILENAME as an argument.
6322 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6323 directory.
6324 Otherwise, trash FILENAME using the freedesktop.org conventions,
6325 like the GNOME, KDE and XFCE desktop environments. Emacs only
6329 ;; If `trash-directory' is non-nil, move the file there.
6333 trash-dir)))
6334 ;; We can't trash a parent directory of trash-directory.
6337 trash-dir filename))
6340 ;; Ensure that the trashed file-name is unique.
6347 ;; If `system-move-file-to-trash' is defined, use it.
6350 ;; Otherwise, use the freedesktop.org method, as specified at
6351 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6362 ;; Check if we have permissions to delete.
6366 ;; The trashed file cannot be the trash dir or its parent.
6369 trash-files-dir filename))
6372 trash-info-dir filename))
6374 ;; Ensure that the trash directory exists; otherwise, create it.
6383 ;; Try to move to trash with .trashinfo undo information
6388 ;; Perform url-encoding on FN. For compatibility with
6389 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6390 ;; for path separators.
6395 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6396 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6409 fn))
6414 ;; Attempt to make .trashinfo file, trying up to 5
6415 ;; times. The .trashinfo file is opened with O_EXCL,
6416 ;; as per trash-spec 0.7, even if that can be a problem
6417 ;; on old NFS versions...
6421 trash-files-dir))
6423 success info-fn)
6428 trash-info-dir))
6436 ;; Uniqify new-fn. (Some file managers do not
6437 ;; like Emacs-style backup file names---e.g. bug
6438 ;; 170956 in Konqueror bug tracker.)
6443 ;; Finally, try to move the file to the trashcan.
6447 \f
6472 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6473 ;;; files.el ends here