| blob | 8b42eaaddb8342dca9055ce2df147aec92fd3851 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985-1987, 1992-2011 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Package: emacs
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Defines most of Emacs's file- and directory-handling functions,
26 ;; including basic file visiting, backup generation, link handling,
27 ;; ITS-id version control, load- and write-hook handling, and the like.
29 ;;; Code:
36 "Backups of edited data files."
40 "Finding files."
45 "Non-nil means delete auto-save file when a buffer is saved or killed.
47 Note that the auto-save file will not be deleted if the buffer is killed
48 when it has unsaved changes."
53 nil
54 "Alist of abbreviations for file directories.
55 A list of elements of the form (FROM . TO), each meaning to replace
56 FROM with TO when it appears in a directory name. This replacement is
57 done when setting up the default directory of a newly visited file.
59 FROM is matched against directory names anchored at the first
63 FROM and TO should be equivalent names, which refer to the
64 same directory. Do not use `~' in the TO strings;
65 they should be ordinary absolute directory names.
67 Use this feature when you have directories which you normally refer to
68 via absolute symbolic links. Make TO the name of the link, and FROM
69 the name it is linked to."
78 "Non-nil means make a backup of a file the first time it is saved.
79 This can be done by renaming the file or by copying.
81 Renaming means that Emacs renames the existing file so that it is a
82 backup file, then writes the buffer into a new file. Any other names
83 that the old file had will now refer to the backup file. The new file
84 is owned by you and its group is defaulted.
86 Copying means that Emacs copies the existing file into the backup
87 file, then writes the buffer on top of the existing file. Any other
88 names that the old file had will now refer to the new (edited) file.
89 The file's owner and group are unchanged.
91 The choice of renaming or copying is controlled by the variables
92 `backup-by-copying', `backup-by-copying-when-linked',
93 `backup-by-copying-when-mismatch' and
94 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
98 ;; Do this so that local variables based on the file name
99 ;; are not overridden by the major mode.
101 "Non-nil means don't make a backup, regardless of the other parameters.
102 This variable is intended for use by making it local to a buffer.
107 "Non-nil means always use copying to create backup files.
108 See documentation of variable `make-backup-files'."
113 "Non-nil means use copying to create backups for files with multiple names.
114 This causes the alternate names to refer to the latest version as edited.
115 This variable is relevant only if `backup-by-copying' is nil."
120 "Non-nil means create backups by copying if this preserves owner or group.
121 Renaming may still be used (subject to control of other variables)
122 when it would not result in changing the owner or group of the file;
123 that is, for files which are owned by you and whose group matches
124 the default for a new file created there by you.
125 This variable is relevant only if `backup-by-copying' is nil."
132 "Non-nil means create backups by copying to preserve a privileged owner.
133 Renaming may still be used (subject to control of other variables)
134 when it would not result in changing the owner of the file or if the owner
135 has a user id greater than the value of this variable. This is useful
136 when low-numbered uid's are used for special system users (such as root)
137 that must maintain ownership of certain files.
138 This variable is relevant only if `backup-by-copying' and
139 `backup-by-copying-when-mismatch' are nil."
144 "Predicate that looks at a file name and decides whether to make backups.
148 "Non-nil in a buffer means always offer to save buffer on exit.
149 Do so even if the buffer is not visiting a file.
150 Automatically local in all buffers."
156 "Non-nil means find a file under alternative names, in existing buffers.
157 This means if any existing buffer is visiting the file you want
158 under another name, you get the existing buffer instead of a new buffer."
163 "Non-nil means visit a file under its truename.
164 The truename of a file is found by chasing all links
165 both at the file level and at the levels of the containing directories."
171 "Specify which files should be reverted without query.
172 The value is a list of regular expressions.
173 If the file name matches one of these regular expressions,
174 then `revert-buffer' reverts the file without querying
175 if the file has changed on disk and you have not edited the buffer."
180 "The device number and file number of the file visited in the current buffer.
181 The value is a list of the form (FILENUM DEVNUM).
182 This pair of numbers uniquely identifies the file.
196 "The directory for writing small temporary files.
197 If non-nil, this directory is used instead of `temporary-file-directory'
198 by programs that create small temporary files. This is for systems that
199 have fast storage with limited space, such as a RAM disk."
204 ;; The system null device. (Should reference NULL_DEVICE from C.)
232 "Non-nil means protect against I/O errors while saving files.
233 Some modes set this non-nil in particular buffers.
235 This feature works by writing the new contents into a temporary file
236 and then renaming the temporary file to replace the original.
237 In this way, any I/O error in writing leaves the original untouched,
238 and there is never any instant where the file is nonexistent.
240 Note that this feature forces backups to be made by copying.
241 Yet, at the same time, saving a precious file
242 breaks any hard links between it and other files.
244 This feature is advisory: for example, if the directory in which the
245 file is being saved is not writable, Emacs may ignore a non-nil value
246 of `file-precious-flag' and write directly into the file.
248 See also: `break-hardlink-on-save'."
253 "Non-nil means when saving a file that exists under several names
254 \(i.e., has multiple hardlinks), break the hardlink associated with
255 `buffer-file-name' and write to a new file, so that the other
256 instances of the file are not affected by the save.
258 If `buffer-file-name' refers to a symlink, do not break the symlink.
260 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
261 For example, if the directory in which a file is being saved is not
262 itself writable, then error instead of saving in some
263 hardlink-nonbreaking way.
265 See also `backup-by-copying' and `backup-by-copying-when-linked'."
271 "Control use of version numbers for backup files.
272 When t, make numeric backup versions unconditionally.
273 When nil, make them for files that have some already.
274 The value `never' means do not make them."
284 "When cleaning directory, number of versions to keep."
290 "If t, delete excess backup versions silently.
291 If nil, ask confirmation. Any other value prevents any trimming."
298 "Number of oldest versions to keep when a new numbered backup is made."
304 "Number of newest versions to keep when a new numbered backup is made.
305 Includes the new backup. Must be > 0"
311 "Whether to add a newline automatically at the end of the file.
313 A value of t means do this only when the file is about to be saved.
314 A value of `visit' means do this right after the file is visited.
315 A value of `visit-save' means do it at both of those times.
316 Any other non-nil value means ask user whether to add a newline, when saving.
317 A value of nil means don't add newlines.
319 Certain major modes set this locally to the value obtained
320 from `mode-require-final-newline'."
329 "Whether to add a newline at end of file, in certain major modes.
330 Those modes set `require-final-newline' to this value when you enable them.
331 They do so because they are often used for files that are supposed
332 to end in newlines, and the question is how to arrange that.
334 A value of t means do this only when the file is about to be saved.
335 A value of `visit' means do this right after the file is visited.
336 A value of `visit-save' means do it at both of those times.
337 Any other non-nil value means ask user whether to add a newline, when saving.
339 A value of nil means do not add newlines. That is a risky choice in this
340 variable since this value is used for modes for files that ought to have
341 final newlines. So if you set this to nil, you must explicitly check and
342 add a final newline, whenever you save a file that really needs one."
352 "Non-nil says by default do auto-saving of every file-visiting buffer."
358 ;; Don't put "\\2" inside expand-file-name, since it will be
359 ;; transformed to "/2" on DOS/Windows.
361 "Transforms to apply to buffer file name before making auto-save file name.
362 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
363 REGEXP is a regular expression to match against the file name.
364 If it matches, `replace-match' is used to replace the
365 matching part with REPLACEMENT.
366 If the optional element UNIQUIFY is non-nil, the auto-save file name is
367 constructed by taking the directory part of the replaced file-name,
368 concatenated with the buffer file name with all directory separators
369 changed to `!' to prevent clashes. This will not work
370 correctly if your filesystem truncates the resulting name.
372 All the transforms in the list are tried, in the order they are listed.
373 When one transform applies, its result is final;
374 no further transforms are tried.
376 The default value is set up to put the auto-save file into the
377 temporary directory (see the variable `temporary-file-directory') for
378 editing a remote file.
380 On MS-DOS filesystems without long names this variable is always
381 ignored."
389 "Non-nil means save word abbrevs too when files are saved.
390 If `silently', don't ask the user before saving."
395 "Non-nil means allow `find-file' to visit directories.
396 To visit the directory, `find-file' runs `find-directory-functions'."
401 "List of functions to try in sequence to visit a directory.
402 Each function is called with the directory name as the sole argument
403 and should return either a buffer or nil."
407 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
409 "List of functions to try in sequence to get a file name at point.
410 Each function should return either nil or a file name found at the
411 location of point in the current buffer."
415 ;;;It is not useful to make this a local variable.
416 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
418 "List of functions to be called for `find-file' on nonexistent file.
419 These functions are called as soon as the error is detected.
420 Variable `buffer-file-name' is already set up.
425 ;;;It is not useful to make this a local variable.
426 ;;;(put 'find-file-hooks 'permanent-local t)
429 "List of functions to be called after a buffer is loaded from a file.
430 The buffer's local variables (if any) will have been processed before the
431 functions are called."
438 "List of functions to be called before writing out a buffer to a file.
439 If one of them returns non-nil, the file is considered already written
440 and the rest are not called.
441 These hooks are considered to pertain to the visited file.
442 So any buffer-local binding of this variable is discarded if you change
444 change the major mode.
446 This hook is not run if any of the functions in
447 `write-contents-functions' returns non-nil. Both hooks pertain
448 to how to save a buffer to file, for instance, choosing a suitable
449 coding system and setting mode bits. (See Info
450 node `(elisp)Saving Buffers'.) To perform various checks or
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 and neither are the functions in
464 `write-file-functions'.
466 This variable is meant to be used for hooks that pertain to the
467 buffer's contents, not to the particular visited file; thus,
468 `set-visited-file-name' does not clear this variable; but changing the
469 major mode does clear it.
471 For hooks that _do_ pertain to the particular visited file, use
472 `write-file-functions'. Both this variable and
473 `write-file-functions' relate to how a buffer is saved to file.
474 To perform various checks or updates before the buffer is saved,
481 "Control use of local variables in files you visit.
482 The value can be t, nil, :safe, :all, or something else.
484 A value of t means file local variables specifications are obeyed
485 if all the specified variable values are safe; if any values are
486 not safe, Emacs queries you, once, whether to set them all.
487 \(When you say yes to certain values, they are remembered as safe.)
489 :safe means set the safe variables, and ignore the rest.
490 :all means set all variables, whether safe or not.
491 (Don't set it permanently to :all.)
492 A value of nil means always ignore the file local variables.
494 Any other value means always query you once whether to set them all.
495 \(When you say yes to certain values, they are remembered as safe, but
498 This variable also controls use of major modes specified in
499 a -*- line.
502 always obeys file local variable specifications and the -*- line,
503 and ignores this variable."
504 :risky t
513 "Like `enable-local-variables' but meant for buffer-local bindings.
514 The meaningful values are nil and non-nil. The default is non-nil.
515 If a major mode sets this to nil, buffer-locally, then any local
516 variables list in the file will be ignored.
518 This variable does not affect the use of major modes
523 The value can be t, nil or something else.
524 A value of t means obey `eval' variables.
525 A value of nil means ignore them; anything else means query."
526 :risky t
532 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
541 "Non-nil means buffers visiting files read-only do so in view mode.
542 In fact, this means that all read-only buffers normally have
543 View mode enabled, including buffers that are read-only because
544 you visit a file you cannot alter, and buffers you make read-only
550 "History list of file names entered in the minibuffer.
552 Maximum length of the history list is determined by the value
554 \f
557 "Provides support for ange-ftp host name completion.
558 Runs the usual ange-ftp hook, but only for completion operations."
559 ;; Having this here avoids the need to load ange-ftp when it's not
560 ;; really in use.
566 inhibit-file-name-handlers)))
574 "Convert a standard file's name to something suitable for the OS.
575 This means to guarantee valid names and perhaps to canonicalize
576 certain patterns.
578 FILENAME should be an absolute file name since the conversion rules
579 sometimes vary depending on the position in the file name. E.g. c:/foo
580 is a valid DOS file name, but c:/bar/c:/foo is not.
582 This function's standard definition is trivial; it just returns
583 the argument. However, on Windows and DOS, replace invalid
584 characters. On DOS, make sure to obey the 8.3 limitations.
585 In the native Windows build, turn Cygwin names into native names,
586 and also turn slashes into backslashes if the shell requires it (see
587 `w32-shell-dos-semantics').
589 See Info node `(elisp)Standard File Names' for more details."
594 ;; Replace invalid filename characters with !
598 name))
606 "Read directory name, prompting with PROMPT and completing in directory DIR.
607 Value is not expanded---you must call `expand-file-name' yourself.
608 Default name to DEFAULT-DIRNAME if user exits with the same
609 non-empty string that was inserted by this function.
610 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
611 or just DIR if INITIAL is nil.)
612 If the user exits with an empty minibuffer, this function returns
613 an empty string. (This can only happen if the user erased the
614 pre-inserted contents or if `insert-default-directory' is nil.)
615 Fourth arg MUSTMATCH non-nil means require existing directory's name.
616 Non-nil and non-t means also require confirmation after completion.
617 Fifth arg INITIAL specifies text to start with.
618 DIR should be an absolute directory name. It defaults to
619 the value of `default-directory'."
624 dir))
625 mustmatch initial
628 \f
630 "Show the current default directory."
635 "Value of the CDPATH environment variable, as a list.
639 "Explode a search path into a list of directory names.
640 Directories are separated by occurrences of `path-separator'
641 \(which is colon in GNU and GNU-like systems)."
642 ;; We could use split-string here.
650 nil
655 cd-list)))
658 "Change current directory to given absolute file name DIR."
659 ;; Put the name into directory syntax now,
660 ;; because otherwise expand-file-name may give some bad results.
662 ;; We used to additionally call abbreviate-file-name here, for an
663 ;; unknown reason. Problem is that most buffers are setup
664 ;; without going through cd-absolute and don't call
665 ;; abbreviate-file-name on their default-directory, so the few that
666 ;; do end up using a superficially different directory.
678 "Make DIR become the current buffer's default directory.
679 If your environment includes a `CDPATH' variable, try each one of
680 that list of directories (separated by occurrences of
681 `path-separator') when resolving a relative directory name.
682 The path separator is colon in GNU and GNU-like systems."
685 default-directory default-directory
701 cd-path)
702 nil))
706 "Load the Lisp file named FILE."
707 ;; This is a case where .elc makes a lot of sense.
714 "Search for FILENAME through PATH.
715 If found, return the absolute file name of FILENAME, with its suffixes;
716 otherwise return nil.
717 PATH should be a list of directories to look in, like the lists in
718 `exec-path' or `load-path'.
719 If SUFFIXES is non-nil, it should be a list of suffixes to append to
722 If non-nil, PREDICATE is used instead of `file-readable-p'.
723 PREDICATE can also be an integer to pass to the `access' system call,
724 in which case file-name handlers are ignored. This usage is deprecated.
726 For compatibility, PREDICATE can also be one of the symbols
727 `executable', `readable', `writable', or `exists', or a list of
728 one or more of those symbols."
739 "Do completion for file names passed to `locate-file'."
742 ;; FIXME: maybe we should use completion-file-name-table instead,
743 ;; tho at least for `load', the arg is passed through
744 ;; substitute-in-file-name for historical reasons.
754 ;; If we have files like "foo.el" and "foo.elc", we could load one of
755 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
756 ;; preferred way. So if we list all 3, that gives a lot of redundant
757 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
758 ;; the user does want to pay attention to the extension. We try to
759 ;; diffuse this tension by stripping the suffix, except when the
760 ;; result is a single element (i.e. usually we only list "foo" unless
761 ;; it's the only remaining element in the list, in which case we do
762 ;; list "foo", "foo.elc" and "foo.el").
773 string-file dir))
778 ;; Switching from names to names+fullnames creates a non-monotonicity
779 ;; which can cause problems with things like partial-completion.
780 ;; To minimize the problem, filter out completion-regexp-list, so that
781 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
782 ;; from `names' which only matched `string' when they still had
783 ;; their suffix.
785 ;; Remove duplicates of the first element, so that we can easily check
786 ;; if `names' really only contains a single element.
789 ;; There's no more than one matching non-suffixed element, so expand
790 ;; the list by adding the suffixed elements as well.
793 string-dir names string-file pred action)))))
796 "Do completion for file names passed to `locate-file'.
797 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
800 string nil action))
805 "Regexp of directory names which stop the search in `locate-dominating-file'.
806 Any directory whose name matches this regexp will be treated like
807 a kind of root directory by `locate-dominating-file' which will stop its search
808 when it bumps into it.
809 The default regexp prevents fruitless and time-consuming attempts to find
810 special files in directories in which filenames are interpreted as hostnames,
813 ;; (defun locate-dominating-files (file regexp)
814 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
815 ;; Stop at the first parent where a matching file is found and return the list
816 ;; of files that that match in this directory."
817 ;; (catch 'found
818 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
819 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
820 ;; (let ((user nil)
821 ;; ;; Abbreviate, so as to stop when we cross ~/.
822 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
823 ;; files)
824 ;; (while (and dir
825 ;; ;; As a heuristic, we stop looking up the hierarchy of
826 ;; ;; directories as soon as we find a directory belonging to
827 ;; ;; another user. This should save us from looking in
828 ;; ;; things like /net and /afs. This assumes that all the
829 ;; ;; files inside a project belong to the same user.
830 ;; (let ((prev-user user))
831 ;; (setq user (nth 2 (file-attributes dir)))
832 ;; (or (null prev-user) (equal user prev-user))))
833 ;; (if (setq files (condition-case nil
834 ;; (directory-files dir 'full regexp 'nosort)
835 ;; (error nil)))
836 ;; (throw 'found files)
837 ;; (if (equal dir
838 ;; (setq dir (file-name-directory
839 ;; (directory-file-name dir))))
840 ;; (setq dir nil))))
841 ;; nil)))
844 "Look up the directory hierarchy from FILE for a file named NAME.
845 Stop at the first parent directory containing a file NAME,
846 and return the directory. Return nil if not found."
847 ;; We used to use the above locate-dominating-files code, but the
848 ;; directory-files call is very costly, so we're much better off doing
849 ;; multiple calls using the code in here.
850 ;;
851 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
852 ;; `name' in /home or in /.
856 ;; `user' is not initialized outside the loop because
857 ;; `file' may not exist, so we may have to walk up part of the
858 ;; hierarchy before we find the "initial UID".
860 try)
863 ;; FIXME: Disabled this heuristic because it is sometimes
864 ;; inappropriate.
865 ;; As a heuristic, we stop looking up the hierarchy of
866 ;; directories as soon as we find a directory belonging
867 ;; to another user. This should save us from looking in
868 ;; things like /net and /afs. This assumes that all the
869 ;; files inside a project belong to the same user.
870 ;; (let ((prev-user user))
871 ;; (setq user (nth 2 (file-attributes file)))
872 ;; (and prev-user (not (equal user prev-user))))
880 root))
884 "Search for COMMAND in `exec-path' and return the absolute file name.
885 Return nil if COMMAND is not found anywhere in `exec-path'."
886 ;; Use 1 rather than file-executable-p to better match the behavior of
887 ;; call-process.
891 "Load the Emacs Lisp library named LIBRARY.
892 This is an interface to the function `load'. LIBRARY is searched
893 for in `load-path', both with and without `load-suffixes' (as
894 well as `load-file-rep-suffixes').
896 See Info node `(emacs)Lisp Libraries' for more details.
897 See `load-file' for a different interface to `load'."
901 load-path
906 "Test whether FILE specifies a location on a remote system.
907 Returns nil or a string identifying the remote connection (ideally
908 a prefix of FILE). For example, the remote identification for filename
911 less reliable than accessing local files.
912 Furthermore, relative file names do not work across remote connections.
914 IDENTIFICATION specifies which part of the identification shall
915 be returned as string. IDENTIFICATION can be the symbol
916 `method', `user', `host' or `localname'; any other value is
917 handled like nil and means to return the complete identification
918 string.
920 If CONNECTED is non-nil, the function returns an identification only
921 if FILE is located on a remote system, and a connection is established
922 to that remote system.
924 `file-remote-p' will never open a connection on its own."
928 nil)))
931 "Whether to use the remote file-name cache for read access.
933 When `nil', always use the cached values.
934 When `t', never use them.
935 A number means use them for that amount of seconds since they were
936 cached.
938 File attributes of remote files are cached for better performance.
939 If they are changed out of Emacs' control, the cached values
940 become invalid, and must be invalidated.
942 In case a remote file is checked regularly, it might be
943 reasonable to let-bind this variable to a value less then the
944 time period between two checks.
945 Example:
947 \(defun display-time-file-nonempty-p \(file)
948 \(let \(\(remote-file-name-inhibit-cache \(- display-time-interval 5)))
949 \(and \(file-exists-p file)
950 \(< 0 \(nth 7 \(file-attributes \(file-chase-links file)))))))"
961 "Copy the file FILE into a temporary file on this machine.
962 Returns the name of the local copy, or nil, if FILE is directly
963 accessible."
964 ;; This formerly had an optional BUFFER argument that wasn't used by
965 ;; anything.
969 nil)))
972 "Return the truename of FILENAME, which should be absolute.
973 The truename of a file name is found by chasing symbolic links
974 both at the level of the file and at the level of the directories
975 containing it, until no links are left at any level.
978 ;; COUNTER and PREV-DIRS are only used in recursive calls.
979 ;; COUNTER can be a cons cell whose car is the count of how many
980 ;; more links to chase before getting an error.
981 ;; PREV-DIRS can be a cons cell whose car is an alist
982 ;; of truenames we've just recently computed.
996 ;; For speed, remove the ange-ftp completion handler from the list.
997 ;; We know it's not needed here.
998 ;; For even more speed, do this only on the outermost call.
1005 ;; andrewi@harlequin.co.uk - none of the following code (except for
1006 ;; invoking the file-name handler) currently applies on Windows
1007 ;; (ie. there are no native symlinks), but there is an issue with
1008 ;; case differences being ignored by the OS, and short "8.3 DOS"
1009 ;; name aliases existing for all files. (The short names are not
1010 ;; reported by directory-files, but can be used to refer to files.)
1011 ;; It seems appropriate for file-truename to resolve these issues in
1012 ;; the most natural way, which on Windows is to call the function
1013 ;; `w32-long-file-name' - this returns the exact name of a file as
1014 ;; it is stored on disk (expanding short name aliases with the full
1015 ;; name in the process).
1018 ;; For file name that has a special handler, call handler.
1019 ;; This is so that ange-ftp can save time by doing a no-op.
1022 ;; If filename contains a wildcard, newname will be the old name.
1024 ;; If filename exists, use the long name. If it doesn't exist,
1025 ;; drill down until we find a directory that exists, and use
1026 ;; the long name of that, with the extra non-existent path
1027 ;; components concatenated.
1029 missing rest)
1032 ;; Include the preceding directory separator in the missing
1033 ;; part so subsequent recursion on the rest works.
1038 ""
1043 ;; If this file directly leads to a link, process that iteratively
1044 ;; so that we don't use lots of stack.
1050 ;; For file name that has a special handler, call handler.
1051 ;; This is so that ange-ftp can save time by doing a no-op.
1054 done t)
1056 target dirfile)
1057 ;; Get the truename of the directory.
1059 ;; If these are equal, we have the (or a) root directory.
1061 ;; If this is the same dir we last got the truename for,
1062 ;; save time--don't recalculate.
1072 done t)
1075 done t)
1076 ;; Put it back on the file name.
1078 ;; Is the file name the name of a link?
1081 ;; Yes => chase that link, then start all over
1082 ;; since the link may point to a directory name that uses links.
1083 ;; We can't safely use expand-file-name here
1084 ;; since target might look like foo/../bar where foo
1085 ;; is itself a link. Instead, we handle . and .. above.
1088 target
1090 done nil)
1091 ;; No, we are done!
1093 filename))
1096 "Chase links in FILENAME until a name that is not a link.
1097 Unlike `file-truename', this does not check whether a parent
1098 directory name is a symbolic link.
1099 If the optional argument LIMIT is a number,
1100 it means chase no more than that many links and then stop."
1108 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1111 ;; Handle `..' by hand, since it needs to work in the
1112 ;; target of any directory symlink.
1113 ;; This code is not quite complete; it does not handle
1114 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1118 ;; Chase links in the default dir of the symlink.
1122 ;; Now find the parent of that dir.
1126 newname))
1129 "Create a temporary file.
1130 The returned file name (created by appending some random characters at the end
1131 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1132 is guaranteed to point to a newly created empty file.
1133 You can then use `write-region' to write new data into the file.
1135 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1137 If SUFFIX is non-nil, add that at the end of the file name."
1139 file)
1142 ;; Create temp files with strict access rights. It's easy to
1143 ;; loosen them later, whereas it's impossible to close the
1144 ;; time-window of loose permissions otherwise.
1152 temporary-file-directory)
1154 temporary-file-directory))))
1160 nil)
1162 ;; the file was somehow created by someone else between
1163 ;; `make-temp-name' and `write-region', let's try again.
1164 nil)
1165 file)
1166 ;; Reset the umask.
1170 "Change the encoding of FILE's name from CODING to NEW-CODING.
1171 The value is a new name of FILE.
1172 Signals a `file-already-exists' error if a file of the new name
1173 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1174 is non-nil. A number as fourth arg means request confirmation if
1175 the new name already exists. This is what happens in interactive
1176 use with M-x."
1179 default-file-name-coding-system))
1181 from-coding to-coding)
1183 ;; We provide the default coding only when it seems that
1184 ;; the filename is correctly decoded by the default
1185 ;; coding.
1191 filename default-coding)
1192 default-coding))
1196 ;; We provide the default coding only when a user is going to
1197 ;; change the encoding not from the default coding.
1201 filename from-coding)))
1204 filename from-coding default-coding)
1205 default-coding)))
1209 default-file-name-coding-system))
1210 ;; FILE should have been decoded by DEFAULT-CODING.
1214 ;; Suppress further encoding.
1219 newname))
1220 \f
1222 "Whether confirmation is requested before visiting a new file or buffer.
1223 If nil, confirmation is not requested.
1224 If the value is `after-completion', confirmation is only
1225 requested if the user called `minibuffer-complete' right before
1226 `minibuffer-complete-and-exit'.
1227 Any other non-nil value means to request confirmation.
1229 This affects commands like `switch-to-buffer' and `find-file'."
1237 "Whether to request confirmation before visiting a new file or buffer.
1238 The variable `confirm-nonexistent-file-or-buffer' determines the
1239 return value, which may be passed as the REQUIRE-MATCH arg to
1240 `read-buffer' or `find-file-read-args'."
1248 "Read the name of a buffer to switch to and return as a string.
1249 It is intended for `switch-to-buffer' family of commands since they
1250 need to omit the name of current buffer from the list of completions
1251 and default values."
1256 ;; Since rbts-completion-table is built dynamically, we
1257 ;; can't just add it to the default value of
1258 ;; icomplete-with-completion-tables, so we add it
1259 ;; here manually.
1264 icomplete-with-completion-tables))))
1269 "Select the buffer specified by BUFFER-OR-NAME in another window.
1270 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1271 nil. Return the buffer switched to.
1273 If called interactively, prompt for the buffer name using the
1274 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1275 determines whether to request confirmation before creating a new
1276 buffer.
1278 If BUFFER-OR-NAME is a string and does not identify an existing
1279 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1280 nil, switch to the buffer returned by `other-buffer'.
1282 Optional second argument NORECORD non-nil means do not put this
1283 buffer at the front of the list of recently selected ones.
1285 This uses the function `display-buffer' as a subroutine; see its
1286 documentation for additional customization information."
1290 same-window-buffer-names same-window-regexps)
1294 "Switch to buffer BUFFER-OR-NAME in another frame.
1295 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1296 nil. Return the buffer switched to.
1298 If called interactively, prompt for the buffer name using the
1299 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1300 determines whether to request confirmation before creating a new
1301 buffer.
1303 If BUFFER-OR-NAME is a string and does not identify an existing
1304 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1305 nil, switch to the buffer returned by `other-buffer'.
1307 Optional second arg NORECORD non-nil means do not put this
1308 buffer at the front of the list of recently selected ones.
1310 This uses the function `display-buffer' as a subroutine; see its
1311 documentation for additional customization information."
1315 same-window-buffer-names same-window-regexps)
1319 "Display buffer BUFFER in another frame.
1320 This uses the function `display-buffer' as a subroutine; see
1321 its documentation for additional customization information."
1324 same-window-buffer-names same-window-regexps
1326 new-window)
1328 ;; This may have been here in order to prevent the new frame from hiding
1329 ;; the old frame. But it does more harm than good.
1330 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1331 ;;(lower-frame (window-frame new-window))
1333 ;; This may have been here in order to make sure the old-frame gets the
1334 ;; focus. But not only can it cause an annoying flicker, with some
1335 ;; window-managers it just makes the window invisible, with no easy
1336 ;; way to recover it. --Stef
1337 ;;(make-frame-invisible (window-frame old-window))
1338 ;;(make-frame-visible (window-frame old-window))
1339 ))
1342 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1343 BODY should use the minibuffer at most once.
1344 Recursive uses of the minibuffer are unaffected (FUN is not
1345 called additional times).
1347 This macro actually adds an auxiliary function that calls FUN,
1348 rather than FUN itself, to `minibuffer-setup-hook'."
1354 ;; Clear out this hook so it does not interfere
1355 ;; with any recursive minibuffer usage.
1366 t))
1369 "Edit file FILENAME.
1370 Switch to a buffer visiting file FILENAME,
1371 creating one if none already exists.
1372 Interactively, the default if you just type RET is the current directory,
1373 but the visited file name is available through the minibuffer history:
1374 type M-n to pull it into the minibuffer.
1376 You can visit files on remote machines by specifying something
1377 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1378 also visit local files as a different user by specifying
1379 /sudo::FILE for the file name.
1380 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1381 manual, for more about this.
1383 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1384 expand wildcards (if any) and visit multiple files. You can
1385 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1387 To visit a file without any kind of conversion and without
1398 "Edit file FILENAME, in another window.
1401 an existing one. See the function `display-buffer'.
1403 Interactively, the default if you just type RET is the current directory,
1404 but the visited file name is available through the minibuffer history:
1405 type M-n to pull it into the minibuffer.
1407 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1408 expand wildcards (if any) and visit multiple files."
1421 "Edit file FILENAME, in another frame.
1424 an existing one. See the function `display-buffer'.
1426 Interactively, the default if you just type RET is the current directory,
1427 but the visited file name is available through the minibuffer history:
1428 type M-n to pull it into the minibuffer.
1430 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1431 expand wildcards (if any) and visit multiple files."
1444 "Edit the existing file FILENAME.
1446 file names with wildcards."
1455 "Edit file FILENAME but don't allow changes.
1469 value))
1472 "Edit file FILENAME in another window but don't allow changes.
1486 value))
1489 "Edit file FILENAME in another frame but don't allow changes.
1503 value))
1506 "Find file FILENAME as a replacement for the file in the next window.
1507 This command does not select that window.
1511 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1512 expand wildcards (if any) and replace the file with multiple files."
1523 "Find alternate file: " file-dir nil
1525 t))))
1533 "Find file FILENAME, select its buffer, kill previous buffer.
1534 If the current buffer now contains an empty file that you just visited
1535 \(presumably by mistake), use this command to visit the file you really want.
1539 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1540 expand wildcards (if any) and replace the file with multiple files.
1542 If the current buffer is an indirect buffer, or the base buffer
1543 for one or more indirect buffers, the other buffer(s) are not
1544 killed."
1553 "Find alternate file: " file-dir nil
1555 t)))
1570 ;; Run `kill-buffer-hook' here. It needs to happen before
1571 ;; variables like `buffer-file-name' etc are set to nil below,
1572 ;; because some of the hooks that could be invoked
1573 ;; (e.g., `save-place-to-alist') depend on those variables.
1574 ;;
1575 ;; Note that `kill-buffer-hook' is not what queries whether to
1576 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1577 ;; asks that itself. Thus, there's no need to temporarily do
1578 ;; `(set-buffer-modified-p nil)' before running this hook.
1580 ;; Okay, now we can end-of-life the old buffer.
1587 ;; This prevents us from finding the same buffer
1588 ;; if we specified the same file again.
1592 ;; Likewise for dired buffers.
1596 ;; This executes if find-file gets an error
1597 ;; and does not really find anything.
1598 ;; We put things back as they were.
1599 ;; If find-file actually finds something, we kill obuf below.
1608 ;; We already ran these; don't run them again.
1611 \f
1613 "Create a suitably named buffer for visiting FILENAME, and return it.
1614 FILENAME (sans directory) is used unchanged if that name is free;
1615 otherwise a string <2> or <3> or ... is appended to get an unused name.
1616 Spaces at the start of FILENAME (sans directory) are removed."
1625 "Create and return a buffer with a name based on NAME.
1626 Choose the buffer's name using `generate-new-buffer-name'."
1630 "Regexp to match the automounter prefix in a directory name."
1638 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1640 home directory is a root directory) and removes automounter prefixes
1641 \(see the variable `automount-dir-prefix')."
1642 ;; Get rid of the prefixes added by the automounter.
1649 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1650 ;; To fix this right, we need a `file-name-case-sensitive-p'
1651 ;; function, but we don't have that yet, so just guess.
1654 ;; If any elt of directory-abbrev-alist matches this name,
1655 ;; abbreviate accordingly.
1661 ;; Compute and save the abbreviated homedir name.
1662 ;; We defer computing this until the first time it's needed, to
1663 ;; give time for directory-abbrev-alist to be set properly.
1664 ;; We include a slash at the end, to avoid spurious matches
1665 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1672 ;; If FILENAME starts with the abbreviated homedir,
1673 ;; make it start with `~' instead.
1675 ;; If the home dir is just /, don't change it.
1678 ;; MS-DOS root directories can come with a drive letter;
1679 ;; Novell Netware allows drive letters beyond `Z:'.
1687 filename)))
1690 "List of logical names for which visiting shouldn't save the true dirname."
1695 "Return the buffer visiting file FILENAME (a string).
1696 This is like `get-file-buffer', except that it checks for any buffer
1697 visiting the same file, possibly under a different name.
1698 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1699 and others are ignored.
1700 If there is no such live buffer, return nil."
1713 found)
1723 ;; Verify this buffer's file number
1724 ;; still belongs to its file.
1727 attributes)
1731 found))))
1732 \f
1734 "Non-nil means file-visiting commands should handle wildcards.
1735 For example, if you specify `*.c', that would visit all the files
1736 whose names match the pattern."
1742 "Non-nil means suppress warning messages for symlinked files.
1743 When nil, Emacs prints a warning when visiting a file that is already
1744 visited, but with a different name. Setting this option to t
1745 suppresses this warning."
1751 "Maximum size of file above which a confirmation is requested.
1752 When nil, never request confirmation."
1759 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1760 OP-TYPE specifies the file operation being performed (for message to user)."
1769 "Read file FILENAME into a buffer and return the buffer.
1770 If a buffer exists visiting FILENAME, return that one, but
1771 verify that the file has not changed since visited or saved.
1772 The buffer is not selected, just returned to the caller.
1773 Optional second arg NOWARN non-nil means suppress any warning messages.
1774 Optional third arg RAWFILE non-nil means the file is read literally.
1775 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1776 and visit all the matching files. When wildcards are actually
1777 used and expanded, return a list of buffers that are visiting
1778 the various files."
1785 'find-directory-functions
1788 filename)))
1791 find-file-wildcards
1805 ;; Find any buffer for a file which has same truename.
1807 ;; Let user know if there is a buffer with the same truename.
1811 find-file-suppress-same-file-warnings
1815 ;; Optionally also find that buffer.
1818 ;; Check to see if the file looks uncommonly large.
1822 ;; We are using an existing buffer.
1829 ;; Certain files should be reverted automatically
1830 ;; if they have changed on disk and not in the buffer.
1838 found))
1848 "File %s changed on disk. Discard your edits? "
1853 "File %s changed on disk. Discard your edits in %s? "
1861 ;; Check if a formerly read-only file has become
1862 ;; writable and vice versa, but if the buffer agrees
1863 ;; with the new state of the file, that is ok too.
1871 buffer-file-name
1880 ;; It is confusing to ask whether to visit
1881 ;; non-literally if they have the file in
1882 ;; hexl-mode.
1888 "The file %s is already visited normally,
1889 and you have edited the buffer. Now you have asked to visit it literally,
1890 meaning no coding system handling, format conversion, or local variables.
1891 Emacs can only visit a file in one way at a time.
1893 Do you want to save the file, and visit it literally instead? "
1894 "The file %s is already visited literally,
1895 meaning no coding system handling, format conversion, or local variables.
1896 You have edited the buffer. Now you have asked to visit the file normally,
1897 but Emacs can only visit a file in one way at a time.
1904 rawfile truename number))
1908 "\
1909 Do you want to discard your changes, and visit the file literally now? "
1910 "\
1913 rawfile truename number)
1919 "The file %s is already visited normally.
1920 You have asked to visit it literally,
1921 meaning no coding system decoding, format conversion, or local variables.
1922 But Emacs can only visit a file in one way at a time.
1924 Do you want to revisit the file literally now? "
1925 "The file %s is already visited literally,
1926 meaning no coding system decoding, format conversion, or local variables.
1927 You have asked to visit it normally,
1928 but Emacs can only visit a file in one way at a time.
1933 rawfile truename number)
1936 ;; Return the buffer we are using.
1937 buf)
1938 ;; Create a new buffer.
1940 ;; find-file-noselect-1 may use a different buffer.
1942 rawfile truename number))))))
1948 ;; Needed in case we are re-visiting the file with a different
1949 ;; text representation.
1966 filename)))
1967 ;; Unconditionally set error
1977 filename)))
1978 ;; Run find-file-not-found-functions until one returns non-nil.
1980 ;; If they fail too, set error.
1982 ;; Record the file's truename, and maybe use that as visited name.
1990 ;; Set buffer's default directory to that of the file.
1992 ;; Turn off backup files for certain file names. Since
1993 ;; this is a permanent local, the major mode won't eliminate it.
2008 \f
2010 "Like `insert-file-contents', but only reads in the file literally.
2011 A buffer may be modified in several ways after reading into the buffer,
2012 to Emacs features such as format decoding, character code
2013 conversion, `find-file-hook', automatic uncompression, etc.
2015 This function ensures that none of these modifications will take place."
2023 nil))
2026 inhibit-file-name-handlers))
2039 filename)))
2040 ;; Check whether the file is uncommonly large
2051 "Insert contents of file FILENAME into buffer after point with no conversion.
2053 This function is meant for the user to run interactively.
2054 Don't call it from programs! Use `insert-file-contents-literally' instead.
2055 \(Its calling sequence is different; see its documentation)."
2060 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2065 "Visit file FILENAME with no conversion of any kind.
2066 Format conversion and character code conversion are both disabled,
2067 and multibyte characters are disabled in the resulting buffer.
2068 The major mode used is Fundamental mode regardless of the file name,
2069 and local variable specifications in the file are ignored.
2070 Automatic uncompression and adding a newline at the end of the
2071 file due to `require-final-newline' is also disabled.
2073 You cannot absolutely rely on this function to result in
2074 visiting the file literally. If Emacs already has a buffer
2075 which is visiting the file, you get the existing buffer,
2076 regardless of whether it was created literally or not.
2078 In a Lisp program, if you want to be sure of accessing a file's
2079 contents literally, you should create a temporary buffer and then read
2080 the file contents into it using `insert-file-contents-literally'."
2083 "Find file literally: " nil default-directory
2086 \f
2090 after-find-file-from-revert-buffer
2091 nomodes)
2092 "Called after finding a file and by the default revert function.
2093 Sets buffer mode, parses local variables.
2094 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2095 error in reading the file. WARN non-nil means warn if there
2096 exists an auto-save file more recent than the visited file.
2097 NOAUTO means don't mess with auto-save mode.
2098 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2099 means this call was from `revert-buffer'.
2100 Fifth arg NOMODES non-nil means don't alter the file's modes.
2101 Finishes by calling the functions in `find-file-hook'
2102 unless NOMODES is non-nil."
2105 nil
2115 ;; No need to warn if buffer is auto-saved
2116 ;; under the name of the visited file.
2118 auto-save-visited-file-name))
2121 buffer-file-name))
2141 ;; Make people do a little extra work (C-x C-q)
2142 ;; before altering a backup file.
2145 ;; When a file is marked read-only,
2146 ;; make the buffer read-only even if root is looking at it.
2154 ;; If requested, add a newline at the end of the file.
2164 view-read-only
2170 "Eval BODY and turn any error into a FORMAT message.
2171 FORMAT can have a %s escape which will be replaced with the actual error.
2172 If `debug-on-error' is set, errors are not caught, so that you can
2173 debug them.
2174 Avoid using a large BODY since it is duplicated."
2183 "Choose the major mode for this buffer automatically.
2184 Also sets up any specified local variables of the file.
2185 Uses the visited file name, the -*- line, and the local variables spec.
2187 This function is called automatically from `find-file'. In that case,
2188 we may set up the file-specified mode and local variables,
2189 depending on the value of `enable-local-variables'.
2190 In addition, if `local-enable-local-variables' is nil, we do
2191 not set local variables (though we do notice a mode specified with -*-.)
2193 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2194 or from Lisp without specifying the optional argument FIND-FILE;
2195 in that case, this function acts as if `enable-local-variables' were t."
2203 ;; Turn font lock off and on, to make sure it takes account of
2204 ;; whatever file local variables are relevant to it.
2206 ;; Font-lock-mode (now in font-core.el) can be ON when
2207 ;; font-lock.el still hasn't been loaded.
2217 "Non-nil means to try second pass through `auto-mode-alist'.
2218 This means that if the first case-sensitive search through the alist fails
2219 to find a matching major mode, a second case-insensitive search is made.
2220 On systems with case-insensitive file names, this variable is ignored,
2221 since only a single case-insensitive search through the alist is made."
2227 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2228 ;; c++-mode, java-mode and more) are added through autoload
2229 ;; directives in that file. That way is discouraged since it
2230 ;; spreads out the definition of the initial value.
2274 ;; Less common extensions come here
2275 ;; so more common ones above are found faster.
2283 ;; Besides .gdbinit, gdb documents other names to be usable for init
2284 ;; files, cross-debuggers can use something like
2285 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2286 ;; don't interfere with each other.
2324 ;; The list of archive file extensions should be in sync with
2325 ;; `auto-coding-alist' with `no-conversion' coding system.
2331 ;; Mailer puts message to be edited in
2332 ;; /tmp/Re.... or Message
2335 ;; some news reader is reported to use this
2345 ;; .emacs or .gnus or .viper following a directory delimiter in
2346 ;; Unix, MSDOG or VMS syntax.
2349 ;; _emacs following a directory delimiter
2350 ;; in MsDos syntax
2354 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2355 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2356 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2359 ;; .xs is also used for ld scripts, but seems to be more commonly
2360 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2362 ;; Explained in binutils ld/genscripts.sh. Eg:
2363 ;; A .x script file is the default script.
2364 ;; A .xr script is for linking without relocation (-r flag). Etc.
2368 ;; Common Lisp ASDF package system.
2375 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2386 ;; Windows candidates may be opened case sensitively on Unix
2392 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2394 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2395 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2396 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2397 ;; this has lower priority to avoid matching changelog.sgml etc.
2399 ;; either user's dot-files or under /etc or some such
2401 ;; alas not all ~/.*rc files are like this
2402 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2407 ;; this contains everything twice, with space and with colon :-(
2409 ;; Get rid of any trailing .n.m and try again.
2410 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2411 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2412 ;; Using mode nil rather than `ignore' would let the search continue
2413 ;; through this list (with the shortened name) rather than start over.
2415 ;; The following should come after the ChangeLog pattern
2416 ;; for the sake of ChangeLog.1, etc.
2417 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2420 "Alist of filename patterns vs corresponding major mode functions.
2421 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2422 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2423 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2424 mode function to use. FUNCTION will be called, unless it is nil.
2426 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2427 calling FUNCTION (if it's not nil), we delete the suffix that matched
2428 REGEXP and search the list again for another match.
2430 If the file name matches `inhibit-first-line-modes-regexps',
2431 then `auto-mode-alist' is not processed.
2433 The extensions whose FUNCTION is `archive-mode' should also
2434 appear in `auto-coding-alist' with `no-conversion' coding system.
2436 See also `interpreter-mode-alist', which detects executable script modes
2437 based on the interpreters they specify to run,
2442 "Select Conf mode or XML mode according to start of file."
2452 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2453 ;; and pike-mode) are added through autoload directives in that
2454 ;; file. That way is discouraged since it spreads out the
2455 ;; definition of the initial value.
2494 "Alist mapping interpreter names to major modes.
2495 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2496 Each element looks like (INTERPRETER . MODE).
2497 If INTERPRETER matches the name of the interpreter specified in the first line
2498 of a script, mode MODE is enabled.
2506 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2507 When checking `inhibit-first-line-modes-regexps', we first discard
2513 "Regexp matching interpreters, for file mode determination.
2514 This regular expression is matched against the first line of a file
2515 to determine the file's mode in `set-auto-mode'. If it matches, the file
2516 is assumed to be interpreted by the interpreter matched by the second group
2517 of the regular expression. The mode is then determined as the mode
2521 "Alist of buffer beginnings vs. corresponding major mode functions.
2522 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2523 After visiting a file, if REGEXP matches the text at the beginning of the
2524 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2525 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2526 major mode.
2528 If FUNCTION is nil, then it is not called. (That is a way of saying
2536 ;; The < comes before the groups (but the first) to reduce backtracking.
2537 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2538 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2542 comment-re "*"
2545 . html-mode)
2547 ;; These two must come after html, because they are more general:
2552 . sgml-mode)
2555 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2556 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2557 After visiting a file, if REGEXP matches the text at the beginning of the
2558 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2559 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2560 have not specified a mode for this file.
2566 "Upper limit on `magic-mode-alist' regexp matches.
2570 "Select major mode appropriate for current buffer.
2572 To find the right major mode, this function checks for a -*- mode tag,
2573 checks if it uses an interpreter listed in `interpreter-mode-alist',
2574 matches the buffer beginning against `magic-mode-alist',
2575 compares the filename against the entries in `auto-mode-alist',
2576 then matches the buffer beginning against `magic-fallback-mode-alist'.
2578 It does not check for the `mode:' local variable in the
2579 Local Variables section of the file; for that, use `hack-local-variables'.
2581 If `enable-local-variables' is nil, this function does not check for a
2582 -*- mode tag.
2584 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2585 set the major mode only if that would change it. In other words
2586 we don't actually set it to the same mode the buffer already has."
2587 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2589 ;; Find a -*- mode tag
2596 ;; Find all specifications for the `mode:' variable
2597 ;; and execute them left to right.
2609 modes)))
2610 ;; Simple -*-MODE-*- case.
2613 modes))))
2614 ;; If we found modes to use, invoke them now, outside the save-excursion.
2622 ;; continuing would call minor modes again, toggling them off
2624 ;; If we didn't, look for an interpreter specified in the first line.
2625 ;; As a special case, allow for things like "#!/bin/env perl", which
2626 ;; finds the interpreter anywhere in $PATH.
2633 ;; Map interpreter name to a mode, signalling we're done at the
2634 ;; same time.
2636 interpreter-mode-alist))
2637 ;; If we found an interpreter mode to use, invoke it now.
2640 ;; Next try matching the buffer beginning against magic-mode-alist.
2654 ;; Next compare the filename against the entries in auto-mode-alist.
2659 ;; Remove remote file name identification.
2663 ;; Remove backup-suffixes from file name.
2666 ;; Find first matching alist entry.
2669 ;; System is case-insensitive.
2673 ;; System is case-sensitive.
2675 ;; First match case-sensitively.
2679 ;; Fallback to case-insensitive match.
2693 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2708 ;; When `keep-mode-if-same' is set, we are working on behalf of
2709 ;; set-visited-file-name. In that case, if the major mode specified is the
2710 ;; same one we already have, don't actually reset it. We don't want to lose
2711 ;; minor modes such as Font Lock.
2713 "Apply MODE and return it.
2714 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2715 any aliases and compared to current major mode. If they are the
2716 same, do nothing and return nil."
2722 mode)))
2725 "Find the -*- spec in the buffer.
2726 Call with point at the place to start searching from.
2727 If one is found, set point to the beginning
2728 and return the position of the end.
2729 Otherwise, return nil; point may be changed."
2732 ;; Don't look for -*- if this file name matches any
2733 ;; of the regexps in inhibit-first-line-modes-regexps.
2741 sufs)
2749 ;; If the file begins with "#!"
2750 ;; (exec interpreter magic), look
2751 ;; for mode frobs in the first two
2752 ;; lines. You cannot necessarily
2753 ;; put them in the first line of
2754 ;; such a file without screwing up
2755 ;; the interpreter invocation.
2756 ;; The same holds for
2757 ;; '\"
2758 ;; in man pages (preprocessor
2759 ;; magic for the `man' program).
2770 end))))
2771 \f
2772 ;;; Handling file local variables
2776 file-local-variables-alist dir-local-variables-alist)
2781 "Normal hook run after processing a file's local variables specs.
2782 Major modes can use this to examine user-specified local variables
2786 "List variable-value pairs that are considered safe.
2787 Each element is a cons cell (VAR . VAL), where VAR is a variable
2788 symbol and VAL is a value that is considered safe."
2789 :risky t
2796 "Expressions that are considered safe in an `eval:' local variable.
2797 Add expressions to this list if you want Emacs to evaluate them, when
2798 they appear in an `eval' local variable specification, without first
2799 asking you for confirmation."
2800 :risky t
2805 ;; Risky local variables:
2808 buffer-auto-save-file-name
2809 buffer-file-name
2810 buffer-file-truename
2811 buffer-undo-list
2812 debugger
2813 default-text-properties
2814 eval
2815 exec-directory
2816 exec-path
2817 file-name-handler-alist
2818 frame-title-format
2819 global-mode-string
2820 header-line-format
2821 icon-title-format
2822 inhibit-quit
2823 load-path
2824 max-lisp-eval-depth
2825 max-specpdl-size
2826 minor-mode-map-alist
2827 minor-mode-overriding-map-alist
2828 mode-line-format
2829 mode-name
2830 overriding-local-map
2831 overriding-terminal-local-map
2832 process-environment
2833 standard-input
2834 standard-output
2835 unread-command-events))
2837 ;; Safe local variables:
2838 ;;
2839 ;; For variables defined by major modes, the safety declarations can go into
2840 ;; the major mode's file, since that will be loaded before file variables are
2841 ;; processed.
2842 ;;
2843 ;; For variables defined by minor modes, put the safety declarations in the
2844 ;; file defining the minor mode after the defcustom/defvar using an autoload
2845 ;; cookie, e.g.:
2846 ;;
2847 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2848 ;;
2849 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2850 ;; minor mode file may not be loaded yet.
2851 ;;
2852 ;; For variables defined in the C source code the declaration should go here:
2873 "Alist of file-local variable settings in the current buffer.
2874 Each element in this list has the form (VAR . VALUE), where VAR
2875 is a file-local variable (a symbol) and VALUE is the value
2876 specified. The actual value in the buffer may differ from VALUE,
2882 "Alist of directory-local variable settings in the current buffer.
2883 Each element in this list has the form (VAR . VALUE), where VAR
2884 is a directory-local variable (a symbol) and VALUE is the value
2885 specified in .dir-locals.el. The actual value in the buffer
2886 may differ from VALUE, if it is changed by the major or minor modes,
2891 "Normal hook run before setting file-local variables.
2892 It is called after checking for unsafe/risky variables and
2893 setting `file-local-variables-alist', and before applying the
2894 variables stored in `file-local-variables-alist'. A hook
2895 function is allowed to change the contents of this alist.
2897 This hook is called only if there is at least one file-local
2901 "Get confirmation before setting up local variable values.
2902 ALL-VARS is the list of all variables to be set up.
2903 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2904 RISKY-VARS is the list of those that are marked as risky.
2905 DIR-NAME is a directory name if these settings come from
2906 directory-local variables, or nil otherwise."
2908 nil
2915 unsafe-vars))
2919 prompt char)
2927 ", and variables that are risky (**)."
2935 y -- to apply the local variables list.
2939 ! -- to apply the local variables list, and permanently mark these
2951 ;; Make strings with embedded whitespace easier to read.
2959 ""
2974 ;; When this is called from desktop-restore-file-buffer,
2975 ;; coding-system-for-read may be non-nil. Reset it before
2976 ;; writing to .emacs.
2980 'safe-local-variable-values
2981 safe-local-variable-values))))
2985 "Return local variables specified in the -*- line.
2986 Ignore any specification for `mode:' and `coding:';
2987 `set-auto-mode' should already have handled `mode:',
2988 `set-auto-coding' should already have handled `coding:'.
2990 If MODE-ONLY is non-nil, all we do is check whether the major
2991 mode is specified, returning t if it is specified. Otherwise,
2992 return an alist of elements (VAR . VAL), where VAR is a variable
2993 and VAL is the specified value."
2997 result mode-specified)
2998 ;; Parse the -*- line into the RESULT alist.
2999 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
3001 nil)
3003 ;; Simple form: "-*- MODENAME -*-". Already handled.
3005 nil)
3007 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3008 ;; (last ";" is optional).
3013 ;; There used to be a downcase here,
3014 ;; but the manual didn't say so,
3015 ;; and people want to set var names that aren't all lc.
3021 ;; It is traditional to ignore
3022 ;; case when checking for `mode' in set-auto-mode,
3023 ;; so we must do that here as well.
3024 ;; That is inconsistent, but we're stuck with it.
3025 ;; The same can be said for `coding' in set-auto-coding.
3031 'eval
3038 mode-specified
3039 result))))
3042 "Filter local variable settings, querying the user if necessary.
3043 VARIABLES is the alist of variable-value settings. This alist is
3044 filtered based on the values of `ignored-local-variables',
3045 `enable-local-eval', `enable-local-variables', and (if necessary)
3046 user interaction. The results are added to
3047 `file-local-variables-alist', without applying them.
3048 DIR-NAME is a directory name if these settings come from
3049 directory-local variables, or nil otherwise."
3050 ;; Find those variables that we may want to save to
3051 ;; `safe-local-variable-values'.
3057 ;; Ignore any variable in `ignored-local-variables'.
3058 nil)
3059 ;; Obey `enable-local-eval'.
3067 ;; Ignore duplicates (except `mode') in the present list.
3069 ;; Accept known-safe variables.
3073 ;; The variable is either risky or unsafe:
3080 ;; Query, unless all vars are safe or user wants no querying.
3086 risky-vars dir-name))
3097 "Parse and put into effect this buffer's local variables spec.
3098 If MODE-ONLY is non-nil, all we do is check whether the major mode
3099 is specified, returning t if it is specified."
3102 result)
3109 ;; Look for "Local variables:" line in last page.
3117 ;; suffix is what comes after "local variables:" in its line.
3118 ;; prefix is what comes before "local variables:" in its line.
3128 beg)
3132 endpos
3138 nil t))
3139 ;; This used to be an error, but really all it means is
3140 ;; that this may simply not be a local-variables section,
3141 ;; so just ignore it.
3151 ;; Discard the prefix.
3156 ;; Discard the suffix.
3164 ;; Find the variable name; strip whitespace.
3173 val)
3174 ;; Read the variable value.
3185 'eval
3190 ;; Now we've read all the local variables.
3191 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3193 ;; Otherwise, set the variables.
3200 ;; Any 'evals must run in the Right sequence.
3209 "Non-nil if SYM is safe as a file-local variable with value VAL.
3210 It is safe if any of these conditions are met:
3212 * There is a matching entry (SYM . VAL) in the
3213 `safe-local-variable-values' user option.
3215 * The `safe-local-variable' property of SYM is a function that
3216 evaluates to a non-nil value with VAL as an argument."
3220 ;; If the function signals an error, that means it
3221 ;; can't assure us that the value is safe.
3225 "Non-nil if SYM could be dangerous as a file-local variable.
3226 It is dangerous if either of these conditions are met:
3228 * Its `risky-local-variable' property is non-nil.
3234 ;; If this is an alias, check the base name.
3254 "Return t if it is safe to eval EXP when it is found in a file."
3256 ;; Detect certain `put' expressions.
3263 lisp-indent-function
3264 scheme-indent-function))
3265 ;; Only allow safe values (not functions).
3270 ;; Only allow indirect form specs.
3271 ;; During bootstrapping, edebug-basic-spec might not be
3272 ;; defined yet.
3276 ;; Allow expressions that the user requested.
3278 ;; Certain functions can be allowed with safe arguments
3279 ;; or can specify verification functions to try.
3287 ok))
3295 ok)))))))
3298 "Set local variable VAR with value VAL.
3299 If VAR is `mode', call `VAL-mode' as a function unless it's
3300 already the major mode."
3307 ;; A minor mode must be passed an argument.
3308 ;; Otherwise, if the user enables the minor mode in a
3309 ;; major mode hook, this would toggle it off.
3315 ;; Make sure the string has no text properties.
3316 ;; Some text properties can get evaluated in various ways,
3317 ;; so it is risky to put them on with a local variable list.
3321 \f
3322 ;;; Handling directory-local variables, aka project settings.
3328 "List of cached directory roots for directory-local variable classes.
3329 Each element in this list has the form (DIR CLASS MTIME).
3330 DIR is the name of the directory.
3331 CLASS is the name of a variable class (a symbol).
3332 MTIME is the recorded modification time of the directory-local
3333 variables file associated with this entry. This time is a list
3334 of two integers (the same format as `file-attributes'), and is
3335 used to test whether the cache entry is still valid.
3336 Alternatively, MTIME can be nil, which means the entry is always
3340 "Return the variable list for CLASS."
3344 "Collect directory-local variables from MODE-VARIABLES.
3345 VARIABLES is the initial list of variables.
3346 Returns the new list."
3351 ;; If variables are specified more than once, only use the last. (Why?)
3352 ;; The pseudo-variables mode and eval are different (bug#3430).
3355 ;; Need a new cons in case we setcdr later.
3359 "Collect entries from CLASS-VARIABLES into VARIABLES.
3360 ROOT is the root directory of the project.
3361 Return the new variables list."
3364 ;; FIXME: Why not use file-relative-name?
3371 ;; Don't include this in the previous condition, because we
3372 ;; want to filter all strings before the next condition.
3383 ;; The file's content might be invalid (e.g. have a merge conflict), but
3384 ;; that shouldn't prevent the user from opening the file.
3386 nil))))
3389 "Declare that the DIRECTORY root is an instance of CLASS.
3390 DIRECTORY is the name of a directory, a string.
3391 CLASS is the name of a project class, a symbol.
3392 MTIME is either the modification time of the directory-local
3393 variables file that defined this class, or nil.
3395 When a file beneath DIRECTORY is visited, the mode-specific
3396 variables from CLASS are applied to the buffer. The variables
3397 for a class are defined using `dir-locals-set-class-variables'."
3404 "Map the type CLASS to a list of variable settings.
3405 CLASS is the project class, a symbol. VARIABLES is a list
3406 that declares directory-local variables for the class.
3407 An element in VARIABLES is either of the form:
3408 (MAJOR-MODE . ALIST)
3409 or
3410 (DIRECTORY . LIST)
3412 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3413 whose elements are of the form (VARIABLE . VALUE).
3415 In the second form, DIRECTORY is a directory name (a string), and
3416 LIST is a list of the form accepted by the function.
3418 When a file is visited, the file's class is found. A directory
3419 may be assigned a class using `dir-locals-set-directory-class'.
3420 Then variables are set in the file's buffer according to the
3421 class' LIST. The list is processed in order.
3423 * If the element is of the form (MAJOR-MODE . ALIST), and the
3424 buffer's major mode is derived from MAJOR-MODE (as determined
3425 by `derived-mode-p'), then all the variables in ALIST are
3426 applied. A MAJOR-MODE of nil may be used to match any buffer.
3427 `make-local-variable' is called for each variable before it is
3428 set.
3430 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3431 is an initial substring of the file's directory, then LIST is
3432 applied by recursively following these rules."
3439 "File that contains directory-local variables.
3440 It has to be constant to enforce uniform values
3444 "Find the directory-local variables for FILE.
3445 This searches upward in the directory tree from FILE.
3446 If the directory root of FILE has been registered in
3447 `dir-locals-directory-cache' and the directory-local variables
3448 file has not been modified, return the matching entry in
3449 `dir-locals-directory-cache'.
3450 Otherwise, if a directory-local variables file is found, return
3451 the file name.
3452 Otherwise, return nil."
3457 dir-locals-file))
3460 ;; `locate-dominating-file' may have abbreviated the name.
3463 ;; Find the best cached value in `dir-locals-directory-cache'.
3476 ;; Check the validity of the cache.
3481 ;; This cache entry is OK.
3482 dir-elt
3483 ;; This cache entry is invalid; clear it.
3486 locals-file)
3487 locals-file))))
3490 "Load a variables FILE and register a new class and instance.
3491 FILE is the name of the file holding the variables to apply.
3492 The new class name is the same as the directory in which FILE
3493 is found. Returns the new class name."
3503 class-name)))
3506 "Read per-directory local variables for the current buffer.
3507 Store the directory-local variables in `dir-local-variables-alist'
3508 and `file-local-variables-alist', without applying them."
3511 ;; Find the variables file.
3519 default-directory))
3540 \f
3543 However, the mode will not be changed if
3544 \(1) a local variables list or the `-*-' line specifies a major mode, or
3546 \ not suitable for ordinary files, or
3547 \(3) the new file name does not particularly specify any mode."
3552 "Change name of file visited in current buffer to FILENAME.
3553 This also renames the buffer to correspond to the new file.
3554 The next time the buffer is saved it will go in the newly specified file.
3555 FILENAME nil or an empty string means mark buffer as not visiting any file.
3556 Remember to delete the initial contents of the minibuffer
3557 if you wish to pass an empty string as the argument.
3559 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3560 confirmation in the case where another buffer is already visiting FILENAME.
3562 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3563 the old visited file has been renamed to the new name FILENAME."
3571 nil
3586 filename)))
3596 ;; If new-name == old-name, renaming would add a spurious <2>
3597 ;; and it's considered as a feature in rename-buffer.
3603 ;; Abbreviate the file names of the buffer.
3612 nil)))
3613 ;; write-file-functions is normally used for things like ftp-find-file
3614 ;; that visit things that are not local files as if they were files.
3615 ;; Changing to visit an ordinary local file instead should flush the hook.
3620 ;; If buffer was read-only because of version control,
3621 ;; that reason is gone now, so make it writable.
3625 ;; Turn off backup files for certain file names.
3626 ;; Since this is a permanent local, the major mode won't eliminate it.
3628 backup-enable-predicate
3634 ;; If auto-save was not already on, turn it on if appropriate.
3638 ;; If auto save is on, start using a new name.
3639 ;; We deliberately don't rename or delete the old auto save
3640 ;; for the old visited file name. This is because perhaps
3641 ;; the user wants to save the new state and then compare with the
3642 ;; previous state from the auto save file.
3645 ;; Rename the old auto save file if any.
3652 ;; Update the major mode, if the file name determines it.
3654 ;; Don't change the mode if it is special.
3657 ;; Don't change the mode if the local variable list specifies it.
3663 "Write current buffer into file FILENAME.
3664 This makes the buffer visit that file, and marks it as not modified.
3666 If you specify just a directory name as FILENAME, that means to use
3667 the default file name but in that directory. You can also yank
3668 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3670 If the buffer is not already visiting a file, the default file name
3671 for the output file is the buffer name.
3673 If optional second arg CONFIRM is non-nil, this function
3674 asks for confirmation before overwriting an existing file.
3675 Interactively, confirmation is required unless you supply a prefix argument."
3676 ;; (interactive "FWrite file: ")
3680 nil nil nil nil)
3684 default-directory)
3685 nil nil))
3689 ;; If arg is just a directory,
3690 ;; use the default file name, but in that directory.
3701 ;; Make buffer writable if file is writable.
3706 ;; It's likely that the VC status at the new location is different from
3707 ;; the one at the old location.
3709 \f
3711 "Make a backup of the disk file visited by the current buffer, if appropriate.
3712 This is normally done before saving the buffer the first time.
3714 A backup may be done by renaming or by copying; see documentation of
3715 variable `make-backup-files'. If it's done by renaming, then the file is
3716 no longer accessible under its old name.
3718 The value is non-nil after a backup was made by renaming.
3719 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3720 MODES is the result of `file-modes' on the original
3721 file; this means that the caller, after saving the buffer, should change
3722 the modes of the new file to agree with the old modes.
3723 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3724 file; this means that the caller, after saving the buffer, should change
3725 the SELinux context of the new file to agree with the old context.
3726 BACKUPNAME is the backup file name, which is the old file renamed."
3733 backup-info backupname targets setmodes)
3734 ;; If specified name is a symbolic link, chase it to the target.
3735 ;; Thus we make the backups in the directory where the real file is.
3740 ;; (if (file-directory-p buffer-file-name)
3741 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3745 ;; If have old versions to maybe delete,
3746 ;; ask the user to confirm now, before doing anything.
3747 ;; But don't actually delete til later.
3752 real-file-name)))))
3755 ;; Actually write the back up file.
3758 ; (file-symlink-p buffer-file-name)
3759 backup-by-copying
3760 ;; Don't rename a suid or sgid file.
3775 ;; rename-file should delete old backup.
3779 ;; If trouble writing the backup, write it in
3780 ;; .emacs.d/%backup%.
3783 backupname)
3787 ;; Now delete the old versions, if desired.
3794 setmodes)
3801 ;; Create temp files with strict access rights. It's easy to
3802 ;; loosen them later, whereas it's impossible to close the
3803 ;; time-window of loose permissions otherwise.
3806 ;; Try to overwrite old backup first.
3814 nil)
3816 ;; The file was somehow created by someone else between
3817 ;; `delete-file' and `copy-file', so let's try again.
3818 ;; rms says "I think there is also a possible race
3819 ;; condition for making backup files" (emacs-devel 20070821).
3820 nil)))
3821 ;; Reset the umask.
3830 "Regular expression matching the backup/version part of a file name.
3834 "Return file NAME sans backup versions or strings.
3835 This is a separate procedure so your site-init or startup file can
3836 redefine it.
3837 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3838 we do not remove backup version numbers, only true file version numbers.
3839 See also `file-name-version-regexp'."
3846 name))))))
3849 "Return t if deleting FILE and rewriting it would preserve the owner."
3854 ;; Return t if the file doesn't exist, since it's true that no
3855 ;; information would be lost by an (attempted) delete and create.
3861 The extension, in a file name, is the part that follows the last `.',
3862 except that a leading `.', if any, doesn't count."
3865 directory)
3869 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3870 ;; we don't want to expand it.
3873 filename))))
3877 The extension, in a file name, is the part that follows the last `.',
3878 excluding version numbers and backup suffixes,
3879 except that a leading `.', if any, doesn't count.
3880 Return nil for extensionless file names such as `foo'.
3881 Return the empty string for file names such as `foo.'.
3883 If PERIOD is non-nil, then the returned value includes the period
3884 that delimits the extension, and if FILENAME has no extension,
3895 "A function to use instead of the default `make-backup-file-name'.
3896 A value of nil gives the default `make-backup-file-name' behavior.
3898 This could be buffer-local to do something special for specific
3899 files. If you define it, you may need to change `backup-file-name-p'
3900 and `file-name-sans-versions' too.
3902 See also `backup-directory-alist'."
3908 "Alist of filename patterns and backup directory names.
3909 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3910 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3911 relative or absolute. If it is absolute, so that all matching files
3912 are backed up into the same directory, the file names in this
3913 directory will be the full name of the file backed up with all
3914 directory separators changed to `!' to prevent clashes. This will not
3915 work correctly if your filesystem truncates the resulting name.
3917 For the common case of all backups going into one directory, the alist
3919 directory name.
3921 If this variable is nil, or it fails to match a filename, the backup
3922 is made in the original file's directory.
3924 On MS-DOS filesystems without long names this variable is always
3925 ignored."
3931 "Default `backup-enable-predicate' function.
3932 Checks for files in `temporary-file-directory',
3933 `small-temporary-file-directory', and /tmp."
3936 ;; Directory is under temporary-file-directory.
3941 ;; Directory is under /tmp.
3946 0 nil
3948 ;; Directory is under small-temporary-file-directory.
3953 "Create the non-numeric backup file name for FILE.
3954 Normally this will just be the file's name with `~' appended.
3955 Customization hooks are provided as follows.
3957 If the variable `make-backup-file-name-function' is non-nil, its value
3958 should be a function which will be called with FILE as its argument;
3959 the resulting name is used.
3961 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3962 the documentation of that variable. If the directory for the backup
3963 doesn't exist, it is created."
3977 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3979 elt backup-directory abs-backup-directory)
3984 alist nil)))
3985 ;; If backup-directory is relative, it should be relative to the
3986 ;; file's directory. By expanding explicitly here, we avoid
3987 ;; depending on default-directory.
3996 abs-backup-directory nil))))
3998 file
4002 ;; Normalize DOSish file names: downcase the drive
4003 ;; letter, if any, and replace the leading "x:" with
4004 ;; "/drive_x".
4007 ;; Replace any invalid file-name characters (for the
4008 ;; case of backing up remote files).
4012 "drive_"
4015 ""
4018 ;; Make the name unique by substituting directory
4019 ;; separators. It may not really be worth bothering about
4020 ;; doubling `!'s in the original name...
4025 backup-directory))
4030 "Return non-nil if FILE is a backup file name (numeric or not).
4031 This is a separate function so you can redefine it for customization.
4032 You may need to redefine `file-name-sans-versions' as well."
4037 ;; This is used in various files.
4038 ;; The usage of backup-extract-version-start is not very clean,
4039 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4041 "Given the name of a numeric backup file, FN, return the backup number.
4042 Uses the free variable `backup-extract-version-start', whose value should be
4043 the index in the name where the version number begins."
4050 "Find a file name for a backup file FN, and suggestions for deletions.
4051 Value is a list whose car is the name for the backup file
4052 and whose cdr is a list of old versions to consider deleting now.
4053 If the value is nil, don't make a backup.
4054 Uses `backup-directory-alist' in the same way as does
4055 `make-backup-file-name'."
4057 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4061 ;; We don't support numbered backups on plain MS-DOS
4062 ;; when long file names are unavailable.
4072 possibilities deserve-versions-p versions)
4075 base-versions
4078 possibilities)
4079 #'<)
4084 kept-old-versions
4085 kept-new-versions
4092 ;; Delete nothing if there is overflow
4093 ;; in the number of versions to keep.
4099 v))))))))))
4102 "Return number of names file FILENAME has."
4105 ;; (defun file-relative-name (filename &optional directory)
4106 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4107 ;; This function returns a relative file name which is equivalent to FILENAME
4108 ;; when used with that default directory as the default.
4109 ;; If this is impossible (which can happen on MSDOS and Windows
4110 ;; when the file name and directory use different drive names)
4111 ;; then it returns FILENAME."
4112 ;; (save-match-data
4113 ;; (let ((fname (expand-file-name filename)))
4114 ;; (setq directory (file-name-as-directory
4115 ;; (expand-file-name (or directory default-directory))))
4116 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4117 ;; ;; drive names, they can't be relative, so return the absolute name.
4118 ;; (if (and (or (eq system-type 'ms-dos)
4119 ;; (eq system-type 'cygwin)
4120 ;; (eq system-type 'windows-nt))
4121 ;; (not (string-equal (substring fname 0 2)
4122 ;; (substring directory 0 2))))
4123 ;; filename
4124 ;; (let ((ancestor ".")
4125 ;; (fname-dir (file-name-as-directory fname)))
4126 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4127 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4128 ;; (setq directory (file-name-directory (substring directory 0 -1))
4129 ;; ancestor (if (equal ancestor ".")
4130 ;; ".."
4131 ;; (concat "../" ancestor))))
4132 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4133 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4134 ;; ;; We matched within FNAME's directory part.
4135 ;; ;; Add the rest of FNAME onto ANCESTOR.
4136 ;; (let ((rest (substring fname (match-end 0))))
4137 ;; (if (and (equal ancestor ".")
4138 ;; (not (equal rest "")))
4139 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4140 ;; rest
4141 ;; (concat (file-name-as-directory ancestor) rest)))
4142 ;; ;; We matched FNAME's directory equivalent.
4143 ;; ancestor))))))
4146 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4147 This function returns a relative file name which is equivalent to FILENAME
4148 when used with that default directory as the default.
4149 If FILENAME and DIRECTORY lie on different machines or on different drives
4150 on a DOS/Windows machine, it returns FILENAME in expanded form."
4154 default-directory))))
4160 ;; Test for different filesystems on DOS/Windows
4162 ;; Should `cygwin' really be included here? --stef
4165 ;; Test for different drive letters
4167 ;; Test for UNCs on different servers
4172 ;; Windows file names cannot have ? in
4173 ;; them, so use that to detect when
4174 ;; neither FILENAME nor DIRECTORY is a
4175 ;; UNC.
4177 0 nil
4183 ;; Test for different remote file system identification
4185 filename
4191 directory nil nil case-fold-search))
4193 directory nil nil case-fold-search))))
4196 ".."
4198 ;; Now ancestor is empty, or .., or ../.., etc.
4200 directory nil nil case-fold-search))
4201 ;; We matched within FILENAME's directory part.
4202 ;; Add the rest of FILENAME onto ANCESTOR.
4205 ;; But don't bother with ANCESTOR if it would give us `./'.
4206 rest
4208 ;; We matched FILENAME's directory equivalent.
4209 ancestor))))))
4210 \f
4212 "Save current buffer in visited file if modified.
4213 Variations are described below.
4215 By default, makes the previous version into a backup file
4216 if previously requested or if this is the first save.
4218 to become a backup when the next save is done.
4220 unconditionally makes the previous version into a backup file.
4222 to become a backup when the next save is done,
4223 and unconditionally makes the previous version into a backup file.
4225 With a numeric argument of 0, never make the previous version
4226 into a backup file.
4228 If a file's name is FOO, the names of its numbered backup versions are
4229 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4230 Numeric backups (rather than FOO~) will be made if value of
4231 `version-control' is not the atom `never' and either there are already
4232 numeric versions of the file being backed up, or `version-control' is
4233 non-nil.
4234 We don't want excessive versions piling up, so there are variables
4235 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4236 and `kept-new-versions', which tells how many newest versions to keep.
4237 Defaults are 2 old versions and 2 new.
4238 `dired-kept-versions' controls dired's clean-directory (.) command.
4239 If `delete-old-versions' is nil, system will query user
4240 before trimming versions. Otherwise it does it silently.
4242 If `vc-make-backup-files' is nil, which is the default,
4243 no backup files are made for files managed by version control.
4244 (This is because the version control system itself records previous versions.)
4246 See the subroutine `basic-save-buffer' for more information."
4252 ;; We used to display the message below only for files > 50KB, but
4253 ;; then Rmail-mbox never displays it due to buffer swapping. If
4254 ;; the test is ever re-introduced, be sure to handle saving of
4255 ;; Rmail files.
4262 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4263 Normally delete only if the file was written by this Emacs since
4264 the last real save, but optional arg FORCE non-nil means delete anyway."
4278 "Normal hook that is run before a buffer is saved to its file."
4284 "Normal hook that is run after a buffer is saved to its file."
4290 "If non-nil, use this coding system for saving the buffer.
4291 More precisely, use this coding system in place of the
4292 value of `buffer-file-coding-system', when saving the buffer.
4293 Calling `write-region' for any purpose other than saving the buffer
4294 will still use `buffer-file-coding-system'; this variable has no effect
4301 "Save the current buffer in its visited file, if it has been modified.
4302 The hooks `write-contents-functions' and `write-file-functions' get a chance
4303 to do the job of saving; if they do not, then the buffer is saved in
4304 the visited file in the usual way.
4305 Before and after saving the buffer, this function runs
4306 `before-save-hook' and `after-save-hook', respectively."
4309 ;; In an indirect buffer, save its base buffer instead.
4314 setmodes)
4315 ;; If buffer has no file name, ask user for one.
4322 ;; Signal an error if the user specified the name of an
4323 ;; existing directory.
4326 filename))
4328 ;; Signal an error if the specified name refers to a
4329 ;; non-existing directory.
4340 "%s has changed since visited or saved. Save anyway? "
4360 ;; Support VC version backups.
4366 ;; If a hook returned t, file is already "written".
4367 ;; Otherwise, write it the usual way now.
4369 ;; Now we have saved the current buffer. Let's make sure
4370 ;; that buffer-file-coding-system is fixed to what
4371 ;; actually used for saving by binding it locally.
4383 ;; If the auto-save file was recent before this command,
4384 ;; delete it now.
4386 ;; Support VC `implicit' locking.
4391 ;; This does the "real job" of writing a buffer into its visited file
4392 ;; and making a backup file. This is what is normally done
4393 ;; but inhibited if one of write-file-functions returns non-nil.
4394 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4406 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4419 "File %s is write-protected; try to save anyway? "
4421 buffer-file-name)))
4435 ;; Write temp name, then rename it.
4436 ;; This requires write access to the containing dir,
4437 ;; which is why we don't try it if we don't have that access.
4439 tempname succeed
4442 ;; Create temp files with strict access rights. It's easy to
4443 ;; loosen them later, whereas it's impossible to close the
4444 ;; time-window of loose permissions otherwise.
4449 ;; Try various temporary names.
4450 ;; This code follows the example of make-temp-file,
4451 ;; but it calls write-region in the appropriate way
4452 ;; for saving the buffer.
4458 ;; Pass in nil&nil rather than point-min&max
4459 ;; cause we're saving the whole buffer.
4460 ;; write-region-annotate-functions may use it.
4462 tempname nil realname
4464 nil)
4466 ;; The file was somehow created by someone else between
4467 ;; `make-temp-name' and `write-region', let's try again.
4468 nil)
4470 ;; Reset the umask.
4472 ;; If we failed, restore the buffer's modtime.
4475 ;; Since we have created an entirely new file,
4476 ;; make sure it gets the right permission bits set.
4481 buffer-file-name)))
4482 ;; We succeeded in writing the temp file,
4483 ;; so rename it.
4485 ;; If file not writable, see if we can make it writable
4486 ;; temporarily while we write it.
4487 ;; But no need to do so if we have just backed it up
4488 ;; (setmodes is set) because that says we're superseding.
4490 ;; Change the mode back, after writing.
4493 buffer-file-name))
4499 ;; Pass in nil&nil rather than point-min&max to indicate
4500 ;; we're saving the buffer rather than just a region.
4501 ;; write-region-annotate-functions may make us of it.
4503 buffer-file-name nil t buffer-file-truename)
4505 ;; If we get an error writing the new file, and we made
4506 ;; the backup by renaming, undo the backing-up.
4511 setmodes))
4517 `((?\C-r
4524 ;; Return nil to ask about BUF again.
4525 nil)
4538 ;; Return nil to ask about BUF again.
4539 nil)
4549 "Save some modified file-visiting buffers. Asks user about each one.
4550 You can answer `y' to save, `n' not to save, `C-r' to look at the
4551 buffer in question with `view-buffer' before deciding or `d' to
4552 view the differences using `diff-buffer-with-file'.
4554 Optional argument (the prefix) non-nil means save all with no questions.
4555 Optional second argument PRED determines which buffers are considered:
4556 If PRED is nil, all the file-visiting buffers are considered.
4557 If PRED is t, then certain non-file buffers will also be considered.
4558 If PRED is a zero-argument function, it indicates for each buffer whether
4559 to consider it or not when called with that buffer current.
4561 See `save-some-buffers-action-alist' if you want to
4562 change the additional actions you can take on files."
4566 files-done abbrevs-done)
4568 ;; First save any buffers that we're supposed to save unconditionally.
4569 ;; That way the following code won't ask about them.
4574 ;; Ask about those buffers that merit it,
4575 ;; and record the number thus saved.
4579 ;; Note that killing some buffers may kill others via
4580 ;; hooks (e.g. Rmail and its viewing buffer).
4593 t
4605 save-some-buffers-action-alist))
4606 ;; Maybe to save abbrevs, and record whether
4607 ;; we either saved them or asked to.
4614 ;; Don't keep bothering user if he says no.
4619 "(Some special files were saved without asking)"
4621 \f
4623 "Mark current buffer as unmodified, not needing to be saved.
4626 It is not a good idea to use this function in Lisp programs, because it
4627 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4634 "Change whether this buffer is read-only.
4635 With prefix argument ARG, make the buffer read-only if ARG is
4636 positive, otherwise make it writable. If buffer is read-only
4637 and `view-read-only' is non-nil, enter view mode."
4642 nil ; do nothing.
4643 ;; Toggle.
4650 ;; If view-mode is already active, `view-mode-enter' is a nop.
4662 "Insert contents of file FILENAME into buffer after point.
4663 Set mark after the inserted text.
4665 This function is meant for the user to run interactively.
4666 Don't call it from programs! Use `insert-file-contents' instead.
4667 \(Its calling sequence is different; see its documentation)."
4672 "Append the contents of the region to the end of file FILENAME.
4673 When called from a function, expects three arguments,
4674 START, END and FILENAME. START and END are normally buffer positions
4675 specifying the part of the buffer to write.
4676 If START is nil, that means to use the entire buffer contents.
4677 If START is a string, then output that string to the file
4678 instead of any buffer contents; END is ignored.
4680 This does character code conversion and applies annotations
4681 like `write-region' does."
4686 "Return most recent backup file for FILENAME or nil if no backups exist."
4687 ;; `make-backup-file-name' will get us the right directory for
4688 ;; ordinary or numeric backups. It might create a directory for
4689 ;; backups as a side-effect, according to `backup-directory-alist'.
4696 tem)
4705 newest))
4708 "Rename current buffer to a similar name not already taken.
4709 This function is useful for creating multiple shell process buffers
4710 or multiple mail buffers, etc."
4718 ;; If the existing buffer name has a <NNN>,
4719 ;; which isn't part of the file name (if any),
4720 ;; then get rid of that.
4726 "Create the directory DIR and optionally any nonexistent parent dirs.
4727 If DIR already exists as a directory, signal an error, unless
4728 PARENTS is non-nil.
4730 Interactively, the default choice of directory to create is the
4731 current buffer's default directory. That is useful when you have
4732 visited a file in a nonexistent directory.
4734 Noninteractively, the second (optional) argument PARENTS, if
4735 non-nil, says whether to create parent directories that don't
4736 exist. Interactively, this happens by default."
4739 nil nil)
4740 t))
4741 ;; If default-directory is a remote directory,
4742 ;; make sure we find its make-directory handler.
4750 create-list)
4752 ;; If directory is its own parent, then we can't
4753 ;; keep looping forever
4768 "Delete the directory named DIRECTORY. Does not follow symlinks.
4769 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4770 TRASH non-nil means to trash the directory instead, provided
4771 `delete-by-moving-to-trash' is non-nil.
4773 When called interactively, TRASH is t if no prefix argument is
4774 given. With a prefix argument, TRASH is nil."
4781 "Move directory to trash: "
4783 default-directory default-directory nil nil))))
4789 nil)
4791 ;; If default-directory is a remote directory, make sure we find its
4792 ;; delete-directory handler.
4799 ;; Only move non-empty dir to trash if recursive deletion was
4800 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4801 ;; case, where the operation fails in delete-directory-internal.
4802 ;; As `move-file-to-trash' trashes directories (empty or
4803 ;; otherwise) as a unit, we do not need to recurse here.
4805 ;; Check if directory is empty apart from "." and "..".
4810 ;; Otherwise, call outselves recursively if needed.
4814 ;; This test is equivalent to
4815 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4816 ;; but more efficient
4820 ;; We do not want to delete "." and "..".
4826 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4827 If NEWNAME names an existing directory, copy DIRECTORY as subdirectory there.
4829 This function always sets the file modes of the output files to match
4830 the corresponding input file.
4832 The third arg KEEP-TIME non-nil means give the output files the same
4833 last-modified time as the old ones. (This works on only some systems.)
4835 A prefix arg makes KEEP-TIME non-nil.
4837 Noninteractively, the last argument PARENTS says whether to
4838 create parent directories if they don't exist. Interactively,
4839 this happens by default."
4846 default-directory default-directory nil nil)
4847 current-prefix-arg t)))
4848 ;; If default-directory is a remote directory, make sure we find its
4849 ;; copy-directory handler.
4855 ;; Compute target name.
4860 ;; If NEWNAME is not an existing directory, create it; that
4861 ;; is where we will copy the files of DIRECTORY.
4863 ;; If NEWNAME is an existing directory, we will copy into
4864 ;; NEWNAME/[DIRECTORY-BASENAME].
4868 newname))
4872 newname))
4875 ;; Copy recursively.
4877 ;; We do not want to copy "." and "..".
4879 directory-files-no-dot-files-regexp))
4888 ;; Set directory attributes.
4892 \f
4895 "Function to use to revert this buffer, or nil to do the default.
4896 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4901 "Function to use to insert contents when reverting this buffer.
4902 Gets two args, first the nominal file name to use,
4903 and second, t if reading the auto-save file.
4908 "Function to check whether a non-file buffer needs reverting.
4909 This should be a function with one optional argument NOCONFIRM.
4910 Auto Revert Mode passes t for NOCONFIRM. The function should return
4911 non-nil if the buffer should be reverted. A return value of
4912 `fast' means that the need for reverting was not checked, but
4913 that reverting the buffer is fast. The buffer is current when
4914 this function is called.
4916 The idea behind the NOCONFIRM argument is that it should be
4917 non-nil if the buffer is going to be reverted without asking the
4918 user. In such situations, one has to be careful with potentially
4919 time consuming operations.
4921 For more information on how this variable is used by Auto Revert mode,
4925 "Normal hook for `revert-buffer' to run before reverting.
4926 If `revert-buffer-function' is used to override the normal revert
4930 "Normal hook for `revert-buffer' to run after reverting.
4931 Note that the hook value that it runs is the value that was in effect
4932 before reverting; that makes a difference if you have buffer-local
4933 hook functions.
4935 If `revert-buffer-function' is used to override the normal revert
4941 "Replace current buffer text with the text of the visited file on disk.
4942 This undoes all changes since the file was visited or saved.
4943 With a prefix argument, offer to revert from latest auto-save file, if
4944 that is more recent than the visited file.
4946 This command also implements an interface for special buffers
4947 that contain text which doesn't come from a file, but reflects
4948 some other data instead (e.g. Dired buffers, `buffer-list'
4949 buffers). This is done via the variable `revert-buffer-function'.
4950 In these cases, it should reconstruct the buffer contents from the
4951 appropriate data.
4953 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4954 to revert from the auto-save file when this is nil. Note that the
4955 sense of this argument is the reverse of the prefix argument, for the
4956 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4957 to nil.
4959 Optional second argument NOCONFIRM means don't ask for confirmation
4960 at all. \(The variable `revert-without-query' offers another way to
4961 revert buffers without querying for confirmation.)
4963 Optional third argument PRESERVE-MODES non-nil means don't alter
4964 the files modes. Normally we reinitialize them using `normal-mode'.
4966 If the value of `revert-buffer-function' is non-nil, it is called to
4967 do all the work for this command. Otherwise, the hooks
4968 `before-revert-hook' and `after-revert-hook' are run at the beginning
4969 and the end, and if `revert-buffer-insert-file-contents-function' is
4970 non-nil, it is called instead of rereading visited file contents."
4972 ;; I admit it's odd to reverse the sense of the prefix argument, but
4973 ;; there is a lot of code out there which assumes that the first
4974 ;; argument should be t to avoid consulting the auto-save file, and
4975 ;; there's no straightforward way to encourage authors to notice a
4976 ;; reversal of the argument sense. So I'm just changing the user
4977 ;; interface, but leaving the programmatic interface the same.
4985 buffer-auto-save-file-name
4990 buffer-auto-save-file-name
4991 buffer-file-name)))
5001 file-name)))
5003 ;; If file was backed up but has changed since,
5004 ;; we should make another backup.
5008 ;; Effectively copy the after-revert-hook status,
5009 ;; since after-find-file will clobber it.
5012 after-revert-hook))
5017 ;; Get rid of all undo records for this buffer.
5019 ;; Don't make undo records for the reversion.
5022 file-name auto-save-p)))
5025 "File %s no longer exists!"
5027 file-name))
5030 "File %s no longer readable!"
5032 file-name))
5034 ;; Bind buffer-file-name to nil
5035 ;; so that we don't try to lock the file.
5041 ;; Auto-saved file should be read by Emacs'
5042 ;; internal coding.
5046 buffer-file-coding-system-explicit
5049 coding-system-for-read
5051 coding-system-for-read)
5053 ;; As a coding system suitable for multibyte
5054 ;; buffer is specified, make the current
5055 ;; buffer multibyte.
5058 ;; This force after-insert-file-set-coding
5059 ;; (called from insert-file-contents) to set
5060 ;; buffer-file-coding-system to a proper value.
5063 ;; Note that this preserves point in an intelligent way.
5067 nil nil t))
5069 nil nil t)))))
5070 ;; Recompute the truename in case changes in symlinks
5071 ;; have changed the truename.
5075 ;; Run after-revert-hook as it was before we reverted.
5079 local-hook)
5082 t))))))
5085 "Recover the visited file--get contents from its last auto-save file."
5090 "Visit file FILE, but get contents from its last auto-save file."
5091 ;; Actually putting the file name in the minibuffer should be used
5092 ;; only rarely.
5093 ;; Not just because users often use the default.
5113 ;; Use insert-directory-safely, not insert-directory,
5114 ;; because these files might not exist. In particular,
5115 ;; FILE might not exist if the auto-save file was for
5116 ;; a buffer that didn't visit a file, such as "*mail*".
5117 ;; The code in v20.x called `ls' directly, so we need
5118 ;; to emulate what `ls' did in that case.
5124 ;; Keep the current buffer-file-coding-system.
5126 ;; Auto-saved file should be read with special coding.
5135 "Recover auto save files from a previous Emacs session.
5136 This command first displays a Dired buffer showing you the
5137 previous sessions that you could recover from.
5138 To choose one, move point to the proper line and then type C-c C-c.
5139 Then you'll be asked about a number of files to recover."
5149 auto-save-list-file-prefix)))
5150 t)
5159 ;; Each line starts with a space
5160 ;; so that Font Lock mode won't highlight the first character.
5169 "Choose one saved session to recover auto-save files from.
5170 This command is used in the special Dired buffer created by
5173 ;; Get the name of the session file to recover from.
5175 files
5181 ;; Read in the auto-save-list file.
5184 ;; Loop thru the text of that file
5185 ;; and get out the names of the files to recover.
5189 ;; This is a pair of lines for a non-file-visiting buffer.
5190 ;; Get the auto-save file name and manufacture
5191 ;; a "visited file name" from that.
5194 ;; If there is no auto-save file name, the
5195 ;; auto-save-list file is probably corrupted.
5208 ;; This pair of lines is a file-visiting
5209 ;; buffer. Use the visited file name.
5219 ;; Ignore a file if its auto-save file does not exist now.
5223 ;; The file contains a pair of line for each auto-saved buffer.
5224 ;; The first line of the pair contains the visited file name
5225 ;; or is empty if the buffer was not visiting a file.
5226 ;; The second line is the auto-save file name.
5234 files
5240 "Kill BUFFER if confirmed."
5248 "Kill some buffers. Asks the user whether to kill each one of them.
5249 Non-interactively, if optional argument LIST is non-nil, it
5250 specifies the list of buffers to kill, asking for approval for each one."
5258 ; if we killed the base buffer.
5265 "Kill buffers whose name matches the specified REGEXP.
5266 The optional second argument indicates whether to kill internal buffers too."
5275 \f
5277 "Adjust current buffer's auto save file name for current conditions.
5278 Also rename any existing auto save file, if it was made in this session."
5290 "Return file name to use for auto-saves of current buffer.
5291 Does not consider `auto-save-visited-file-name' as that variable is checked
5292 before calling this function. You can redefine this for customization.
5293 See also `auto-save-file-name-p'."
5301 result uniq)
5302 ;; Apply user-specified translations
5303 ;; to the file name.
5307 filename)
5317 filename))))
5322 ;; We truncate the file name to DOS 8+3 limits
5323 ;; before doing anything else, because the regexp
5324 ;; passed to string-match below cannot handle
5325 ;; extensions longer than 3 characters, multiple
5326 ;; dots, and other atrocities.
5331 fn)
5336 "#"
5339 ;; Make sure auto-save file names don't contain characters
5340 ;; invalid for the underlying filesystem.
5342 ;; Don't modify remote (ange-ftp) filenames
5345 result))))
5347 ;; Deal with buffers that don't have any associated files. (Mail
5348 ;; mode tends to create a good number of these.)
5352 file-name)
5353 ;; Restrict the characters used in the file name to those which
5354 ;; are known to be safe on all filesystems, url-encoding the
5355 ;; rest.
5356 ;; We do this on all platforms, because even if we are not
5357 ;; running on DOS/Windows, the current directory may be on a
5358 ;; mounted VFAT filesystem, such as a USB memory stick.
5362 ;; For multibyte characters, this will produce more than
5363 ;; 2 hex digits, so is not true URL encoding.
5367 ;; Generate the file name.
5373 ;; Try a few alternative directories, to get one we can
5374 ;; write it.
5380 ;; Don't modify remote (ange-ftp) filenames
5382 ;; The call to convert-standard-filename is in case
5383 ;; buffer-name includes characters not allowed by the
5384 ;; DOS/Windows filesystems. make-temp-file writes to the
5385 ;; file it creates, so we must fix the file name _before_
5386 ;; make-temp-file is called.
5388 fname))
5390 ;; make-temp-file creates the file,
5391 ;; but we don't want it to exist until we do an auto-save.
5395 file-name)))
5398 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5399 FILENAME should lack slashes. You can redefine this for customization."
5401 \f
5403 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5404 The generated regexp will match a filename only if the filename
5405 matches that wildcard according to shell rules. Only wildcards known
5406 by `sh' are supported."
5408 ;; Copy the initial run of non-special characters.
5411 ;; If no special characters, we're almost done.
5415 j)
5417 result
5438 ;; Found "[^". Insert a `\0' character
5439 ;; (which cannot happen in a filename)
5440 ;; into the character class, so that `^'
5441 ;; is not the first character after `[',
5442 ;; and thus non-special in a regexp.
5447 ;; I don't think `]' can appear in a
5448 ;; character class in a wildcard, but
5449 ;; let's be general here.
5456 i
5469 ;; Shell wildcards should match the entire filename,
5470 ;; not its part. Make the regexp say so.
5472 \f
5475 "Switches for `list-directory' to pass to `ls' for brief listing."
5481 "Switches for `list-directory' to pass to `ls' for verbose listing."
5486 "Expand wildcard pattern PATTERN.
5487 This returns a list of file names which match the pattern.
5489 If PATTERN is written as an absolute file name,
5490 the values are absolute also.
5492 If PATTERN is written as a relative file name, it is interpreted
5493 relative to the current default directory, `default-directory'.
5494 The file names returned are normally also relative to the current
5495 default directory. However, if FULL is non-nil, they are absolute."
5499 ;; A list of all dirs that DIRPART specifies.
5500 ;; This can be more than one dir
5501 ;; if DIRPART contains wildcards.
5505 dirpart)))
5509 contents)
5514 ;; Filter out "." and ".."
5519 name))
5526 this-dir-contents)
5527 this-dir-contents)
5528 contents))))
5530 contents)))
5532 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5536 "Display a list of files in or matching DIRNAME, a la `ls'.
5537 DIRNAME is globbed by the shell if necessary.
5538 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5539 Actions controlled by variables `list-directory-brief-switches'
5540 and `list-directory-verbose-switches'."
5544 nil default-directory nil)
5545 pfx)))
5547 list-directory-brief-switches))
5548 buffer)
5560 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5568 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5570 PATTERN is assumed to represent a file-name wildcard suitable for the
5571 underlying filesystem. For Unix and GNU/Linux, each character from the
5573 the parts of the pattern which don't include wildcard characters are
5574 quoted with double quotes.
5577 on Windows), so PATTERN can use them to quote wildcard characters that
5578 need to be passed verbatim to shell commands."
5582 ;; DOS/Windows don't allow `"' in file names. So if the
5583 ;; argument has quotes, we can safely assume it is already
5584 ;; quoted by the caller.
5586 ;; We quote [&()#$'] in case their shell is a port of a
5587 ;; Unixy shell. We quote [,=+] because stock DOS and
5588 ;; Windows shells require that in some cases, such as
5589 ;; passing arguments to batch files that use positional
5590 ;; arguments like %1.
5592 pattern
5595 end)
5612 pattern))))
5619 "Program to get the amount of free space on a file system.
5620 We assume the output has the format of `df'.
5621 The value of this variable must be just a command name or file name;
5622 if you want to specify options, use `directory-free-space-args'.
5624 A value of nil disables this feature.
5626 If the function `file-system-info' is defined, it is always used in
5627 preference to the program given by this variable."
5633 "Options to use when running `directory-free-space-program'."
5638 "Return the amount of free space on directory DIR's file system.
5639 The return value is a string describing the amount of free
5640 space (normally, the number of free 1KB blocks).
5642 This function calls `file-system-info' if it is available, or
5643 invokes the program specified by `directory-free-space-program'
5644 and `directory-free-space-args'. If the system call or program
5645 is unsuccessful, or if DIR is a remote directory, this function
5646 returns nil."
5648 ;; Try to find the number of free blocks. Non-Posix systems don't
5649 ;; always have df, but might have an equivalent system call.
5658 ;; Avoid failure if the default directory does
5659 ;; not exist (Bug#2631, Bug#3911).
5662 nil t nil
5663 directory-free-space-args
5664 dir)
5666 ;; Assume that the "available" column is before the
5667 ;; "capacity" column. Find the "%" and scan backward.
5671 "[[:space:]]+[^[:space:]]+%[^%]*$"
5678 ;; The following expression replaces `dired-move-to-filename-regexp'.
5682 ;; In some locales, month abbreviations are as short as 2 letters,
5683 ;; and they can be followed by ".".
5684 ;; In Breton, a month name can include a quote character.
5697 s "+"
5700 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5701 ;; omits the Kanji characters after month and day-of-month.
5702 ;; On Mac OS X 10.3, the date format in East Asian locales is
5703 ;; day-of-month digits followed by month digits.
5709 ;; The "[0-9]" below requires the previous column to end in a digit.
5710 ;; This avoids recognizing `1 may 1997' as a date in the line:
5711 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5713 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5715 ;; For non-iso date formats, we add the ".*" in order to find
5716 ;; the last possible match. This avoids recognizing
5717 ;; `jservice 10 1024' as a date in the line:
5718 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5720 ;; vc dired listings provide the state or blanks between file
5721 ;; permissions and date. The state is always surrounded by
5722 ;; parantheses:
5723 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5724 ;; This is not supported yet.
5729 "Regular expression to match up to the file name in a directory listing.
5730 The default value is designed to recognize dates and times
5735 ;; insert-directory
5736 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5737 ;; FULL-DIRECTORY-P is nil.
5738 ;; The single line of output must display FILE's name as it was
5739 ;; given, namely, an absolute path name.
5740 ;; - must insert exactly one line for each file if WILDCARD or
5741 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5742 ;; before the file lines, plus optional text after the file lines.
5743 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5744 ;; allowed.
5745 ;; File lines should display the basename.
5746 ;; - must be consistent with
5747 ;; - functions dired-move-to-filename, (these two define what a file line is)
5748 ;; dired-move-to-end-of-filename,
5749 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5750 ;; dired-insert-headerline
5751 ;; dired-after-subdir-garbage (defines what a "total" line is)
5752 ;; - variable dired-subdir-regexp
5753 ;; - may be passed "--dired" as the first argument in SWITCHES.
5754 ;; Filename handlers might have to remove this switch if their
5755 ;; "ls" command does not support it.
5757 "Insert directory listing for FILE, formatted according to SWITCHES.
5758 Leaves point after the inserted text.
5759 SWITCHES may be a string of options, or a list of strings
5760 representing individual options.
5761 Optional third arg WILDCARD means treat FILE as shell wildcard.
5762 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5763 switches do not contain `d', so that a full listing is expected.
5765 This works by running a directory listing program
5766 whose name is in the variable `insert-directory-program'.
5767 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5769 When SWITCHES contains the long `--dired' option, this function
5770 treats it specially, for the sake of dired. However, the
5771 normally equivalent short `-D' option is just passed on to
5772 `insert-directory-program', as any other option."
5773 ;; We need the directory in order to find the right handler.
5778 wildcard full-directory-p)
5781 ;; Read the actual directory using `insert-directory-program'.
5782 ;; RESULT gets the status code.
5784 ;; putting text property `dired-filename, decode one
5785 ;; bunch by one to preserve that property.
5787 ;; This is to control encoding the arguments in call-process.
5791 default-file-name-coding-system))))
5794 ;; Run ls in the directory part of the file pattern
5795 ;; using the last component as argument.
5802 shell-file-name nil t nil
5803 "-c"
5805 ""
5807 insert-directory-program
5808 " -d "
5810 switches
5812 " -- "
5813 ;; Quote some characters that have
5814 ;; special meanings in shells; but
5815 ;; don't quote the wildcards--we want
5816 ;; them to be special. We also
5817 ;; currently don't quote the quoting
5818 ;; characters in case people want to
5819 ;; use them explicitly to quote
5820 ;; wildcard characters.
5822 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5823 ;; directory if FILE is a symbolic link.
5830 insert-directory-program nil t nil
5834 ;; Split the switches at any spaces so we can
5835 ;; pass separate options as separate args.
5837 ;; Avoid lossage if FILE starts with `-'.
5845 file))))))))
5847 ;; If we got "//DIRED//" in the output, it means we got a real
5848 ;; directory listing, even if `ls' returned nonzero.
5849 ;; So ignore any errors.
5862 ;; The first time ls returns an error,
5863 ;; find the version numbers of ls,
5864 ;; and set insert-directory-ls-version
5865 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5866 ;; is equal or if the info cannot be obtained.
5867 ;; (That can mean it isn't GNU ls.)
5877 comparison)
5893 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5897 ;; If `insert-directory-program' failed, signal an error.
5899 ;; Delete the error message it may have output.
5901 ;; On non-Posix systems, we cannot open a directory, so
5902 ;; don't even try, because that will always result in
5903 ;; the ubiquitous "Access denied". Instead, show the
5904 ;; command line so the user can try to guess what went wrong.
5909 insert-directory-program
5911 file result)
5912 ;; Unix. Access the file to get a suitable error.
5919 ;; The following overshoots by one line for an empty
5920 ;; directory listed with "--dired", but without "-a"
5921 ;; switch, where the ls output contains a
5922 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5923 ;; We take care of that case later.
5931 error-lines)
5932 ;; Find all the lines that are error messages,
5933 ;; and record the bounds of each one.
5940 ;; Now read the numeric positions of file names.
5947 error-lines))
5950 error-lines)))
5952 ;; End is followed by \n or by " -> ".
5954 ;; It seems that we can't trust ls's output as to
5955 ;; byte positions of filenames.
5961 ;; Take care of the case where the ls output contains a
5962 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5963 ;; and we went one line too far back (see above).
5968 ;; Now decode what read if necessary.
5970 file-name-coding-system
5971 default-file-name-coding-system
5973 coding-no-eol
5974 val pos)
5978 ;; If no coding system is specified or detection is
5979 ;; requested, detect the coding.
5993 ;; Force no eol conversion on a file name, so
5994 ;; that CR is preserved.
6002 ;; Try to insert the amount of free space.
6005 ;; First find the line to put it on.
6009 ;; Replace "total" with "used", to avoid confusion.
6015 "Convert `ls --dired' file name position value POS to a buffer position.
6016 File name position values returned in ls --dired output
6017 count only stdout; they don't count the error messages sent to stderr.
6018 So this function converts to them to real buffer positions.
6019 ERROR-LINES is a list of buffer positions of error message lines,
6020 of the form (START END)."
6024 pos)
6028 "Insert directory listing for FILE, formatted according to SWITCHES.
6030 Like `insert-directory', but if FILE does not exist, it inserts a
6031 message to that effect instead of signaling an error."
6034 ;; Simulate the message printed by `ls'.
6038 "Functions to call with no arguments to query about killing Emacs.
6039 If any of these functions returns nil, killing Emacs is cancelled.
6040 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6044 "How to ask for confirmation when leaving Emacs.
6045 If nil, the default, don't ask at all. If the value is non-nil, it should
6046 be a predicate function such as `yes-or-no-p'."
6054 "Offer to save each buffer, then kill this Emacs process.
6055 With prefix ARG, silently save all file-visiting buffers, then kill."
6064 ;; process-list is not defined on MSDOS.
6066 active)
6075 ;; Query the user for other things, perhaps.
6082 "Offer to save each buffer, then kill the current connection.
6083 If the current frame has no client, kill Emacs itself.
6085 With prefix ARG, silently save all file-visiting buffers, then kill.
6087 If emacsclient was started with a list of filenames to edit, then
6088 only these files will be asked to be saved."
6093 \f
6094 ;; We use /: as a prefix to "quote" a file name
6095 ;; so that magic file name handlers will not apply to it.
6099 file-name-handler-alist))
6101 ;; We depend on being the last handler on the list,
6102 ;; so that anything else which does need handling
6103 ;; has been handled already.
6104 ;; So it is safe for us to inhibit *all* magic file name handlers.
6113 default-directory))
6114 ;; Get a list of the indices of the args which are file names.
6117 ;; The first six are special because they
6118 ;; return a file name. We want to include the /:
6119 ;; in the return value.
6120 ;; So just avoid stripping it in the first place.
6127 ;; `identity' means just return the first arg
6128 ;; not stripped of its quoting.
6130 ;; `add' means add "/:" to the result.
6133 ;; `unquote-then-quote' means set buffer-file-name
6134 ;; temporarily to unquoted filename.
6136 ;; List the arguments which are filenames.
6144 ;; For all other operations, treat the first argument only
6145 ;; as the file name.
6147 method
6148 ;; Copy ARGUMENTS so we can replace elements in it.
6152 ;; Strip off the /: from the file names that have it.
6160 "/"
6177 \f
6178 ;; Symbolic modes and read-file-modes.
6181 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6182 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6183 Others, or All) for whom to produce the mask.
6184 The bit-mask that is returned extracts from mode bits the access rights
6185 for the specified category of users."
6193 "Convert CHAR to a numeric value of mode bits.
6194 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6195 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6202 ;; Rights relative to the previous file modes.
6213 "Convert a symbolic mode string specification to an equivalent number.
6215 WHO-MASK is the bit-mask specifying the category of users to which to
6216 apply the access permissions. See `file-modes-char-to-who'.
6217 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6218 RIGHTS request to add, remove, or set permissions based on existing ones,
6225 char-right)
6232 num-rights
6236 op char-right)))
6237 num-rights))
6240 "Convert symbolic file modes to numeric file modes.
6241 MODES is the string to convert, it should match
6244 notation.
6245 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6246 MODES request to add, remove, or set permissions based on existing ones,
6260 num-who num-modes)
6263 num-modes)))
6266 "Read file modes in octal or symbolic notation and return its numeric value.
6267 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6268 ORIG-FILE is the name of a file on whose mode bits to base returned
6269 permissions if what user types requests to add, remove, or set permissions
6285 nil nil default)))
6291 \f
6292 ;; Trashcan handling.
6294 "Directory for `move-file-to-trash' to move files and directories to.
6295 This directory is only used when the function `system-move-file-to-trash'
6296 is not defined.
6297 Relative paths are interpreted relative to `default-directory'.
6298 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6308 "Move the file (or directory) named FILENAME to the trash.
6309 When `delete-by-moving-to-trash' is non-nil, this function is
6310 called by `delete-file' and `delete-directory' instead of
6311 deleting files outright.
6313 If the function `system-move-file-to-trash' is defined, call it
6314 with FILENAME as an argument.
6315 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6316 directory.
6317 Otherwise, trash FILENAME using the freedesktop.org conventions,
6318 like the GNOME, KDE and XFCE desktop environments. Emacs only
6322 ;; If `trash-directory' is non-nil, move the file there.
6326 trash-dir)))
6327 ;; We can't trash a parent directory of trash-directory.
6330 trash-dir filename))
6333 ;; Ensure that the trashed file-name is unique.
6340 ;; If `system-move-file-to-trash' is defined, use it.
6343 ;; Otherwise, use the freedesktop.org method, as specified at
6344 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6355 ;; Check if we have permissions to delete.
6359 ;; The trashed file cannot be the trash dir or its parent.
6362 trash-files-dir filename))
6365 trash-info-dir filename))
6367 ;; Ensure that the trash directory exists; otherwise, create it.
6376 ;; Try to move to trash with .trashinfo undo information
6381 ;; Perform url-encoding on FN. For compatibility with
6382 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6383 ;; for path separators.
6388 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6389 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6402 fn))
6407 ;; Attempt to make .trashinfo file, trying up to 5
6408 ;; times. The .trashinfo file is opened with O_EXCL,
6409 ;; as per trash-spec 0.7, even if that can be a problem
6410 ;; on old NFS versions...
6414 trash-files-dir))
6416 success info-fn)
6421 trash-info-dir))
6429 ;; Uniqify new-fn. (Some file managers do not
6430 ;; like Emacs-style backup file names---e.g. bug
6431 ;; 170956 in Konqueror bug tracker.)
6436 ;; Finally, try to move the file to the trashcan.
6440 \f
6465 ;;; files.el ends here