| blob | 0f167ce3ffa1d3ad403c58289c17c415602772f1 |
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."
157 "Non-nil means find a file under alternative names, in existing buffers.
158 This means if any existing buffer is visiting the file you want
159 under another name, you get the existing buffer instead of a new buffer."
164 "Non-nil means visit a file under its truename.
165 The truename of a file is found by chasing all links
166 both at the file level and at the levels of the containing directories."
172 "Specify which files should be reverted without query.
173 The value is a list of regular expressions.
174 If the file name matches one of these regular expressions,
175 then `revert-buffer' reverts the file without querying
176 if the file has changed on disk and you have not edited the buffer."
181 "The device number and file number of the file visited in the current buffer.
182 The value is a list of the form (FILENUM DEVNUM).
183 This pair of numbers uniquely identifies the file.
197 "The directory for writing small temporary files.
198 If non-nil, this directory is used instead of `temporary-file-directory'
199 by programs that create small temporary files. This is for systems that
200 have fast storage with limited space, such as a RAM disk."
205 ;; The system null device. (Should reference NULL_DEVICE from C.)
233 "Non-nil means protect against I/O errors while saving files.
234 Some modes set this non-nil in particular buffers.
236 This feature works by writing the new contents into a temporary file
237 and then renaming the temporary file to replace the original.
238 In this way, any I/O error in writing leaves the original untouched,
239 and there is never any instant where the file is nonexistent.
241 Note that this feature forces backups to be made by copying.
242 Yet, at the same time, saving a precious file
243 breaks any hard links between it and other files.
245 This feature is advisory: for example, if the directory in which the
246 file is being saved is not writable, Emacs may ignore a non-nil value
247 of `file-precious-flag' and write directly into the file.
249 See also: `break-hardlink-on-save'."
254 "Non-nil means when saving a file that exists under several names
255 \(i.e., has multiple hardlinks), break the hardlink associated with
256 `buffer-file-name' and write to a new file, so that the other
257 instances of the file are not affected by the save.
259 If `buffer-file-name' refers to a symlink, do not break the symlink.
261 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
262 For example, if the directory in which a file is being saved is not
263 itself writable, then error instead of saving in some
264 hardlink-nonbreaking way.
266 See also `backup-by-copying' and `backup-by-copying-when-linked'."
272 "Control use of version numbers for backup files.
273 When t, make numeric backup versions unconditionally.
274 When nil, make them for files that have some already.
275 The value `never' means do not make them."
285 "When cleaning directory, number of versions to keep."
291 "If t, delete excess backup versions silently.
292 If nil, ask confirmation. Any other value prevents any trimming."
299 "Number of oldest versions to keep when a new numbered backup is made."
305 "Number of newest versions to keep when a new numbered backup is made.
306 Includes the new backup. Must be > 0"
312 "Whether to add a newline automatically at the end of the file.
314 A value of t means do this only when the file is about to be saved.
315 A value of `visit' means do this right after the file is visited.
316 A value of `visit-save' means do it at both of those times.
317 Any other non-nil value means ask user whether to add a newline, when saving.
318 A value of nil means don't add newlines.
320 Certain major modes set this locally to the value obtained
321 from `mode-require-final-newline'."
330 "Whether to add a newline at end of file, in certain major modes.
331 Those modes set `require-final-newline' to this value when you enable them.
332 They do so because they are often used for files that are supposed
333 to end in newlines, and the question is how to arrange that.
335 A value of t means do this only when the file is about to be saved.
336 A value of `visit' means do this right after the file is visited.
337 A value of `visit-save' means do it at both of those times.
338 Any other non-nil value means ask user whether to add a newline, when saving.
340 A value of nil means do not add newlines. That is a risky choice in this
341 variable since this value is used for modes for files that ought to have
342 final newlines. So if you set this to nil, you must explicitly check and
343 add a final newline, whenever you save a file that really needs one."
353 "Non-nil says by default do auto-saving of every file-visiting buffer."
359 ;; Don't put "\\2" inside expand-file-name, since it will be
360 ;; transformed to "/2" on DOS/Windows.
362 "Transforms to apply to buffer file name before making auto-save file name.
363 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
364 REGEXP is a regular expression to match against the file name.
365 If it matches, `replace-match' is used to replace the
366 matching part with REPLACEMENT.
367 If the optional element UNIQUIFY is non-nil, the auto-save file name is
368 constructed by taking the directory part of the replaced file-name,
369 concatenated with the buffer file name with all directory separators
370 changed to `!' to prevent clashes. This will not work
371 correctly if your filesystem truncates the resulting name.
373 All the transforms in the list are tried, in the order they are listed.
374 When one transform applies, its result is final;
375 no further transforms are tried.
377 The default value is set up to put the auto-save file into the
378 temporary directory (see the variable `temporary-file-directory') for
379 editing a remote file.
381 On MS-DOS filesystems without long names this variable is always
382 ignored."
390 "Non-nil means save word abbrevs too when files are saved.
391 If `silently', don't ask the user before saving."
396 "Non-nil means allow `find-file' to visit directories.
397 To visit the directory, `find-file' runs `find-directory-functions'."
402 "List of functions to try in sequence to visit a directory.
403 Each function is called with the directory name as the sole argument
404 and should return either a buffer or nil."
408 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
410 "List of functions to try in sequence to get a file name at point.
411 Each function should return either nil or a file name found at the
412 location of point in the current buffer."
416 ;;;It is not useful to make this a local variable.
417 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
419 "List of functions to be called for `find-file' on nonexistent file.
420 These functions are called as soon as the error is detected.
421 Variable `buffer-file-name' is already set up.
426 ;;;It is not useful to make this a local variable.
427 ;;;(put 'find-file-hooks 'permanent-local t)
430 "List of functions to be called after a buffer is loaded from a file.
431 The buffer's local variables (if any) will have been processed before the
432 functions are called."
439 "List of functions to be called before writing out a buffer to a file.
440 If one of them returns non-nil, the file is considered already written
441 and the rest are not called.
442 These hooks are considered to pertain to the visited file.
443 So any buffer-local binding of this variable is discarded if you change
445 change the major mode.
447 This hook is not run if any of the functions in
448 `write-contents-functions' returns non-nil. Both hooks pertain
449 to how to save a buffer to file, for instance, choosing a suitable
450 coding system and setting mode bits. (See Info
451 node `(elisp)Saving Buffers'.) To perform various checks or
462 "List of functions to be called before writing out a buffer to a file.
463 If one of them returns non-nil, the file is considered already written
464 and the rest are not called and neither are the functions in
465 `write-file-functions'.
467 This variable is meant to be used for hooks that pertain to the
468 buffer's contents, not to the particular visited file; thus,
469 `set-visited-file-name' does not clear this variable; but changing the
470 major mode does clear it.
472 For hooks that _do_ pertain to the particular visited file, use
473 `write-file-functions'. Both this variable and
474 `write-file-functions' relate to how a buffer is saved to file.
475 To perform various checks or updates before the buffer is saved,
482 "Control use of local variables in files you visit.
483 The value can be t, nil, :safe, :all, or something else.
485 A value of t means file local variables specifications are obeyed
486 if all the specified variable values are safe; if any values are
487 not safe, Emacs queries you, once, whether to set them all.
488 \(When you say yes to certain values, they are remembered as safe.)
490 :safe means set the safe variables, and ignore the rest.
491 :all means set all variables, whether safe or not.
492 (Don't set it permanently to :all.)
493 A value of nil means always ignore the file local variables.
495 Any other value means always query you once whether to set them all.
496 \(When you say yes to certain values, they are remembered as safe, but
499 This variable also controls use of major modes specified in
500 a -*- line.
503 always obeys file local variable specifications and the -*- line,
504 and ignores this variable."
505 :risky t
514 "Like `enable-local-variables' but meant for buffer-local bindings.
515 The meaningful values are nil and non-nil. The default is non-nil.
516 If a major mode sets this to nil, buffer-locally, then any local
517 variables list in the file will be ignored.
519 This variable does not affect the use of major modes
524 The value can be t, nil or something else.
525 A value of t means obey `eval' variables.
526 A value of nil means ignore them; anything else means query."
527 :risky t
533 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
542 "Non-nil means buffers visiting files read-only do so in view mode.
543 In fact, this means that all read-only buffers normally have
544 View mode enabled, including buffers that are read-only because
545 you visit a file you cannot alter, and buffers you make read-only
551 "History list of file names entered in the minibuffer.
553 Maximum length of the history list is determined by the value
555 \f
558 "Provides support for ange-ftp host name completion.
559 Runs the usual ange-ftp hook, but only for completion operations."
560 ;; Having this here avoids the need to load ange-ftp when it's not
561 ;; really in use.
567 inhibit-file-name-handlers)))
575 "Convert a standard file's name to something suitable for the OS.
576 This means to guarantee valid names and perhaps to canonicalize
577 certain patterns.
579 FILENAME should be an absolute file name since the conversion rules
580 sometimes vary depending on the position in the file name. E.g. c:/foo
581 is a valid DOS file name, but c:/bar/c:/foo is not.
583 This function's standard definition is trivial; it just returns
584 the argument. However, on Windows and DOS, replace invalid
585 characters. On DOS, make sure to obey the 8.3 limitations.
586 In the native Windows build, turn Cygwin names into native names,
587 and also turn slashes into backslashes if the shell requires it (see
588 `w32-shell-dos-semantics').
590 See Info node `(elisp)Standard File Names' for more details."
595 ;; Replace invalid filename characters with !
599 name))
607 "Read directory name, prompting with PROMPT and completing in directory DIR.
608 Value is not expanded---you must call `expand-file-name' yourself.
609 Default name to DEFAULT-DIRNAME if user exits with the same
610 non-empty string that was inserted by this function.
611 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
612 or just DIR if INITIAL is nil.)
613 If the user exits with an empty minibuffer, this function returns
614 an empty string. (This can only happen if the user erased the
615 pre-inserted contents or if `insert-default-directory' is nil.)
616 Fourth arg MUSTMATCH non-nil means require existing directory's name.
617 Non-nil and non-t means also require confirmation after completion.
618 Fifth arg INITIAL specifies text to start with.
619 DIR should be an absolute directory name. It defaults to
620 the value of `default-directory'."
625 dir))
626 mustmatch initial
629 \f
631 "Show the current default directory."
636 "Value of the CDPATH environment variable, as a list.
640 "Explode a search path into a list of directory names.
641 Directories are separated by occurrences of `path-separator'
642 \(which is colon in GNU and GNU-like systems)."
643 ;; We could use split-string here.
651 nil
656 cd-list)))
659 "Change current directory to given absolute file name DIR."
660 ;; Put the name into directory syntax now,
661 ;; because otherwise expand-file-name may give some bad results.
663 ;; We used to additionally call abbreviate-file-name here, for an
664 ;; unknown reason. Problem is that most buffers are setup
665 ;; without going through cd-absolute and don't call
666 ;; abbreviate-file-name on their default-directory, so the few that
667 ;; do end up using a superficially different directory.
679 "Make DIR become the current buffer's default directory.
680 If your environment includes a `CDPATH' variable, try each one of
681 that list of directories (separated by occurrences of
682 `path-separator') when resolving a relative directory name.
683 The path separator is colon in GNU and GNU-like systems."
686 ;; FIXME: There's a subtle bug in the completion below. Seems linked
687 ;; to a fundamental difficulty of implementing `predicate' correctly.
688 ;; The manifestation is that TAB may list non-directories in the case where
689 ;; those files also correspond to valid directories (if your cd-path is (A/
690 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
691 ;; will be listed as valid completions).
692 ;; This is because `a' (listed because of A/a) is indeed a valid choice
693 ;; (which will lead to the use of B/a).
698 cd-path nil))
707 default-directory default-directory
708 t))))
718 "Load the Lisp file named FILE."
719 ;; This is a case where .elc makes a lot of sense.
726 "Search for FILENAME through PATH.
727 If found, return the absolute file name of FILENAME, with its suffixes;
728 otherwise return nil.
729 PATH should be a list of directories to look in, like the lists in
730 `exec-path' or `load-path'.
731 If SUFFIXES is non-nil, it should be a list of suffixes to append to
734 If non-nil, PREDICATE is used instead of `file-readable-p'.
736 This function will normally skip directories, so if you want it to find
737 directories, make sure the PREDICATE function returns `dir-ok' for them.
739 PREDICATE can also be an integer to pass to the `access' system call,
740 in which case file-name handlers are ignored. This usage is deprecated.
741 For compatibility, PREDICATE can also be one of the symbols
742 `executable', `readable', `writable', or `exists', or a list of
743 one or more of those symbols."
754 "Do completion for file names passed to `locate-file'."
757 ;; FIXME: maybe we should use completion-file-name-table instead,
758 ;; tho at least for `load', the arg is passed through
759 ;; substitute-in-file-name for historical reasons.
769 ;; If we have files like "foo.el" and "foo.elc", we could load one of
770 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
771 ;; preferred way. So if we list all 3, that gives a lot of redundant
772 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
773 ;; the user does want to pay attention to the extension. We try to
774 ;; diffuse this tension by stripping the suffix, except when the
775 ;; result is a single element (i.e. usually we only list "foo" unless
776 ;; it's the only remaining element in the list, in which case we do
777 ;; list "foo", "foo.elc" and "foo.el").
788 string-file dir))
793 ;; Switching from names to names+fullnames creates a non-monotonicity
794 ;; which can cause problems with things like partial-completion.
795 ;; To minimize the problem, filter out completion-regexp-list, so that
796 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
797 ;; from `names' which only matched `string' when they still had
798 ;; their suffix.
800 ;; Remove duplicates of the first element, so that we can easily check
801 ;; if `names' really only contains a single element.
804 ;; There's no more than one matching non-suffixed element, so expand
805 ;; the list by adding the suffixed elements as well.
808 string-dir names string-file pred action)))))
811 "Do completion for file names passed to `locate-file'.
812 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
815 string nil action))
820 "Regexp of directory names which stop the search in `locate-dominating-file'.
821 Any directory whose name matches this regexp will be treated like
822 a kind of root directory by `locate-dominating-file' which will stop its search
823 when it bumps into it.
824 The default regexp prevents fruitless and time-consuming attempts to find
825 special files in directories in which filenames are interpreted as hostnames,
828 ;; (defun locate-dominating-files (file regexp)
829 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
830 ;; Stop at the first parent where a matching file is found and return the list
831 ;; of files that that match in this directory."
832 ;; (catch 'found
833 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
834 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
835 ;; (let ((user nil)
836 ;; ;; Abbreviate, so as to stop when we cross ~/.
837 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
838 ;; files)
839 ;; (while (and dir
840 ;; ;; As a heuristic, we stop looking up the hierarchy of
841 ;; ;; directories as soon as we find a directory belonging to
842 ;; ;; another user. This should save us from looking in
843 ;; ;; things like /net and /afs. This assumes that all the
844 ;; ;; files inside a project belong to the same user.
845 ;; (let ((prev-user user))
846 ;; (setq user (nth 2 (file-attributes dir)))
847 ;; (or (null prev-user) (equal user prev-user))))
848 ;; (if (setq files (condition-case nil
849 ;; (directory-files dir 'full regexp 'nosort)
850 ;; (error nil)))
851 ;; (throw 'found files)
852 ;; (if (equal dir
853 ;; (setq dir (file-name-directory
854 ;; (directory-file-name dir))))
855 ;; (setq dir nil))))
856 ;; nil)))
859 "Look up the directory hierarchy from FILE for a file named NAME.
860 Stop at the first parent directory containing a file NAME,
861 and return the directory. Return nil if not found."
862 ;; We used to use the above locate-dominating-files code, but the
863 ;; directory-files call is very costly, so we're much better off doing
864 ;; multiple calls using the code in here.
865 ;;
866 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
867 ;; `name' in /home or in /.
870 ;; `user' is not initialized outside the loop because
871 ;; `file' may not exist, so we may have to walk up part of the
872 ;; hierarchy before we find the "initial UID". Note: currently unused
873 ;; (user nil)
874 try)
877 ;; FIXME: Disabled this heuristic because it is sometimes
878 ;; inappropriate.
879 ;; As a heuristic, we stop looking up the hierarchy of
880 ;; directories as soon as we find a directory belonging
881 ;; to another user. This should save us from looking in
882 ;; things like /net and /afs. This assumes that all the
883 ;; files inside a project belong to the same user.
884 ;; (let ((prev-user user))
885 ;; (setq user (nth 2 (file-attributes file)))
886 ;; (and prev-user (not (equal user prev-user))))
893 root))
897 "Search for COMMAND in `exec-path' and return the absolute file name.
898 Return nil if COMMAND is not found anywhere in `exec-path'."
899 ;; Use 1 rather than file-executable-p to better match the behavior of
900 ;; call-process.
904 "Load the Emacs Lisp library named LIBRARY.
905 This is an interface to the function `load'. LIBRARY is searched
906 for in `load-path', both with and without `load-suffixes' (as
907 well as `load-file-rep-suffixes').
909 See Info node `(emacs)Lisp Libraries' for more details.
910 See `load-file' for a different interface to `load'."
914 load-path
919 "Test whether FILE specifies a location on a remote system.
920 Returns nil or a string identifying the remote connection (ideally
921 a prefix of FILE). For example, the remote identification for filename
924 less reliable than accessing local files.
925 Furthermore, relative file names do not work across remote connections.
927 IDENTIFICATION specifies which part of the identification shall
928 be returned as string. IDENTIFICATION can be the symbol
929 `method', `user', `host' or `localname'; any other value is
930 handled like nil and means to return the complete identification
931 string.
933 If CONNECTED is non-nil, the function returns an identification only
934 if FILE is located on a remote system, and a connection is established
935 to that remote system.
937 `file-remote-p' will never open a connection on its own."
941 nil)))
944 "Whether to use the remote file-name cache for read access.
946 When `nil', always use the cached values.
947 When `t', never use them.
948 A number means use them for that amount of seconds since they were
949 cached.
951 File attributes of remote files are cached for better performance.
952 If they are changed out of Emacs' control, the cached values
953 become invalid, and must be invalidated.
955 In case a remote file is checked regularly, it might be
956 reasonable to let-bind this variable to a value less then the
957 time period between two checks.
958 Example:
960 (defun display-time-file-nonempty-p (file)
961 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
962 (and (file-exists-p file)
963 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
974 "Copy the file FILE into a temporary file on this machine.
975 Returns the name of the local copy, or nil, if FILE is directly
976 accessible."
977 ;; This formerly had an optional BUFFER argument that wasn't used by
978 ;; anything.
982 nil)))
985 "Return the truename of FILENAME.
986 If FILENAME is not absolute, first expands it against `default-directory'.
987 The truename of a file name is found by chasing symbolic links
988 both at the level of the file and at the level of the directories
989 containing it, until no links are left at any level.
992 ;; COUNTER and PREV-DIRS are only used in recursive calls.
993 ;; COUNTER can be a cons cell whose car is the count of how many
994 ;; more links to chase before getting an error.
995 ;; PREV-DIRS can be a cons cell whose car is an alist
996 ;; of truenames we've just recently computed.
1010 ;; For speed, remove the ange-ftp completion handler from the list.
1011 ;; We know it's not needed here.
1012 ;; For even more speed, do this only on the outermost call.
1019 ;; andrewi@harlequin.co.uk - none of the following code (except for
1020 ;; invoking the file-name handler) currently applies on Windows
1021 ;; (ie. there are no native symlinks), but there is an issue with
1022 ;; case differences being ignored by the OS, and short "8.3 DOS"
1023 ;; name aliases existing for all files. (The short names are not
1024 ;; reported by directory-files, but can be used to refer to files.)
1025 ;; It seems appropriate for file-truename to resolve these issues in
1026 ;; the most natural way, which on Windows is to call the function
1027 ;; `w32-long-file-name' - this returns the exact name of a file as
1028 ;; it is stored on disk (expanding short name aliases with the full
1029 ;; name in the process).
1032 ;; For file name that has a special handler, call handler.
1033 ;; This is so that ange-ftp can save time by doing a no-op.
1036 ;; If filename contains a wildcard, newname will be the old name.
1038 ;; If filename exists, use the long name. If it doesn't exist,
1039 ;; drill down until we find a directory that exists, and use
1040 ;; the long name of that, with the extra non-existent path
1041 ;; components concatenated.
1043 missing rest)
1046 ;; Include the preceding directory separator in the missing
1047 ;; part so subsequent recursion on the rest works.
1052 ""
1057 ;; If this file directly leads to a link, process that iteratively
1058 ;; so that we don't use lots of stack.
1064 ;; For file name that has a special handler, call handler.
1065 ;; This is so that ange-ftp can save time by doing a no-op.
1068 done t)
1070 target dirfile)
1071 ;; Get the truename of the directory.
1073 ;; If these are equal, we have the (or a) root directory.
1075 ;; If this is the same dir we last got the truename for,
1076 ;; save time--don't recalculate.
1086 done t)
1089 done t)
1090 ;; Put it back on the file name.
1092 ;; Is the file name the name of a link?
1095 ;; Yes => chase that link, then start all over
1096 ;; since the link may point to a directory name that uses links.
1097 ;; We can't safely use expand-file-name here
1098 ;; since target might look like foo/../bar where foo
1099 ;; is itself a link. Instead, we handle . and .. above.
1102 target
1104 done nil)
1105 ;; No, we are done!
1107 filename))
1110 "Chase links in FILENAME until a name that is not a link.
1111 Unlike `file-truename', this does not check whether a parent
1112 directory name is a symbolic link.
1113 If the optional argument LIMIT is a number,
1114 it means chase no more than that many links and then stop."
1122 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1125 ;; Handle `..' by hand, since it needs to work in the
1126 ;; target of any directory symlink.
1127 ;; This code is not quite complete; it does not handle
1128 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1132 ;; Chase links in the default dir of the symlink.
1136 ;; Now find the parent of that dir.
1140 newname))
1142 ;; A handy function to display file sizes in human-readable form.
1143 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1145 "Produce a string showing FILE-SIZE in human-readable form.
1147 Optional second argument FLAVOR controls the units and the display format:
1149 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1151 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1153 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1156 1024.0
1159 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1165 "%.1f%s%s"
1167 file-size
1169 "K"
1174 "Create a temporary file.
1175 The returned file name (created by appending some random characters at the end
1176 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1177 is guaranteed to point to a newly created empty file.
1178 You can then use `write-region' to write new data into the file.
1180 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1182 If SUFFIX is non-nil, add that at the end of the file name."
1184 file)
1187 ;; Create temp files with strict access rights. It's easy to
1188 ;; loosen them later, whereas it's impossible to close the
1189 ;; time-window of loose permissions otherwise.
1197 temporary-file-directory)
1199 temporary-file-directory))))
1205 nil)
1207 ;; the file was somehow created by someone else between
1208 ;; `make-temp-name' and `write-region', let's try again.
1209 nil)
1210 file)
1211 ;; Reset the umask.
1215 "Change the encoding of FILE's name from CODING to NEW-CODING.
1216 The value is a new name of FILE.
1217 Signals a `file-already-exists' error if a file of the new name
1218 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1219 is non-nil. A number as fourth arg means request confirmation if
1220 the new name already exists. This is what happens in interactive
1221 use with M-x."
1224 default-file-name-coding-system))
1226 from-coding to-coding)
1228 ;; We provide the default coding only when it seems that
1229 ;; the filename is correctly decoded by the default
1230 ;; coding.
1236 filename default-coding)
1237 default-coding))
1241 ;; We provide the default coding only when a user is going to
1242 ;; change the encoding not from the default coding.
1246 filename from-coding)))
1249 filename from-coding default-coding)
1250 default-coding)))
1254 default-file-name-coding-system))
1255 ;; FILE should have been decoded by DEFAULT-CODING.
1259 ;; Suppress further encoding.
1264 newname))
1265 \f
1267 "Whether confirmation is requested before visiting a new file or buffer.
1268 If nil, confirmation is not requested.
1269 If the value is `after-completion', confirmation is only
1270 requested if the user called `minibuffer-complete' right before
1271 `minibuffer-complete-and-exit'.
1272 Any other non-nil value means to request confirmation.
1274 This affects commands like `switch-to-buffer' and `find-file'."
1282 "Whether to request confirmation before visiting a new file or buffer.
1283 The variable `confirm-nonexistent-file-or-buffer' determines the
1284 return value, which may be passed as the REQUIRE-MATCH arg to
1285 `read-buffer' or `find-file-read-args'."
1293 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1294 BODY should use the minibuffer at most once.
1295 Recursive uses of the minibuffer are unaffected (FUN is not
1296 called additional times).
1298 This macro actually adds an auxiliary function that calls FUN,
1299 rather than FUN itself, to `minibuffer-setup-hook'."
1305 ;; Clear out this hook so it does not interfere
1306 ;; with any recursive minibuffer usage.
1317 t))
1320 "Edit file FILENAME.
1321 Switch to a buffer visiting file FILENAME,
1322 creating one if none already exists.
1323 Interactively, the default if you just type RET is the current directory,
1324 but the visited file name is available through the minibuffer history:
1325 type M-n to pull it into the minibuffer.
1327 You can visit files on remote machines by specifying something
1328 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1329 also visit local files as a different user by specifying
1330 /sudo::FILE for the file name.
1331 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1332 manual, for more about this.
1334 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1335 expand wildcards (if any) and visit multiple files. You can
1336 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1338 To visit a file without any kind of conversion and without
1349 "Edit file FILENAME, in another window.
1352 an existing one. See the function `display-buffer'.
1354 Interactively, the default if you just type RET is the current directory,
1355 but the visited file name is available through the minibuffer history:
1356 type M-n to pull it into the minibuffer.
1358 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1359 expand wildcards (if any) and visit multiple files."
1372 "Edit file FILENAME, in another frame.
1375 an existing one. See the function `display-buffer'.
1377 Interactively, the default if you just type RET is the current directory,
1378 but the visited file name is available through the minibuffer history:
1379 type M-n to pull it into the minibuffer.
1381 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1382 expand wildcards (if any) and visit multiple files."
1395 "Edit the existing file FILENAME.
1397 file names with wildcards."
1406 "Edit file FILENAME but don't allow changes.
1420 value))
1423 "Edit file FILENAME in another window but don't allow changes.
1437 value))
1440 "Edit file FILENAME in another frame but don't allow changes.
1454 value))
1457 "Find file FILENAME as a replacement for the file in the next window.
1458 This command does not select that window.
1462 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1463 expand wildcards (if any) and replace the file with multiple files."
1474 "Find alternate file: " file-dir nil
1476 t))))
1486 "Find file FILENAME, select its buffer, kill previous buffer.
1487 If the current buffer now contains an empty file that you just visited
1488 \(presumably by mistake), use this command to visit the file you really want.
1492 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1493 expand wildcards (if any) and replace the file with multiple files.
1495 If the current buffer is an indirect buffer, or the base buffer
1496 for one or more indirect buffers, the other buffer(s) are not
1497 killed."
1506 "Find alternate file: " file-dir nil
1508 t)))
1523 ;; Run `kill-buffer-hook' here. It needs to happen before
1524 ;; variables like `buffer-file-name' etc are set to nil below,
1525 ;; because some of the hooks that could be invoked
1526 ;; (e.g., `save-place-to-alist') depend on those variables.
1527 ;;
1528 ;; Note that `kill-buffer-hook' is not what queries whether to
1529 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1530 ;; asks that itself. Thus, there's no need to temporarily do
1531 ;; `(set-buffer-modified-p nil)' before running this hook.
1533 ;; Okay, now we can end-of-life the old buffer.
1540 ;; This prevents us from finding the same buffer
1541 ;; if we specified the same file again.
1545 ;; Likewise for dired buffers.
1549 ;; This executes if find-file gets an error
1550 ;; and does not really find anything.
1551 ;; We put things back as they were.
1552 ;; If find-file actually finds something, we kill obuf below.
1561 ;; We already ran these; don't run them again.
1564 \f
1566 "Create a suitably named buffer for visiting FILENAME, and return it.
1567 FILENAME (sans directory) is used unchanged if that name is free;
1568 otherwise a string <2> or <3> or ... is appended to get an unused name.
1569 Spaces at the start of FILENAME (sans directory) are removed."
1578 "Create and return a buffer with a name based on NAME.
1579 Choose the buffer's name using `generate-new-buffer-name'."
1583 "Regexp to match the automounter prefix in a directory name."
1591 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1593 home directory is a root directory) and removes automounter prefixes
1594 \(see the variable `automount-dir-prefix')."
1595 ;; Get rid of the prefixes added by the automounter.
1602 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1603 ;; To fix this right, we need a `file-name-case-sensitive-p'
1604 ;; function, but we don't have that yet, so just guess.
1607 ;; If any elt of directory-abbrev-alist matches this name,
1608 ;; abbreviate accordingly.
1614 ;; Compute and save the abbreviated homedir name.
1615 ;; We defer computing this until the first time it's needed, to
1616 ;; give time for directory-abbrev-alist to be set properly.
1617 ;; We include a slash at the end, to avoid spurious matches
1618 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1625 ;; If FILENAME starts with the abbreviated homedir,
1626 ;; make it start with `~' instead.
1628 ;; If the home dir is just /, don't change it.
1631 ;; MS-DOS root directories can come with a drive letter;
1632 ;; Novell Netware allows drive letters beyond `Z:'.
1640 filename)))
1643 "Return the buffer visiting file FILENAME (a string).
1644 This is like `get-file-buffer', except that it checks for any buffer
1645 visiting the same file, possibly under a different name.
1646 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1647 and others are ignored.
1648 If there is no such live buffer, return nil."
1661 found)
1671 ;; Verify this buffer's file number
1672 ;; still belongs to its file.
1675 attributes)
1679 found))))
1680 \f
1682 "Non-nil means file-visiting commands should handle wildcards.
1683 For example, if you specify `*.c', that would visit all the files
1684 whose names match the pattern."
1690 "Non-nil means suppress warning messages for symlinked files.
1691 When nil, Emacs prints a warning when visiting a file that is already
1692 visited, but with a different name. Setting this option to t
1693 suppresses this warning."
1699 "Maximum size of file above which a confirmation is requested.
1700 When nil, never request confirmation."
1707 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1708 OP-TYPE specifies the file operation being performed (for message to user)."
1717 "Read file FILENAME into a buffer and return the buffer.
1718 If a buffer exists visiting FILENAME, return that one, but
1719 verify that the file has not changed since visited or saved.
1720 The buffer is not selected, just returned to the caller.
1721 Optional second arg NOWARN non-nil means suppress any warning messages.
1722 Optional third arg RAWFILE non-nil means the file is read literally.
1723 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1724 and visit all the matching files. When wildcards are actually
1725 used and expanded, return a list of buffers that are visiting
1726 the various files."
1733 'find-directory-functions
1736 filename)))
1739 find-file-wildcards
1753 ;; Find any buffer for a file which has same truename.
1755 ;; Let user know if there is a buffer with the same truename.
1759 find-file-suppress-same-file-warnings
1763 ;; Optionally also find that buffer.
1766 ;; Check to see if the file looks uncommonly large.
1770 ;; We are using an existing buffer.
1777 ;; Certain files should be reverted automatically
1778 ;; if they have changed on disk and not in the buffer.
1786 found))
1796 "File %s changed on disk. Discard your edits? "
1801 "File %s changed on disk. Discard your edits in %s? "
1809 ;; Check if a formerly read-only file has become
1810 ;; writable and vice versa, but if the buffer agrees
1811 ;; with the new state of the file, that is ok too.
1819 buffer-file-name
1828 ;; It is confusing to ask whether to visit
1829 ;; non-literally if they have the file in
1830 ;; hexl-mode or image-mode.
1836 "The file %s is already visited normally,
1837 and you have edited the buffer. Now you have asked to visit it literally,
1838 meaning no coding system handling, format conversion, or local variables.
1839 Emacs can only visit a file in one way at a time.
1841 Do you want to save the file, and visit it literally instead? "
1842 "The file %s is already visited literally,
1843 meaning no coding system handling, format conversion, or local variables.
1844 You have edited the buffer. Now you have asked to visit the file normally,
1845 but Emacs can only visit a file in one way at a time.
1852 rawfile truename number))
1856 "\
1857 Do you want to discard your changes, and visit the file literally now? "
1858 "\
1861 rawfile truename number)
1867 "The file %s is already visited normally.
1868 You have asked to visit it literally,
1869 meaning no coding system decoding, format conversion, or local variables.
1870 But Emacs can only visit a file in one way at a time.
1872 Do you want to revisit the file literally now? "
1873 "The file %s is already visited literally,
1874 meaning no coding system decoding, format conversion, or local variables.
1875 You have asked to visit it normally,
1876 but Emacs can only visit a file in one way at a time.
1881 rawfile truename number)
1884 ;; Return the buffer we are using.
1885 buf)
1886 ;; Create a new buffer.
1888 ;; find-file-noselect-1 may use a different buffer.
1890 rawfile truename number))))))
1896 ;; Needed in case we are re-visiting the file with a different
1897 ;; text representation.
1914 filename)))
1915 ;; Unconditionally set error
1925 filename)))
1926 ;; Run find-file-not-found-functions until one returns non-nil.
1928 ;; If they fail too, set error.
1930 ;; Record the file's truename, and maybe use that as visited name.
1938 ;; Set buffer's default directory to that of the file.
1940 ;; Turn off backup files for certain file names. Since
1941 ;; this is a permanent local, the major mode won't eliminate it.
1956 \f
1958 "Like `insert-file-contents', but only reads in the file literally.
1959 A buffer may be modified in several ways after reading into the buffer,
1960 to Emacs features such as format decoding, character code
1961 conversion, `find-file-hook', automatic uncompression, etc.
1963 This function ensures that none of these modifications will take place."
1971 nil))
1974 inhibit-file-name-handlers))
1987 filename)))
1988 ;; Check whether the file is uncommonly large
1999 "Insert contents of file FILENAME into buffer after point with no conversion.
2001 This function is meant for the user to run interactively.
2002 Don't call it from programs! Use `insert-file-contents-literally' instead.
2003 \(Its calling sequence is different; see its documentation)."
2008 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2009 This has the `permanent-local' property, which takes effect if you
2014 "Visit file FILENAME with no conversion of any kind.
2015 Format conversion and character code conversion are both disabled,
2016 and multibyte characters are disabled in the resulting buffer.
2017 The major mode used is Fundamental mode regardless of the file name,
2018 and local variable specifications in the file are ignored.
2019 Automatic uncompression and adding a newline at the end of the
2020 file due to `require-final-newline' is also disabled.
2022 You cannot absolutely rely on this function to result in
2023 visiting the file literally. If Emacs already has a buffer
2024 which is visiting the file, you get the existing buffer,
2025 regardless of whether it was created literally or not.
2027 In a Lisp program, if you want to be sure of accessing a file's
2028 contents literally, you should create a temporary buffer and then read
2029 the file contents into it using `insert-file-contents-literally'."
2032 "Find file literally: " nil default-directory
2035 \f
2037 _after-find-file-from-revert-buffer
2038 nomodes)
2039 "Called after finding a file and by the default revert function.
2040 Sets buffer mode, parses local variables.
2041 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2042 error in reading the file. WARN non-nil means warn if there
2043 exists an auto-save file more recent than the visited file.
2044 NOAUTO means don't mess with auto-save mode.
2045 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2046 \(see `revert-buffer-in-progress-p' for similar functionality).
2047 Fifth arg NOMODES non-nil means don't alter the file's modes.
2048 Finishes by calling the functions in `find-file-hook'
2049 unless NOMODES is non-nil."
2052 nil
2062 "Symbolic link that points to nonexistent file"
2066 ;; No need to warn if buffer is auto-saved
2067 ;; under the name of the visited file.
2069 auto-save-visited-file-name))
2072 buffer-file-name))
2092 ;; Make people do a little extra work (C-x C-q)
2093 ;; before altering a backup file.
2096 ;; When a file is marked read-only,
2097 ;; make the buffer read-only even if root is looking at it.
2105 ;; If requested, add a newline at the end of the file.
2115 view-read-only
2121 "Eval BODY and turn any error into a FORMAT message.
2122 FORMAT can have a %s escape which will be replaced with the actual error.
2123 If `debug-on-error' is set, errors are not caught, so that you can
2124 debug them.
2125 Avoid using a large BODY since it is duplicated."
2134 "Choose the major mode for this buffer automatically.
2135 Also sets up any specified local variables of the file.
2136 Uses the visited file name, the -*- line, and the local variables spec.
2138 This function is called automatically from `find-file'. In that case,
2139 we may set up the file-specified mode and local variables,
2140 depending on the value of `enable-local-variables'.
2141 In addition, if `local-enable-local-variables' is nil, we do
2142 not set local variables (though we do notice a mode specified with -*-.)
2144 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2145 or from Lisp without specifying the optional argument FIND-FILE;
2146 in that case, this function acts as if `enable-local-variables' were t."
2150 ;; FIXME this is less efficient than it could be, since both
2151 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2156 ;; Turn font lock off and on, to make sure it takes account of
2157 ;; whatever file local variables are relevant to it.
2159 ;; Font-lock-mode (now in font-core.el) can be ON when
2160 ;; font-lock.el still hasn't been loaded.
2170 "Non-nil means to try second pass through `auto-mode-alist'.
2171 This means that if the first case-sensitive search through the alist fails
2172 to find a matching major mode, a second case-insensitive search is made.
2173 On systems with case-insensitive file names, this variable is ignored,
2174 since only a single case-insensitive search through the alist is made."
2180 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2181 ;; c++-mode, java-mode and more) are added through autoload
2182 ;; directives in that file. That way is discouraged since it
2183 ;; spreads out the definition of the initial value.
2227 ;; Less common extensions come here
2228 ;; so more common ones above are found faster.
2236 ;; Besides .gdbinit, gdb documents other names to be usable for init
2237 ;; files, cross-debuggers can use something like
2238 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2239 ;; don't interfere with each other.
2271 ;; The Fortran standard does not say anything about file extensions.
2272 ;; .f90 was widely used for F90, now we seem to be trapped into
2273 ;; using a different extension for each language revision.
2274 ;; Anyway, the following extensions are supported by gfortran.
2282 ;; The list of archive file extensions should be in sync with
2283 ;; `auto-coding-alist' with `no-conversion' coding system.
2289 ;; Mailer puts message to be edited in
2290 ;; /tmp/Re.... or Message
2293 ;; some news reader is reported to use this
2304 ;; .emacs or .gnus or .viper following a directory delimiter in
2305 ;; Unix, MSDOG or VMS syntax.
2308 ;; _emacs following a directory delimiter
2309 ;; in MsDos syntax
2313 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2314 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2315 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2318 ;; .xs is also used for ld scripts, but seems to be more commonly
2319 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2321 ;; Explained in binutils ld/genscripts.sh. Eg:
2322 ;; A .x script file is the default script.
2323 ;; A .xr script is for linking without relocation (-r flag). Etc.
2327 ;; Common Lisp ASDF package system.
2334 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2346 ;; Windows candidates may be opened case sensitively on Unix
2352 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2353 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2354 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2355 ;; this has lower priority to avoid matching changelog.sgml etc.
2357 ;; either user's dot-files or under /etc or some such
2359 ;; alas not all ~/.*rc files are like this
2360 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2365 ;; this contains everything twice, with space and with colon :-(
2367 ;; Get rid of any trailing .n.m and try again.
2368 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2369 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2370 ;; Using mode nil rather than `ignore' would let the search continue
2371 ;; through this list (with the shortened name) rather than start over.
2374 ;; This should come after "in" stripping (e.g. config.h.in).
2375 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2377 ;; The following should come after the ChangeLog pattern
2378 ;; for the sake of ChangeLog.1, etc.
2379 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2381 "Alist of filename patterns vs corresponding major mode functions.
2382 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2383 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2384 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2385 mode function to use. FUNCTION will be called, unless it is nil.
2387 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2388 calling FUNCTION (if it's not nil), we delete the suffix that matched
2389 REGEXP and search the list again for another match.
2391 If the file name matches `inhibit-first-line-modes-regexps',
2392 then `auto-mode-alist' is not processed.
2394 The extensions whose FUNCTION is `archive-mode' should also
2395 appear in `auto-coding-alist' with `no-conversion' coding system.
2397 See also `interpreter-mode-alist', which detects executable script modes
2398 based on the interpreters they specify to run,
2403 "Select Conf mode or XML mode according to start of file."
2413 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2414 ;; and pike-mode) are added through autoload directives in that
2415 ;; file. That way is discouraged since it spreads out the
2416 ;; definition of the initial value.
2456 "Alist mapping interpreter names to major modes.
2457 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2458 Each element looks like (INTERPRETER . MODE).
2459 If INTERPRETER matches the name of the interpreter specified in the first line
2460 of a script, mode MODE is enabled.
2470 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2471 When checking `inhibit-first-line-modes-regexps', we first discard
2477 "Regexp matching interpreters, for file mode determination.
2478 This regular expression is matched against the first line of a file
2479 to determine the file's mode in `set-auto-mode'. If it matches, the file
2480 is assumed to be interpreted by the interpreter matched by the second group
2481 of the regular expression. The mode is then determined as the mode
2485 "Alist of buffer beginnings vs. corresponding major mode functions.
2486 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2487 After visiting a file, if REGEXP matches the text at the beginning of the
2488 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2489 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2490 major mode.
2492 If FUNCTION is nil, then it is not called. (That is a way of saying
2500 ;; The < comes before the groups (but the first) to reduce backtracking.
2501 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2502 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2506 comment-re "*"
2509 . html-mode)
2511 ;; These two must come after html, because they are more general:
2516 . sgml-mode)
2519 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2520 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2521 After visiting a file, if REGEXP matches the text at the beginning of the
2522 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2523 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2524 have not specified a mode for this file.
2530 "Upper limit on `magic-mode-alist' regexp matches.
2534 "Select major mode appropriate for current buffer.
2536 To find the right major mode, this function checks for a -*- mode tag,
2537 checks for a `mode:' entry in the Local Variables section of the file,
2538 checks if it uses an interpreter listed in `interpreter-mode-alist',
2539 matches the buffer beginning against `magic-mode-alist',
2540 compares the filename against the entries in `auto-mode-alist',
2541 then matches the buffer beginning against `magic-fallback-mode-alist'.
2543 If `enable-local-variables' is nil, this function does not check for
2544 any mode: tag anywhere in the file.
2546 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2547 set the major mode only if that would change it. In other words
2548 we don't actually set it to the same mode the buffer already has."
2549 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2551 ;; Once we drop the deprecated feature where mode: is also allowed to
2552 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2553 ;; remove this section and just let (hack-local-variables t) handle it.
2554 ;; Find a -*- mode tag.
2561 ;; Find all specifications for the `mode:' variable
2562 ;; and execute them left to right.
2574 modes)))
2575 ;; Simple -*-MODE-*- case.
2578 modes))))
2579 ;; If we found modes to use, invoke them now, outside the save-excursion.
2587 ;; continuing would call minor modes again, toggling them off
2590 enable-local-variables
2597 ;; If we didn't, look for an interpreter specified in the first line.
2598 ;; As a special case, allow for things like "#!/bin/env perl", which
2599 ;; finds the interpreter anywhere in $PATH.
2606 ;; Map interpreter name to a mode, signaling we're done at the
2607 ;; same time.
2609 interpreter-mode-alist))
2610 ;; If we found an interpreter mode to use, invoke it now.
2613 ;; Next try matching the buffer beginning against magic-mode-alist.
2627 ;; Next compare the filename against the entries in auto-mode-alist.
2632 ;; Remove backup-suffixes from file name.
2634 ;; Remove remote file name identification.
2639 ;; Find first matching alist entry.
2642 ;; System is case-insensitive.
2646 ;; System is case-sensitive.
2648 ;; First match case-sensitively.
2652 ;; Fallback to case-insensitive match.
2666 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2681 ;; When `keep-mode-if-same' is set, we are working on behalf of
2682 ;; set-visited-file-name. In that case, if the major mode specified is the
2683 ;; same one we already have, don't actually reset it. We don't want to lose
2684 ;; minor modes such as Font Lock.
2686 "Apply MODE and return it.
2687 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2688 any aliases and compared to current major mode. If they are the
2689 same, do nothing and return nil."
2695 mode)))
2698 "Find the -*- spec in the buffer.
2699 Call with point at the place to start searching from.
2700 If one is found, set point to the beginning
2701 and return the position of the end.
2702 Otherwise, return nil; point may be changed."
2705 ;; Don't look for -*- if this file name matches any
2706 ;; of the regexps in inhibit-first-line-modes-regexps.
2714 sufs)
2722 ;; If the file begins with "#!"
2723 ;; (exec interpreter magic), look
2724 ;; for mode frobs in the first two
2725 ;; lines. You cannot necessarily
2726 ;; put them in the first line of
2727 ;; such a file without screwing up
2728 ;; the interpreter invocation.
2729 ;; The same holds for
2730 ;; '\"
2731 ;; in man pages (preprocessor
2732 ;; magic for the `man' program).
2743 end))))
2744 \f
2745 ;;; Handling file local variables
2749 file-local-variables-alist dir-local-variables-alist)
2754 "Normal hook run after processing a file's local variables specs.
2755 Major modes can use this to examine user-specified local variables
2759 "List variable-value pairs that are considered safe.
2760 Each element is a cons cell (VAR . VAL), where VAR is a variable
2761 symbol and VAL is a value that is considered safe."
2762 :risky t
2767 ;; This should be here at least as long as Emacs supports write-file-hooks.
2771 "Expressions that are considered safe in an `eval:' local variable.
2772 Add expressions to this list if you want Emacs to evaluate them, when
2773 they appear in an `eval' local variable specification, without first
2774 asking you for confirmation."
2775 :risky t
2780 ;; Risky local variables:
2783 buffer-auto-save-file-name
2784 buffer-file-name
2785 buffer-file-truename
2786 buffer-undo-list
2787 debugger
2788 default-text-properties
2789 eval
2790 exec-directory
2791 exec-path
2792 file-name-handler-alist
2793 frame-title-format
2794 global-mode-string
2795 header-line-format
2796 icon-title-format
2797 inhibit-quit
2798 load-path
2799 max-lisp-eval-depth
2800 max-specpdl-size
2801 minor-mode-map-alist
2802 minor-mode-overriding-map-alist
2803 mode-line-format
2804 mode-name
2805 overriding-local-map
2806 overriding-terminal-local-map
2807 process-environment
2808 standard-input
2809 standard-output
2810 unread-command-events))
2812 ;; Safe local variables:
2813 ;;
2814 ;; For variables defined by major modes, the safety declarations can go into
2815 ;; the major mode's file, since that will be loaded before file variables are
2816 ;; processed.
2817 ;;
2818 ;; For variables defined by minor modes, put the safety declarations in the
2819 ;; file defining the minor mode after the defcustom/defvar using an autoload
2820 ;; cookie, e.g.:
2821 ;;
2822 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2823 ;;
2824 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2825 ;; minor mode file may not be loaded yet.
2826 ;;
2827 ;; For variables defined in the C source code the declaration should go here:
2849 "Alist of file-local variable settings in the current buffer.
2850 Each element in this list has the form (VAR . VALUE), where VAR
2851 is a file-local variable (a symbol) and VALUE is the value
2852 specified. The actual value in the buffer may differ from VALUE,
2858 "Alist of directory-local variable settings in the current buffer.
2859 Each element in this list has the form (VAR . VALUE), where VAR
2860 is a directory-local variable (a symbol) and VALUE is the value
2861 specified in .dir-locals.el. The actual value in the buffer
2862 may differ from VALUE, if it is changed by the major or minor modes,
2867 "Normal hook run before setting file-local variables.
2868 It is called after checking for unsafe/risky variables and
2869 setting `file-local-variables-alist', and before applying the
2870 variables stored in `file-local-variables-alist'. A hook
2871 function is allowed to change the contents of this alist.
2873 This hook is called only if there is at least one file-local
2877 "Get confirmation before setting up local variable values.
2878 ALL-VARS is the list of all variables to be set up.
2879 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2880 RISKY-VARS is the list of those that are marked as risky.
2881 If these settings come from directory-local variables, then
2882 DIR-NAME is the name of the associated directory. Otherwise it is nil."
2884 nil
2891 unsafe-vars))
2895 prompt char)
2903 ", and variables that are risky (**)."
2911 y -- to apply the local variables list.
2915 ! -- to apply the local variables list, and permanently mark these
2927 ;; Make strings with embedded whitespace easier to read.
2935 ""
2952 "Return local variables specified in the -*- line.
2953 Returns an alist of elements (VAR . VAL), where VAR is a variable
2954 and VAL is the specified value. Ignores any specification for
2955 `mode:' and `coding:' (which should have already been handled
2956 by `set-auto-mode' and `set-auto-coding', respectively).
2957 Return nil if the -*- line is malformed.
2959 If MODE-ONLY is non-nil, just returns the symbol specifying the
2960 mode, if there is one, otherwise nil."
2965 result)
2967 nil)
2969 ;; Simple form: "-*- MODENAME -*-".
2973 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2974 ;; (last ";" is optional).
2975 ;; If MODE-ONLY, just check for `mode'.
2976 ;; Otherwise, parse the -*- line into the RESULT alist.
2984 ;; There used to be a downcase here,
2985 ;; but the manual didn't say so,
2986 ;; and people want to set var names that aren't all lc.
2992 ;; It is traditional to ignore
2993 ;; case when checking for `mode' in set-auto-mode,
2994 ;; so we must do that here as well.
2995 ;; That is inconsistent, but we're stuck with it.
2996 ;; The same can be said for `coding' in set-auto-coding.
3006 ;; Downcase "Mode:".
3012 result))))))
3015 "Filter local variable settings, querying the user if necessary.
3016 VARIABLES is the alist of variable-value settings. This alist is
3017 filtered based on the values of `ignored-local-variables',
3018 `enable-local-eval', `enable-local-variables', and (if necessary)
3019 user interaction. The results are added to
3020 `file-local-variables-alist', without applying them.
3021 If these settings come from directory-local variables, then
3022 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3023 ;; Find those variables that we may want to save to
3024 ;; `safe-local-variable-values'.
3030 ;; Ignore any variable in `ignored-local-variables'.
3031 nil)
3032 ;; Obey `enable-local-eval'.
3040 ;; Ignore duplicates (except `mode') in the present list.
3042 ;; Accept known-safe variables.
3046 ;; The variable is either risky or unsafe:
3053 ;; Query, unless all vars are safe or user wants no querying.
3059 risky-vars dir-name))
3070 "Parse and put into effect this buffer's local variables spec.
3071 Uses `hack-local-variables-apply' to apply the variables.
3074 is specified, and return the corresponding mode symbol, or nil.
3075 In this case, we try to ignore minor-modes, and only return a
3076 major-mode."
3079 result)
3085 ;; If MODE-ONLY is non-nil, and the prop line specifies a mode,
3086 ;; then we're done, and have no need to scan further.
3088 mode-only)
3089 ;; Look for "Local variables:" line in last page.
3097 ;; suffix is what comes after "local variables:" in its line.
3098 ;; prefix is what comes before "local variables:" in its line.
3108 beg)
3112 endpos
3118 nil t))
3119 ;; This used to be an error, but really all it means is
3120 ;; that this may simply not be a local-variables section,
3121 ;; so just ignore it.
3131 ;; Discard the prefix.
3136 ;; Discard the suffix.
3146 ;; Find the variable name; strip whitespace.
3155 val val2)
3158 ;; Read the variable value.
3165 ;; Specifying minor-modes via mode: is
3166 ;; deprecated, but try to reject them anyway.
3174 'eval
3179 ;; Now we've read all the local variables.
3180 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3182 ;; Otherwise, set the variables.
3188 "Apply the elements of `file-local-variables-alist'.
3189 If there are any elements, runs `before-hack-local-variables-hook',
3190 then calls `hack-one-local-variable' to apply the alist elements one by one.
3191 Finishes by running `hack-local-variables-hook', regardless of whether
3192 the alist is empty or not.
3194 Note that this function ignores a `mode' entry if it specifies the same
3195 major mode as the buffer already has."
3197 ;; Any 'evals must run in the Right sequence.
3206 "Non-nil if SYM is safe as a file-local variable with value VAL.
3207 It is safe if any of these conditions are met:
3209 * There is a matching entry (SYM . VAL) in the
3210 `safe-local-variable-values' user option.
3212 * The `safe-local-variable' property of SYM is a function that
3213 evaluates to a non-nil value with VAL as an argument."
3217 ;; If the function signals an error, that means it
3218 ;; can't assure us that the value is safe.
3222 "Non-nil if SYM could be dangerous as a file-local variable.
3223 It is dangerous if either of these conditions are met:
3225 * Its `risky-local-variable' property is non-nil.
3231 ;; If this is an alias, check the base name.
3251 "Return t if it is safe to eval EXP when it is found in a file."
3253 ;; Detect certain `put' expressions.
3260 lisp-indent-function
3261 scheme-indent-function))
3262 ;; Only allow safe values (not functions).
3267 ;; Only allow indirect form specs.
3268 ;; During bootstrapping, edebug-basic-spec might not be
3269 ;; defined yet.
3273 ;; Allow expressions that the user requested.
3275 ;; Certain functions can be allowed with safe arguments
3276 ;; or can specify verification functions to try.
3278 ;; Allow (minor)-modes calls with no arguments.
3279 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3288 ok))
3296 ok))))))))
3299 "Set local variable VAR with value VAL.
3300 If VAR is `mode', call `VAL-mode' as a function unless it's
3301 already the major mode."
3308 ;; A minor mode must be passed an argument.
3309 ;; Otherwise, if the user enables the minor mode in a
3310 ;; major mode hook, this would toggle it off.
3316 ;; Make sure the string has no text properties.
3317 ;; Some text properties can get evaluated in various ways,
3318 ;; so it is risky to put them on with a local variable list.
3322 \f
3323 ;;; Handling directory-local variables, aka project settings.
3329 "List of cached directory roots for directory-local variable classes.
3330 Each element in this list has the form (DIR CLASS MTIME).
3331 DIR is the name of the directory.
3332 CLASS is the name of a variable class (a symbol).
3333 MTIME is the recorded modification time of the directory-local
3334 variables file associated with this entry. This time is a list
3335 of two integers (the same format as `file-attributes'), and is
3336 used to test whether the cache entry is still valid.
3337 Alternatively, MTIME can be nil, which means the entry is always
3341 "Return the variable list for CLASS."
3345 "Collect directory-local variables from MODE-VARIABLES.
3346 VARIABLES is the initial list of variables.
3347 Returns the new list."
3352 ;; If variables are specified more than once, only use the last. (Why?)
3353 ;; The pseudo-variables mode and eval are different (bug#3430).
3356 ;; Need a new cons in case we setcdr later.
3360 "Collect entries from CLASS-VARIABLES into VARIABLES.
3361 ROOT is the root directory of the project.
3362 Return the new variables list."
3365 ;; FIXME: Why not use file-relative-name?
3372 ;; Don't include this in the previous condition, because we
3373 ;; want to filter all strings before the next condition.
3387 ;; TODO someone might want to extend this to allow
3388 ;; integer values for subdir, where N means
3389 ;; variables apply to this directory and N levels
3390 ;; below it (0 == nil).
3393 alist variables))))))))
3395 ;; The file's content might be invalid (e.g. have a merge conflict), but
3396 ;; that shouldn't prevent the user from opening the file.
3398 nil))))
3401 "Declare that the DIRECTORY root is an instance of CLASS.
3402 DIRECTORY is the name of a directory, a string.
3403 CLASS is the name of a project class, a symbol.
3404 MTIME is either the modification time of the directory-local
3405 variables file that defined this class, or nil.
3407 When a file beneath DIRECTORY is visited, the mode-specific
3408 variables from CLASS are applied to the buffer. The variables
3409 for a class are defined using `dir-locals-set-class-variables'."
3416 "Map the type CLASS to a list of variable settings.
3417 CLASS is the project class, a symbol. VARIABLES is a list
3418 that declares directory-local variables for the class.
3419 An element in VARIABLES is either of the form:
3420 (MAJOR-MODE . ALIST)
3421 or
3422 (DIRECTORY . LIST)
3424 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3425 whose elements are of the form (VARIABLE . VALUE).
3427 In the second form, DIRECTORY is a directory name (a string), and
3428 LIST is a list of the form accepted by the function.
3430 When a file is visited, the file's class is found. A directory
3431 may be assigned a class using `dir-locals-set-directory-class'.
3432 Then variables are set in the file's buffer according to the
3433 class' LIST. The list is processed in order.
3435 * If the element is of the form (MAJOR-MODE . ALIST), and the
3436 buffer's major mode is derived from MAJOR-MODE (as determined
3437 by `derived-mode-p'), then all the variables in ALIST are
3438 applied. A MAJOR-MODE of nil may be used to match any buffer.
3439 `make-local-variable' is called for each variable before it is
3440 set.
3442 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3443 is an initial substring of the file's directory, then LIST is
3444 applied by recursively following these rules."
3451 "File that contains directory-local variables.
3452 It has to be constant to enforce uniform values
3456 "Find the directory-local variables for FILE.
3457 This searches upward in the directory tree from FILE.
3458 It stops at the first directory that has been registered in
3459 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3460 If it finds an entry in the cache, it checks that it is valid.
3461 A cache entry with no modification time element (normally, one that
3462 has been assigned directly using `dir-locals-set-directory-class', not
3463 set from a file) is always valid.
3464 A cache entry based on a `dir-locals-file' is valid if the modification
3465 time stored in the cache matches the current file modification time.
3466 If not, the cache entry is cleared so that the file will be re-read.
3468 This function returns either nil (no directory local variables found),
3469 or the matching entry from `dir-locals-directory-cache' (a list),
3470 or the full path to the `dir-locals-file' (a string) in the case
3471 of no valid cache entry."
3476 dir-locals-file))
3479 ;; `locate-dominating-file' may have abbreviated the name.
3482 ;; Find the best cached value in `dir-locals-directory-cache'.
3494 ;; Found a potential cache entry. Check validity.
3495 ;; A cache entry with no MTIME is assumed to always be valid
3496 ;; (ie, set directly, not from a dir-locals file).
3497 ;; Note, we don't bother to check that there is a matching class
3498 ;; element in dir-locals-class-alist, since that's done by
3499 ;; dir-locals-set-directory-class.
3506 ;; This cache entry is OK.
3507 dir-elt
3508 ;; This cache entry is invalid; clear it.
3511 ;; Return the first existing dir-locals file. Might be the same
3512 ;; as dir-elt's, might not (eg latter might have been deleted).
3513 locals-file)
3514 ;; No cache entry.
3515 locals-file)))
3518 "Load a variables FILE and register a new class and instance.
3519 FILE is the name of the file holding the variables to apply.
3520 The new class name is the same as the directory in which FILE
3521 is found. Returns the new class name."
3531 class-name)))
3534 "Read per-directory local variables for the current buffer.
3535 Store the directory-local variables in `dir-local-variables-alist'
3536 and `file-local-variables-alist', without applying them."
3539 ;; Find the variables file.
3566 \f
3569 However, the mode will not be changed if
3570 \(1) a local variables list or the `-*-' line specifies a major mode, or
3572 \ not suitable for ordinary files, or
3573 \(3) the new file name does not particularly specify any mode."
3578 "Change name of file visited in current buffer to FILENAME.
3579 This also renames the buffer to correspond to the new file.
3580 The next time the buffer is saved it will go in the newly specified file.
3581 FILENAME nil or an empty string means mark buffer as not visiting any file.
3582 Remember to delete the initial contents of the minibuffer
3583 if you wish to pass an empty string as the argument.
3585 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3586 confirmation in the case where another buffer is already visiting FILENAME.
3588 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3589 the old visited file has been renamed to the new name FILENAME."
3597 nil
3612 filename)))
3622 ;; If new-name == old-name, renaming would add a spurious <2>
3623 ;; and it's considered as a feature in rename-buffer.
3629 ;; Abbreviate the file names of the buffer.
3638 nil)))
3639 ;; write-file-functions is normally used for things like ftp-find-file
3640 ;; that visit things that are not local files as if they were files.
3641 ;; Changing to visit an ordinary local file instead should flush the hook.
3646 ;; If buffer was read-only because of version control,
3647 ;; that reason is gone now, so make it writable.
3651 ;; Turn off backup files for certain file names.
3652 ;; Since this is a permanent local, the major mode won't eliminate it.
3654 backup-enable-predicate
3660 ;; If auto-save was not already on, turn it on if appropriate.
3664 ;; If auto save is on, start using a new name.
3665 ;; We deliberately don't rename or delete the old auto save
3666 ;; for the old visited file name. This is because perhaps
3667 ;; the user wants to save the new state and then compare with the
3668 ;; previous state from the auto save file.
3671 ;; Rename the old auto save file if any.
3678 ;; Update the major mode, if the file name determines it.
3680 ;; Don't change the mode if it is special.
3683 ;; Don't change the mode if the local variable list specifies it.
3685 ;; TODO consider making normal-mode handle this case.
3693 "Write current buffer into file FILENAME.
3694 This makes the buffer visit that file, and marks it as not modified.
3696 If you specify just a directory name as FILENAME, that means to use
3697 the default file name but in that directory. You can also yank
3698 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3700 If the buffer is not already visiting a file, the default file name
3701 for the output file is the buffer name.
3703 If optional second arg CONFIRM is non-nil, this function
3704 asks for confirmation before overwriting an existing file.
3705 Interactively, confirmation is required unless you supply a prefix argument."
3706 ;; (interactive "FWrite file: ")
3710 nil nil nil nil)
3714 default-directory)
3715 nil nil))
3719 ;; If arg is just a directory,
3720 ;; use the default file name, but in that directory.
3731 ;; Make buffer writable if file is writable.
3736 ;; It's likely that the VC status at the new location is different from
3737 ;; the one at the old location.
3739 \f
3741 "Make a backup of the disk file visited by the current buffer, if appropriate.
3742 This is normally done before saving the buffer the first time.
3744 A backup may be done by renaming or by copying; see documentation of
3745 variable `make-backup-files'. If it's done by renaming, then the file is
3746 no longer accessible under its old name.
3748 The value is non-nil after a backup was made by renaming.
3749 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3750 MODES is the result of `file-modes' on the original
3751 file; this means that the caller, after saving the buffer, should change
3752 the modes of the new file to agree with the old modes.
3753 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3754 file; this means that the caller, after saving the buffer, should change
3755 the SELinux context of the new file to agree with the old context.
3756 BACKUPNAME is the backup file name, which is the old file renamed."
3763 backup-info backupname targets setmodes)
3764 ;; If specified name is a symbolic link, chase it to the target.
3765 ;; Thus we make the backups in the directory where the real file is.
3770 ;; (if (file-directory-p buffer-file-name)
3771 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3775 ;; If have old versions to maybe delete,
3776 ;; ask the user to confirm now, before doing anything.
3777 ;; But don't actually delete til later.
3782 real-file-name)))))
3785 ;; Actually write the back up file.
3788 ; (file-symlink-p buffer-file-name)
3789 backup-by-copying
3790 ;; Don't rename a suid or sgid file.
3805 ;; rename-file should delete old backup.
3809 ;; If trouble writing the backup, write it in
3810 ;; .emacs.d/%backup%.
3813 backupname)
3817 ;; Now delete the old versions, if desired.
3824 setmodes)
3831 ;; Create temp files with strict access rights. It's easy to
3832 ;; loosen them later, whereas it's impossible to close the
3833 ;; time-window of loose permissions otherwise.
3836 ;; Try to overwrite old backup first.
3844 nil)
3846 ;; The file was somehow created by someone else between
3847 ;; `delete-file' and `copy-file', so let's try again.
3848 ;; rms says "I think there is also a possible race
3849 ;; condition for making backup files" (emacs-devel 20070821).
3850 nil)))
3851 ;; Reset the umask.
3860 ;; The last ~[[:digit]]+ matches relative versions in git,
3861 ;; e.g. `foo.js.~HEAD~1~'.
3862 "Regular expression matching the backup/version part of a file name.
3866 "Return file NAME sans backup versions or strings.
3867 This is a separate procedure so your site-init or startup file can
3868 redefine it.
3869 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3870 we do not remove backup version numbers, only true file version numbers.
3871 See also `file-name-version-regexp'."
3878 name))))))
3881 "Return t if deleting FILE and rewriting it would preserve the owner."
3886 ;; Return t if the file doesn't exist, since it's true that no
3887 ;; information would be lost by an (attempted) delete and create.
3890 ;; Files created on Windows by Administrator (RID=500)
3891 ;; have the Administrators group (RID=544) recorded as
3892 ;; their owner. Rewriting them will still preserve the
3893 ;; owner.
3899 The extension, in a file name, is the part that follows the last `.',
3900 except that a leading `.', if any, doesn't count."
3903 directory)
3907 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3908 ;; we don't want to expand it.
3911 filename))))
3915 The extension, in a file name, is the part that follows the last `.',
3916 excluding version numbers and backup suffixes,
3917 except that a leading `.', if any, doesn't count.
3918 Return nil for extensionless file names such as `foo'.
3919 Return the empty string for file names such as `foo.'.
3921 If PERIOD is non-nil, then the returned value includes the period
3922 that delimits the extension, and if FILENAME has no extension,
3933 "A function to use instead of the default `make-backup-file-name'.
3934 A value of nil gives the default `make-backup-file-name' behavior.
3936 This could be buffer-local to do something special for specific
3937 files. If you define it, you may need to change `backup-file-name-p'
3938 and `file-name-sans-versions' too.
3940 See also `backup-directory-alist'."
3946 "Alist of filename patterns and backup directory names.
3947 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3948 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3949 relative or absolute. If it is absolute, so that all matching files
3950 are backed up into the same directory, the file names in this
3951 directory will be the full name of the file backed up with all
3952 directory separators changed to `!' to prevent clashes. This will not
3953 work correctly if your filesystem truncates the resulting name.
3955 For the common case of all backups going into one directory, the alist
3957 directory name.
3959 If this variable is nil, or it fails to match a filename, the backup
3960 is made in the original file's directory.
3962 On MS-DOS filesystems without long names this variable is always
3963 ignored."
3969 "Default `backup-enable-predicate' function.
3970 Checks for files in `temporary-file-directory',
3971 `small-temporary-file-directory', and /tmp."
3974 ;; Directory is under temporary-file-directory.
3979 ;; Directory is under /tmp.
3984 0 nil
3986 ;; Directory is under small-temporary-file-directory.
3991 "Create the non-numeric backup file name for FILE.
3992 Normally this will just be the file's name with `~' appended.
3993 Customization hooks are provided as follows.
3995 If the variable `make-backup-file-name-function' is non-nil, its value
3996 should be a function which will be called with FILE as its argument;
3997 the resulting name is used.
3999 Otherwise a match for FILE is sought in `backup-directory-alist'; see
4000 the documentation of that variable. If the directory for the backup
4001 doesn't exist, it is created."
4015 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
4017 elt backup-directory abs-backup-directory)
4022 alist nil)))
4023 ;; If backup-directory is relative, it should be relative to the
4024 ;; file's directory. By expanding explicitly here, we avoid
4025 ;; depending on default-directory.
4034 abs-backup-directory nil))))
4036 file
4040 ;; Normalize DOSish file names: downcase the drive
4041 ;; letter, if any, and replace the leading "x:" with
4042 ;; "/drive_x".
4045 ;; Replace any invalid file-name characters (for the
4046 ;; case of backing up remote files).
4050 "drive_"
4053 ""
4056 ;; Make the name unique by substituting directory
4057 ;; separators. It may not really be worth bothering about
4058 ;; doubling `!'s in the original name...
4063 backup-directory))
4068 "Return non-nil if FILE is a backup file name (numeric or not).
4069 This is a separate function so you can redefine it for customization.
4070 You may need to redefine `file-name-sans-versions' as well."
4075 ;; This is used in various files.
4076 ;; The usage of backup-extract-version-start is not very clean,
4077 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4079 "Given the name of a numeric backup file, FN, return the backup number.
4080 Uses the free variable `backup-extract-version-start', whose value should be
4081 the index in the name where the version number begins."
4088 "Find a file name for a backup file FN, and suggestions for deletions.
4089 Value is a list whose car is the name for the backup file
4090 and whose cdr is a list of old versions to consider deleting now.
4091 If the value is nil, don't make a backup.
4092 Uses `backup-directory-alist' in the same way as does
4093 `make-backup-file-name'."
4095 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4099 ;; We don't support numbered backups on plain MS-DOS
4100 ;; when long file names are unavailable.
4110 possibilities deserve-versions-p versions)
4113 base-versions
4116 possibilities)
4117 #'<)
4122 kept-old-versions
4123 kept-new-versions
4130 ;; Delete nothing if there is overflow
4131 ;; in the number of versions to keep.
4137 v))))))))))
4140 "Return number of names file FILENAME has."
4143 ;; (defun file-relative-name (filename &optional directory)
4144 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4145 ;; This function returns a relative file name which is equivalent to FILENAME
4146 ;; when used with that default directory as the default.
4147 ;; If this is impossible (which can happen on MSDOS and Windows
4148 ;; when the file name and directory use different drive names)
4149 ;; then it returns FILENAME."
4150 ;; (save-match-data
4151 ;; (let ((fname (expand-file-name filename)))
4152 ;; (setq directory (file-name-as-directory
4153 ;; (expand-file-name (or directory default-directory))))
4154 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4155 ;; ;; drive names, they can't be relative, so return the absolute name.
4156 ;; (if (and (or (eq system-type 'ms-dos)
4157 ;; (eq system-type 'cygwin)
4158 ;; (eq system-type 'windows-nt))
4159 ;; (not (string-equal (substring fname 0 2)
4160 ;; (substring directory 0 2))))
4161 ;; filename
4162 ;; (let ((ancestor ".")
4163 ;; (fname-dir (file-name-as-directory fname)))
4164 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4165 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4166 ;; (setq directory (file-name-directory (substring directory 0 -1))
4167 ;; ancestor (if (equal ancestor ".")
4168 ;; ".."
4169 ;; (concat "../" ancestor))))
4170 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4171 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4172 ;; ;; We matched within FNAME's directory part.
4173 ;; ;; Add the rest of FNAME onto ANCESTOR.
4174 ;; (let ((rest (substring fname (match-end 0))))
4175 ;; (if (and (equal ancestor ".")
4176 ;; (not (equal rest "")))
4177 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4178 ;; rest
4179 ;; (concat (file-name-as-directory ancestor) rest)))
4180 ;; ;; We matched FNAME's directory equivalent.
4181 ;; ancestor))))))
4184 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4185 This function returns a relative file name which is equivalent to FILENAME
4186 when used with that default directory as the default.
4187 If FILENAME and DIRECTORY lie on different machines or on different drives
4188 on a DOS/Windows machine, it returns FILENAME in expanded form."
4192 default-directory))))
4198 ;; Test for different filesystems on DOS/Windows
4200 ;; Should `cygwin' really be included here? --stef
4203 ;; Test for different drive letters
4205 ;; Test for UNCs on different servers
4210 ;; Windows file names cannot have ? in
4211 ;; them, so use that to detect when
4212 ;; neither FILENAME nor DIRECTORY is a
4213 ;; UNC.
4215 0 nil
4221 ;; Test for different remote file system identification
4223 filename
4229 directory nil nil case-fold-search))
4231 directory nil nil case-fold-search))))
4234 ".."
4236 ;; Now ancestor is empty, or .., or ../.., etc.
4238 directory nil nil case-fold-search))
4239 ;; We matched within FILENAME's directory part.
4240 ;; Add the rest of FILENAME onto ANCESTOR.
4243 ;; But don't bother with ANCESTOR if it would give us `./'.
4244 rest
4246 ;; We matched FILENAME's directory equivalent.
4247 ancestor))))))
4248 \f
4250 "Save current buffer in visited file if modified.
4251 Variations are described below.
4253 By default, makes the previous version into a backup file
4254 if previously requested or if this is the first save.
4256 to become a backup when the next save is done.
4258 unconditionally makes the previous version into a backup file.
4260 to become a backup when the next save is done,
4261 and unconditionally makes the previous version into a backup file.
4263 With a numeric argument of 0, never make the previous version
4264 into a backup file.
4266 If a file's name is FOO, the names of its numbered backup versions are
4267 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4268 Numeric backups (rather than FOO~) will be made if value of
4269 `version-control' is not the atom `never' and either there are already
4270 numeric versions of the file being backed up, or `version-control' is
4271 non-nil.
4272 We don't want excessive versions piling up, so there are variables
4273 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4274 and `kept-new-versions', which tells how many newest versions to keep.
4275 Defaults are 2 old versions and 2 new.
4276 `dired-kept-versions' controls dired's clean-directory (.) command.
4277 If `delete-old-versions' is nil, system will query user
4278 before trimming versions. Otherwise it does it silently.
4280 If `vc-make-backup-files' is nil, which is the default,
4281 no backup files are made for files managed by version control.
4282 (This is because the version control system itself records previous versions.)
4284 See the subroutine `basic-save-buffer' for more information."
4290 ;; We used to display the message below only for files > 50KB, but
4291 ;; then Rmail-mbox never displays it due to buffer swapping. If
4292 ;; the test is ever re-introduced, be sure to handle saving of
4293 ;; Rmail files.
4300 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4301 Normally delete only if the file was written by this Emacs since
4302 the last real save, but optional arg FORCE non-nil means delete anyway."
4316 "Normal hook that is run before a buffer is saved to its file."
4322 "Normal hook that is run after a buffer is saved to its file."
4328 "If non-nil, use this coding system for saving the buffer.
4329 More precisely, use this coding system in place of the
4330 value of `buffer-file-coding-system', when saving the buffer.
4331 Calling `write-region' for any purpose other than saving the buffer
4332 will still use `buffer-file-coding-system'; this variable has no effect
4339 "Save the current buffer in its visited file, if it has been modified.
4340 The hooks `write-contents-functions' and `write-file-functions' get a chance
4341 to do the job of saving; if they do not, then the buffer is saved in
4342 the visited file in the usual way.
4343 Before and after saving the buffer, this function runs
4344 `before-save-hook' and `after-save-hook', respectively."
4347 ;; In an indirect buffer, save its base buffer instead.
4351 ;; handle the case when no modification has been made but
4352 ;; the file disappeared since visited
4356 setmodes)
4357 ;; If buffer has no file name, ask user for one.
4364 ;; Signal an error if the user specified the name of an
4365 ;; existing directory.
4368 filename))
4370 ;; Signal an error if the specified name refers to a
4371 ;; non-existing directory.
4382 "%s has changed since visited or saved. Save anyway? "
4402 ;; Support VC version backups.
4408 ;; If a hook returned t, file is already "written".
4409 ;; Otherwise, write it the usual way now.
4411 ;; Now we have saved the current buffer. Let's make sure
4412 ;; that buffer-file-coding-system is fixed to what
4413 ;; actually used for saving by binding it locally.
4425 ;; If the auto-save file was recent before this command,
4426 ;; delete it now.
4428 ;; Support VC `implicit' locking.
4433 ;; This does the "real job" of writing a buffer into its visited file
4434 ;; and making a backup file. This is what is normally done
4435 ;; but inhibited if one of write-file-functions returns non-nil.
4436 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4448 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4461 "File %s is write-protected; try to save anyway? "
4463 buffer-file-name)))
4478 ;; Write temp name, then rename it.
4479 ;; This requires write access to the containing dir,
4480 ;; which is why we don't try it if we don't have that access.
4482 tempname succeed
4485 ;; Create temp files with strict access rights. It's easy to
4486 ;; loosen them later, whereas it's impossible to close the
4487 ;; time-window of loose permissions otherwise.
4492 ;; Try various temporary names.
4493 ;; This code follows the example of make-temp-file,
4494 ;; but it calls write-region in the appropriate way
4495 ;; for saving the buffer.
4501 ;; Pass in nil&nil rather than point-min&max
4502 ;; cause we're saving the whole buffer.
4503 ;; write-region-annotate-functions may use it.
4505 tempname nil realname
4507 nil)
4509 ;; The file was somehow created by someone else between
4510 ;; `make-temp-name' and `write-region', let's try again.
4511 nil)
4513 ;; Reset the umask.
4515 ;; If we failed, restore the buffer's modtime.
4518 ;; Since we have created an entirely new file,
4519 ;; make sure it gets the right permission bits set.
4524 buffer-file-name)))
4525 ;; We succeeded in writing the temp file,
4526 ;; so rename it.
4528 ;; If file not writable, see if we can make it writable
4529 ;; temporarily while we write it.
4530 ;; But no need to do so if we have just backed it up
4531 ;; (setmodes is set) because that says we're superseding.
4533 ;; Change the mode back, after writing.
4536 buffer-file-name))
4542 ;; Pass in nil&nil rather than point-min&max to indicate
4543 ;; we're saving the buffer rather than just a region.
4544 ;; write-region-annotate-functions may make us of it.
4546 buffer-file-name nil t buffer-file-truename)
4548 ;; If we get an error writing the new file, and we made
4549 ;; the backup by renaming, undo the backing-up.
4554 setmodes))
4560 `((?\C-r
4567 ;; Return nil to ask about BUF again.
4568 nil)
4581 ;; Return nil to ask about BUF again.
4582 nil)
4592 "Save some modified file-visiting buffers. Asks user about each one.
4593 You can answer `y' to save, `n' not to save, `C-r' to look at the
4594 buffer in question with `view-buffer' before deciding or `d' to
4595 view the differences using `diff-buffer-with-file'.
4597 This command first saves any buffers where `buffer-save-without-query' is
4598 non-nil, without asking.
4600 Optional argument (the prefix) non-nil means save all with no questions.
4601 Optional second argument PRED determines which buffers are considered:
4602 If PRED is nil, all the file-visiting buffers are considered.
4603 If PRED is t, then certain non-file buffers will also be considered.
4604 If PRED is a zero-argument function, it indicates for each buffer whether
4605 to consider it or not when called with that buffer current.
4607 See `save-some-buffers-action-alist' if you want to
4608 change the additional actions you can take on files."
4612 files-done abbrevs-done)
4614 ;; First save any buffers that we're supposed to save unconditionally.
4615 ;; That way the following code won't ask about them.
4620 ;; Ask about those buffers that merit it,
4621 ;; and record the number thus saved.
4625 ;; Note that killing some buffers may kill others via
4626 ;; hooks (e.g. Rmail and its viewing buffer).
4639 t
4651 save-some-buffers-action-alist))
4652 ;; Maybe to save abbrevs, and record whether
4653 ;; we either saved them or asked to.
4660 ;; Don't keep bothering user if he says no.
4673 \f
4675 "Mark current buffer as unmodified, not needing to be saved.
4678 It is not a good idea to use this function in Lisp programs, because it
4679 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4686 "Change whether this buffer is read-only.
4687 With prefix argument ARG, make the buffer read-only if ARG is
4688 positive, otherwise make it writable. If buffer is read-only
4689 and `view-read-only' is non-nil, enter view mode.
4691 This function is usually the wrong thing to use in a Lisp program.
4692 It can have side-effects beyond changing the read-only status of a buffer
4693 \(e.g., enabling view mode), and does not affect read-only regions that
4694 are caused by text properties. To make a buffer read-only in Lisp code,
4695 set `buffer-read-only'. To ignore read-only status (whether due to text
4696 properties or buffer state) and make changes, temporarily bind
4697 `inhibit-read-only'."
4702 nil ; do nothing.
4703 ;; Toggle.
4710 ;; If view-mode is already active, `view-mode-enter' is a nop.
4718 "Insert contents of file FILENAME into buffer after point.
4719 Set mark after the inserted text.
4721 This function is meant for the user to run interactively.
4722 Don't call it from programs! Use `insert-file-contents' instead.
4723 \(Its calling sequence is different; see its documentation)."
4728 "Append the contents of the region to the end of file FILENAME.
4729 When called from a function, expects three arguments,
4730 START, END and FILENAME. START and END are normally buffer positions
4731 specifying the part of the buffer to write.
4732 If START is nil, that means to use the entire buffer contents.
4733 If START is a string, then output that string to the file
4734 instead of any buffer contents; END is ignored.
4736 This does character code conversion and applies annotations
4737 like `write-region' does."
4742 "Return most recent backup file for FILENAME or nil if no backups exist."
4743 ;; `make-backup-file-name' will get us the right directory for
4744 ;; ordinary or numeric backups. It might create a directory for
4745 ;; backups as a side-effect, according to `backup-directory-alist'.
4752 tem)
4761 newest))
4764 "Rename current buffer to a similar name not already taken.
4765 This function is useful for creating multiple shell process buffers
4766 or multiple mail buffers, etc."
4774 ;; If the existing buffer name has a <NNN>,
4775 ;; which isn't part of the file name (if any),
4776 ;; then get rid of that.
4782 "Create the directory DIR and optionally any nonexistent parent dirs.
4783 If DIR already exists as a directory, signal an error, unless
4784 PARENTS is non-nil.
4786 Interactively, the default choice of directory to create is the
4787 current buffer's default directory. That is useful when you have
4788 visited a file in a nonexistent directory.
4790 Noninteractively, the second (optional) argument PARENTS, if
4791 non-nil, says whether to create parent directories that don't
4792 exist. Interactively, this happens by default.
4794 If creating the directory or directories fail, an error will be
4795 raised."
4798 nil nil)
4799 t))
4800 ;; If default-directory is a remote directory,
4801 ;; make sure we find its make-directory handler.
4809 create-list)
4811 ;; If directory is its own parent, then we can't
4812 ;; keep looping forever
4827 "Delete the directory named DIRECTORY. Does not follow symlinks.
4828 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4829 TRASH non-nil means to trash the directory instead, provided
4830 `delete-by-moving-to-trash' is non-nil.
4832 When called interactively, TRASH is t if no prefix argument is
4833 given. With a prefix argument, TRASH is nil."
4840 "Move directory to trash: "
4842 default-directory default-directory nil nil))))
4848 nil)
4850 ;; If default-directory is a remote directory, make sure we find its
4851 ;; delete-directory handler.
4858 ;; Only move non-empty dir to trash if recursive deletion was
4859 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4860 ;; case, where the operation fails in delete-directory-internal.
4861 ;; As `move-file-to-trash' trashes directories (empty or
4862 ;; otherwise) as a unit, we do not need to recurse here.
4864 ;; Check if directory is empty apart from "." and "..".
4869 ;; Otherwise, call outselves recursively if needed.
4873 ;; This test is equivalent to
4874 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4875 ;; but more efficient
4879 ;; We do not want to delete "." and "..".
4885 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4886 This function always sets the file modes of the output files to match
4887 the corresponding input file.
4889 The third arg KEEP-TIME non-nil means give the output files the same
4890 last-modified time as the old ones. (This works on only some systems.)
4892 A prefix arg makes KEEP-TIME non-nil.
4894 Noninteractively, the last argument PARENTS says whether to
4895 create parent directories if they don't exist. Interactively,
4896 this happens by default.
4898 If NEWNAME names an existing directory, copy DIRECTORY as a
4899 subdirectory there. However, if called from Lisp with a non-nil
4900 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
4901 directly into NEWNAME instead."
4908 default-directory default-directory nil nil)
4909 current-prefix-arg t nil)))
4910 ;; If default-directory is a remote directory, make sure we find its
4911 ;; copy-directory handler.
4917 ;; Compute target name.
4922 ;; If NEWNAME is not an existing directory, create it;
4923 ;; that is where we will copy the files of DIRECTORY.
4925 ;; If NEWNAME is an existing directory and COPY-CONTENTS
4926 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
4931 newname))
4935 newname))
4938 ;; Copy recursively.
4940 ;; We do not want to copy "." and "..".
4942 directory-files-no-dot-files-regexp))
4951 ;; Set directory attributes.
4956 \f
4959 "Function to use to revert this buffer, or nil to do the default.
4960 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4965 "Function to use to insert contents when reverting this buffer.
4966 Gets two args, first the nominal file name to use,
4967 and second, t if reading the auto-save file.
4972 "Function to check whether a non-file buffer needs reverting.
4973 This should be a function with one optional argument NOCONFIRM.
4974 Auto Revert Mode passes t for NOCONFIRM. The function should return
4975 non-nil if the buffer should be reverted. A return value of
4976 `fast' means that the need for reverting was not checked, but
4977 that reverting the buffer is fast. The buffer is current when
4978 this function is called.
4980 The idea behind the NOCONFIRM argument is that it should be
4981 non-nil if the buffer is going to be reverted without asking the
4982 user. In such situations, one has to be careful with potentially
4983 time consuming operations.
4985 For more information on how this variable is used by Auto Revert mode,
4989 "Normal hook for `revert-buffer' to run before reverting.
4990 If `revert-buffer-function' is used to override the normal revert
4994 "Normal hook for `revert-buffer' to run after reverting.
4995 Note that the hook value that it runs is the value that was in effect
4996 before reverting; that makes a difference if you have buffer-local
4997 hook functions.
4999 If `revert-buffer-function' is used to override the normal revert
5003 "Non-nil if a `revert-buffer' operation is in progress, nil otherwise.
5009 "Replace current buffer text with the text of the visited file on disk.
5010 This undoes all changes since the file was visited or saved.
5011 With a prefix argument, offer to revert from latest auto-save file, if
5012 that is more recent than the visited file.
5014 This command also implements an interface for special buffers
5015 that contain text which doesn't come from a file, but reflects
5016 some other data instead (e.g. Dired buffers, `buffer-list'
5017 buffers). This is done via the variable `revert-buffer-function'.
5018 In these cases, it should reconstruct the buffer contents from the
5019 appropriate data.
5021 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5022 to revert from the auto-save file when this is nil. Note that the
5023 sense of this argument is the reverse of the prefix argument, for the
5024 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5025 to nil.
5027 Optional second argument NOCONFIRM means don't ask for confirmation
5028 at all. (The variable `revert-without-query' offers another way to
5029 revert buffers without querying for confirmation.)
5031 Optional third argument PRESERVE-MODES non-nil means don't alter
5032 the files modes. Normally we reinitialize them using `normal-mode'.
5034 If the value of `revert-buffer-function' is non-nil, it is called to
5035 do all the work for this command. Otherwise, the hooks
5036 `before-revert-hook' and `after-revert-hook' are run at the beginning
5037 and the end, and if `revert-buffer-insert-file-contents-function' is
5038 non-nil, it is called instead of rereading visited file contents."
5040 ;; I admit it's odd to reverse the sense of the prefix argument, but
5041 ;; there is a lot of code out there which assumes that the first
5042 ;; argument should be t to avoid consulting the auto-save file, and
5043 ;; there's no straightforward way to encourage authors to notice a
5044 ;; reversal of the argument sense. So I'm just changing the user
5045 ;; interface, but leaving the programmatic interface the same.
5055 buffer-auto-save-file-name
5060 buffer-auto-save-file-name
5061 buffer-file-name)))
5071 file-name)))
5073 ;; If file was backed up but has changed since,
5074 ;; we should make another backup.
5078 ;; Effectively copy the after-revert-hook status,
5079 ;; since after-find-file will clobber it.
5082 after-revert-hook))
5087 ;; Get rid of all undo records for this buffer.
5089 ;; Don't make undo records for the reversion.
5092 file-name auto-save-p)))
5095 "File %s no longer exists!"
5097 file-name))
5100 "File %s no longer readable!"
5102 file-name))
5104 ;; Bind buffer-file-name to nil
5105 ;; so that we don't try to lock the file.
5111 ;; Auto-saved file should be read by Emacs'
5112 ;; internal coding.
5116 buffer-file-coding-system-explicit
5119 coding-system-for-read
5121 coding-system-for-read)
5123 ;; As a coding system suitable for multibyte
5124 ;; buffer is specified, make the current
5125 ;; buffer multibyte.
5128 ;; This force after-insert-file-set-coding
5129 ;; (called from insert-file-contents) to set
5130 ;; buffer-file-coding-system to a proper value.
5133 ;; Note that this preserves point in an intelligent way.
5137 nil nil t))
5139 nil nil t)))))
5140 ;; Recompute the truename in case changes in symlinks
5141 ;; have changed the truename.
5145 ;; Run after-revert-hook as it was before we reverted.
5149 local-hook)
5152 t))))))
5155 "Recover the visited file--get contents from its last auto-save file."
5160 "Visit file FILE, but get contents from its last auto-save file."
5161 ;; Actually putting the file name in the minibuffer should be used
5162 ;; only rarely.
5163 ;; Not just because users often use the default.
5183 ;; Use insert-directory-safely, not insert-directory,
5184 ;; because these files might not exist. In particular,
5185 ;; FILE might not exist if the auto-save file was for
5186 ;; a buffer that didn't visit a file, such as "*mail*".
5187 ;; The code in v20.x called `ls' directly, so we need
5188 ;; to emulate what `ls' did in that case.
5194 ;; Keep the current buffer-file-coding-system.
5196 ;; Auto-saved file should be read with special coding.
5205 "Recover auto save files from a previous Emacs session.
5206 This command first displays a Dired buffer showing you the
5207 previous sessions that you could recover from.
5208 To choose one, move point to the proper line and then type C-c C-c.
5209 Then you'll be asked about a number of files to recover."
5219 auto-save-list-file-prefix)))
5220 t)
5229 ;; Each line starts with a space
5230 ;; so that Font Lock mode won't highlight the first character.
5239 "Choose one saved session to recover auto-save files from.
5240 This command is used in the special Dired buffer created by
5243 ;; Get the name of the session file to recover from.
5245 files
5251 ;; Read in the auto-save-list file.
5254 ;; Loop thru the text of that file
5255 ;; and get out the names of the files to recover.
5259 ;; This is a pair of lines for a non-file-visiting buffer.
5260 ;; Get the auto-save file name and manufacture
5261 ;; a "visited file name" from that.
5264 ;; If there is no auto-save file name, the
5265 ;; auto-save-list file is probably corrupted.
5278 ;; This pair of lines is a file-visiting
5279 ;; buffer. Use the visited file name.
5289 ;; Ignore a file if its auto-save file does not exist now.
5293 ;; The file contains a pair of line for each auto-saved buffer.
5294 ;; The first line of the pair contains the visited file name
5295 ;; or is empty if the buffer was not visiting a file.
5296 ;; The second line is the auto-save file name.
5304 files
5310 "Kill BUFFER if confirmed."
5318 "Kill some buffers. Asks the user whether to kill each one of them.
5319 Non-interactively, if optional argument LIST is non-nil, it
5320 specifies the list of buffers to kill, asking for approval for each one."
5328 ; if we killed the base buffer.
5335 "Kill buffers whose name matches the specified REGEXP.
5336 The optional second argument indicates whether to kill internal buffers too."
5345 \f
5347 "Adjust current buffer's auto save file name for current conditions.
5348 Also rename any existing auto save file, if it was made in this session."
5360 "Return file name to use for auto-saves of current buffer.
5361 Does not consider `auto-save-visited-file-name' as that variable is checked
5362 before calling this function. You can redefine this for customization.
5363 See also `auto-save-file-name-p'."
5371 result uniq)
5372 ;; Apply user-specified translations
5373 ;; to the file name.
5377 filename)
5387 filename))))
5392 ;; We truncate the file name to DOS 8+3 limits
5393 ;; before doing anything else, because the regexp
5394 ;; passed to string-match below cannot handle
5395 ;; extensions longer than 3 characters, multiple
5396 ;; dots, and other atrocities.
5401 fn)
5406 "#"
5409 ;; Make sure auto-save file names don't contain characters
5410 ;; invalid for the underlying filesystem.
5412 ;; Don't modify remote (ange-ftp) filenames
5415 result))))
5417 ;; Deal with buffers that don't have any associated files. (Mail
5418 ;; mode tends to create a good number of these.)
5422 file-name)
5423 ;; Restrict the characters used in the file name to those which
5424 ;; are known to be safe on all filesystems, url-encoding the
5425 ;; rest.
5426 ;; We do this on all platforms, because even if we are not
5427 ;; running on DOS/Windows, the current directory may be on a
5428 ;; mounted VFAT filesystem, such as a USB memory stick.
5432 ;; For multibyte characters, this will produce more than
5433 ;; 2 hex digits, so is not true URL encoding.
5437 ;; Generate the file name.
5443 ;; Try a few alternative directories, to get one we can
5444 ;; write it.
5450 ;; Don't modify remote (ange-ftp) filenames
5452 ;; The call to convert-standard-filename is in case
5453 ;; buffer-name includes characters not allowed by the
5454 ;; DOS/Windows filesystems. make-temp-file writes to the
5455 ;; file it creates, so we must fix the file name _before_
5456 ;; make-temp-file is called.
5458 fname))
5460 ;; make-temp-file creates the file,
5461 ;; but we don't want it to exist until we do an auto-save.
5465 file-name)))
5468 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5469 FILENAME should lack slashes. You can redefine this for customization."
5471 \f
5473 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5474 The generated regexp will match a filename only if the filename
5475 matches that wildcard according to shell rules. Only wildcards known
5476 by `sh' are supported."
5478 ;; Copy the initial run of non-special characters.
5481 ;; If no special characters, we're almost done.
5485 j)
5487 result
5508 ;; Found "[^". Insert a `\0' character
5509 ;; (which cannot happen in a filename)
5510 ;; into the character class, so that `^'
5511 ;; is not the first character after `[',
5512 ;; and thus non-special in a regexp.
5517 ;; I don't think `]' can appear in a
5518 ;; character class in a wildcard, but
5519 ;; let's be general here.
5526 i
5539 ;; Shell wildcards should match the entire filename,
5540 ;; not its part. Make the regexp say so.
5542 \f
5545 "Switches for `list-directory' to pass to `ls' for brief listing."
5551 "Switches for `list-directory' to pass to `ls' for verbose listing."
5556 "Expand wildcard pattern PATTERN.
5557 This returns a list of file names which match the pattern.
5559 If PATTERN is written as an absolute file name,
5560 the values are absolute also.
5562 If PATTERN is written as a relative file name, it is interpreted
5563 relative to the current default directory, `default-directory'.
5564 The file names returned are normally also relative to the current
5565 default directory. However, if FULL is non-nil, they are absolute."
5569 ;; A list of all dirs that DIRPART specifies.
5570 ;; This can be more than one dir
5571 ;; if DIRPART contains wildcards.
5575 dirpart)))
5579 contents)
5585 ;; Filter out "." and ".."
5590 name))
5597 this-dir-contents)
5598 this-dir-contents)
5599 contents))))
5601 contents)))
5603 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5607 "Display a list of files in or matching DIRNAME, a la `ls'.
5608 DIRNAME is globbed by the shell if necessary.
5609 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5610 Actions controlled by variables `list-directory-brief-switches'
5611 and `list-directory-verbose-switches'."
5615 nil default-directory nil)
5616 pfx)))
5618 list-directory-brief-switches))
5619 buffer)
5631 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5639 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5641 PATTERN is assumed to represent a file-name wildcard suitable for the
5642 underlying filesystem. For Unix and GNU/Linux, each character from the
5644 the parts of the pattern which don't include wildcard characters are
5645 quoted with double quotes.
5648 on Windows), so PATTERN can use them to quote wildcard characters that
5649 need to be passed verbatim to shell commands."
5653 ;; DOS/Windows don't allow `"' in file names. So if the
5654 ;; argument has quotes, we can safely assume it is already
5655 ;; quoted by the caller.
5657 ;; We quote [&()#$'] in case their shell is a port of a
5658 ;; Unixy shell. We quote [,=+] because stock DOS and
5659 ;; Windows shells require that in some cases, such as
5660 ;; passing arguments to batch files that use positional
5661 ;; arguments like %1.
5663 pattern
5666 end)
5683 pattern))))
5690 "Program to get the amount of free space on a file system.
5691 We assume the output has the format of `df'.
5692 The value of this variable must be just a command name or file name;
5693 if you want to specify options, use `directory-free-space-args'.
5695 A value of nil disables this feature.
5697 If the function `file-system-info' is defined, it is always used in
5698 preference to the program given by this variable."
5704 "Options to use when running `directory-free-space-program'."
5709 "Return the amount of free space on directory DIR's file system.
5710 The return value is a string describing the amount of free
5711 space (normally, the number of free 1KB blocks).
5713 This function calls `file-system-info' if it is available, or
5714 invokes the program specified by `directory-free-space-program'
5715 and `directory-free-space-args'. If the system call or program
5716 is unsuccessful, or if DIR is a remote directory, this function
5717 returns nil."
5719 ;; Try to find the number of free blocks. Non-Posix systems don't
5720 ;; always have df, but might have an equivalent system call.
5729 ;; Avoid failure if the default directory does
5730 ;; not exist (Bug#2631, Bug#3911).
5733 nil t nil
5734 directory-free-space-args
5735 dir)
5737 ;; Assume that the "available" column is before the
5738 ;; "capacity" column. Find the "%" and scan backward.
5742 "[[:space:]]+[^[:space:]]+%[^%]*$"
5749 ;; The following expression replaces `dired-move-to-filename-regexp'.
5753 ;; In some locales, month abbreviations are as short as 2 letters,
5754 ;; and they can be followed by ".".
5755 ;; In Breton, a month name can include a quote character.
5768 s "+"
5771 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5772 ;; omits the Kanji characters after month and day-of-month.
5773 ;; On Mac OS X 10.3, the date format in East Asian locales is
5774 ;; day-of-month digits followed by month digits.
5780 ;; The "[0-9]" below requires the previous column to end in a digit.
5781 ;; This avoids recognizing `1 may 1997' as a date in the line:
5782 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5784 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5786 ;; For non-iso date formats, we add the ".*" in order to find
5787 ;; the last possible match. This avoids recognizing
5788 ;; `jservice 10 1024' as a date in the line:
5789 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5791 ;; vc dired listings provide the state or blanks between file
5792 ;; permissions and date. The state is always surrounded by
5793 ;; parentheses:
5794 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5795 ;; This is not supported yet.
5800 "Regular expression to match up to the file name in a directory listing.
5801 The default value is designed to recognize dates and times
5806 ;; insert-directory
5807 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5808 ;; FULL-DIRECTORY-P is nil.
5809 ;; The single line of output must display FILE's name as it was
5810 ;; given, namely, an absolute path name.
5811 ;; - must insert exactly one line for each file if WILDCARD or
5812 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5813 ;; before the file lines, plus optional text after the file lines.
5814 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5815 ;; allowed.
5816 ;; File lines should display the basename.
5817 ;; - must be consistent with
5818 ;; - functions dired-move-to-filename, (these two define what a file line is)
5819 ;; dired-move-to-end-of-filename,
5820 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5821 ;; dired-insert-headerline
5822 ;; dired-after-subdir-garbage (defines what a "total" line is)
5823 ;; - variable dired-subdir-regexp
5824 ;; - may be passed "--dired" as the first argument in SWITCHES.
5825 ;; Filename handlers might have to remove this switch if their
5826 ;; "ls" command does not support it.
5828 "Insert directory listing for FILE, formatted according to SWITCHES.
5829 Leaves point after the inserted text.
5830 SWITCHES may be a string of options, or a list of strings
5831 representing individual options.
5832 Optional third arg WILDCARD means treat FILE as shell wildcard.
5833 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5834 switches do not contain `d', so that a full listing is expected.
5836 This works by running a directory listing program
5837 whose name is in the variable `insert-directory-program'.
5838 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5840 When SWITCHES contains the long `--dired' option, this function
5841 treats it specially, for the sake of dired. However, the
5842 normally equivalent short `-D' option is just passed on to
5843 `insert-directory-program', as any other option."
5844 ;; We need the directory in order to find the right handler.
5849 wildcard full-directory-p)
5852 ;; Read the actual directory using `insert-directory-program'.
5853 ;; RESULT gets the status code.
5855 ;; putting text property `dired-filename, decode one
5856 ;; bunch by one to preserve that property.
5858 ;; This is to control encoding the arguments in call-process.
5862 default-file-name-coding-system))))
5865 ;; Run ls in the directory part of the file pattern
5866 ;; using the last component as argument.
5872 ;; NB since switches is passed to the shell, be
5873 ;; careful of malicious values, eg "-l;reboot".
5874 ;; See eg dired-safe-switches-p.
5876 shell-file-name nil t nil
5877 "-c"
5879 ""
5881 insert-directory-program
5882 " -d "
5884 switches
5886 " -- "
5887 ;; Quote some characters that have
5888 ;; special meanings in shells; but
5889 ;; don't quote the wildcards--we want
5890 ;; them to be special. We also
5891 ;; currently don't quote the quoting
5892 ;; characters in case people want to
5893 ;; use them explicitly to quote
5894 ;; wildcard characters.
5896 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5897 ;; directory if FILE is a symbolic link.
5904 insert-directory-program nil t nil
5908 ;; Split the switches at any spaces so we can
5909 ;; pass separate options as separate args.
5911 ;; Avoid lossage if FILE starts with `-'.
5919 file))))))))
5921 ;; If we got "//DIRED//" in the output, it means we got a real
5922 ;; directory listing, even if `ls' returned nonzero.
5923 ;; So ignore any errors.
5936 ;; The first time ls returns an error,
5937 ;; find the version numbers of ls,
5938 ;; and set insert-directory-ls-version
5939 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5940 ;; is equal or if the info cannot be obtained.
5941 ;; (That can mean it isn't GNU ls.)
5951 comparison)
5967 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5971 ;; If `insert-directory-program' failed, signal an error.
5973 ;; Delete the error message it may have output.
5975 ;; On non-Posix systems, we cannot open a directory, so
5976 ;; don't even try, because that will always result in
5977 ;; the ubiquitous "Access denied". Instead, show the
5978 ;; command line so the user can try to guess what went wrong.
5983 insert-directory-program
5985 file result)
5986 ;; Unix. Access the file to get a suitable error.
5993 ;; The following overshoots by one line for an empty
5994 ;; directory listed with "--dired", but without "-a"
5995 ;; switch, where the ls output contains a
5996 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5997 ;; We take care of that case later.
6005 error-lines)
6006 ;; Find all the lines that are error messages,
6007 ;; and record the bounds of each one.
6014 ;; Now read the numeric positions of file names.
6021 error-lines))
6024 error-lines)))
6026 ;; End is followed by \n or by " -> ".
6028 ;; It seems that we can't trust ls's output as to
6029 ;; byte positions of filenames.
6035 ;; Take care of the case where the ls output contains a
6036 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6037 ;; and we went one line too far back (see above).
6042 ;; Now decode what read if necessary.
6044 file-name-coding-system
6045 default-file-name-coding-system
6047 coding-no-eol
6048 val pos)
6052 ;; If no coding system is specified or detection is
6053 ;; requested, detect the coding.
6067 ;; Force no eol conversion on a file name, so
6068 ;; that CR is preserved.
6076 ;; Try to insert the amount of free space.
6079 ;; First find the line to put it on.
6083 ;; Replace "total" with "used", to avoid confusion.
6089 "Convert `ls --dired' file name position value POS to a buffer position.
6090 File name position values returned in ls --dired output
6091 count only stdout; they don't count the error messages sent to stderr.
6092 So this function converts to them to real buffer positions.
6093 ERROR-LINES is a list of buffer positions of error message lines,
6094 of the form (START END)."
6098 pos)
6102 "Insert directory listing for FILE, formatted according to SWITCHES.
6104 Like `insert-directory', but if FILE does not exist, it inserts a
6105 message to that effect instead of signaling an error."
6108 ;; Simulate the message printed by `ls'.
6112 "Functions to call with no arguments to query about killing Emacs.
6113 If any of these functions returns nil, killing Emacs is cancelled.
6114 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6118 "How to ask for confirmation when leaving Emacs.
6119 If nil, the default, don't ask at all. If the value is non-nil, it should
6120 be a predicate function such as `yes-or-no-p'."
6128 "Offer to save each buffer, then kill this Emacs process.
6129 With prefix ARG, silently save all file-visiting buffers, then kill."
6138 ;; process-list is not defined on MSDOS.
6140 active)
6149 ;; Query the user for other things, perhaps.
6156 "Offer to save each buffer, then kill the current connection.
6157 If the current frame has no client, kill Emacs itself.
6159 With prefix ARG, silently save all file-visiting buffers, then kill.
6161 If emacsclient was started with a list of filenames to edit, then
6162 only these files will be asked to be saved."
6167 \f
6168 ;; We use /: as a prefix to "quote" a file name
6169 ;; so that magic file name handlers will not apply to it.
6173 file-name-handler-alist))
6175 ;; We depend on being the last handler on the list,
6176 ;; so that anything else which does need handling
6177 ;; has been handled already.
6178 ;; So it is safe for us to inhibit *all* magic file name handlers.
6187 default-directory))
6188 ;; Get a list of the indices of the args which are file names.
6191 ;; The first six are special because they
6192 ;; return a file name. We want to include the /:
6193 ;; in the return value.
6194 ;; So just avoid stripping it in the first place.
6201 ;; `identity' means just return the first arg
6202 ;; not stripped of its quoting.
6204 ;; `add' means add "/:" to the result.
6207 ;; `unquote-then-quote' means set buffer-file-name
6208 ;; temporarily to unquoted filename.
6210 ;; List the arguments which are filenames.
6218 ;; For all other operations, treat the first argument only
6219 ;; as the file name.
6221 method
6222 ;; Copy ARGUMENTS so we can replace elements in it.
6226 ;; Strip off the /: from the file names that have it.
6234 "/"
6251 \f
6252 ;; Symbolic modes and read-file-modes.
6255 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6256 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6257 Others, or All) for whom to produce the mask.
6258 The bit-mask that is returned extracts from mode bits the access rights
6259 for the specified category of users."
6267 "Convert CHAR to a numeric value of mode bits.
6268 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6269 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6276 ;; Rights relative to the previous file modes.
6287 "Convert a symbolic mode string specification to an equivalent number.
6289 WHO-MASK is the bit-mask specifying the category of users to which to
6290 apply the access permissions. See `file-modes-char-to-who'.
6291 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6292 RIGHTS request to add, remove, or set permissions based on existing ones,
6299 char-right)
6306 num-rights
6310 op char-right)))
6311 num-rights))
6314 "Convert symbolic file modes to numeric file modes.
6315 MODES is the string to convert, it should match
6317 See Info node `(coreutils)File permissions' for more information on this
6318 notation.
6319 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6320 MODES request to add, remove, or set permissions based on existing ones,
6334 num-who num-modes)
6337 num-modes)))
6340 "Read file modes in octal or symbolic notation and return its numeric value.
6341 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6342 ORIG-FILE is the name of a file on whose mode bits to base returned
6343 permissions if what user types requests to add, remove, or set permissions
6359 nil nil default)))
6365 \f
6366 ;; Trashcan handling.
6368 "Directory for `move-file-to-trash' to move files and directories to.
6369 This directory is only used when the function `system-move-file-to-trash'
6370 is not defined.
6371 Relative paths are interpreted relative to `default-directory'.
6372 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6382 "Move the file (or directory) named FILENAME to the trash.
6383 When `delete-by-moving-to-trash' is non-nil, this function is
6384 called by `delete-file' and `delete-directory' instead of
6385 deleting files outright.
6387 If the function `system-move-file-to-trash' is defined, call it
6388 with FILENAME as an argument.
6389 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6390 directory.
6391 Otherwise, trash FILENAME using the freedesktop.org conventions,
6392 like the GNOME, KDE and XFCE desktop environments. Emacs only
6396 ;; If `trash-directory' is non-nil, move the file there.
6400 trash-dir)))
6401 ;; We can't trash a parent directory of trash-directory.
6404 trash-dir filename))
6407 ;; Ensure that the trashed file-name is unique.
6414 ;; If `system-move-file-to-trash' is defined, use it.
6417 ;; Otherwise, use the freedesktop.org method, as specified at
6418 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6429 ;; Check if we have permissions to delete.
6433 ;; The trashed file cannot be the trash dir or its parent.
6436 trash-files-dir filename))
6439 trash-info-dir filename))
6441 ;; Ensure that the trash directory exists; otherwise, create it.
6450 ;; Try to move to trash with .trashinfo undo information
6455 ;; Perform url-encoding on FN. For compatibility with
6456 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6457 ;; for path separators.
6462 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6463 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6476 fn))
6481 ;; Attempt to make .trashinfo file, trying up to 5
6482 ;; times. The .trashinfo file is opened with O_EXCL,
6483 ;; as per trash-spec 0.7, even if that can be a problem
6484 ;; on old NFS versions...
6488 trash-files-dir))
6490 success info-fn)
6495 trash-info-dir))
6503 ;; Uniquify new-fn. (Some file managers do not
6504 ;; like Emacs-style backup file names---e.g. bug
6505 ;; 170956 in Konqueror bug tracker.)
6510 ;; Finally, try to move the file to the trashcan.
6514 \f
6539 ;;; files.el ends here