| blob | c9f85ff6a1ac486494170a1be8047c1707748272 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985-1987, 1992-2011 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Package: emacs
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Defines most of Emacs's file- and directory-handling functions,
26 ;; including basic file visiting, backup generation, link handling,
27 ;; ITS-id version control, load- and write-hook handling, and the like.
29 ;;; Code:
36 "Backups of edited data files."
40 "Finding files."
45 "Non-nil means delete auto-save file when a buffer is saved or killed.
47 Note that the auto-save file will not be deleted if the buffer is killed
48 when it has unsaved changes."
53 nil
54 "Alist of abbreviations for file directories.
55 A list of elements of the form (FROM . TO), each meaning to replace
56 FROM with TO when it appears in a directory name. This replacement is
57 done when setting up the default directory of a newly visited file.
59 FROM is matched against directory names anchored at the first
63 FROM and TO should be equivalent names, which refer to the
64 same directory. Do not use `~' in the TO strings;
65 they should be ordinary absolute directory names.
67 Use this feature when you have directories which you normally refer to
68 via absolute symbolic links. Make TO the name of the link, and FROM
69 the name it is linked to."
78 "Non-nil means make a backup of a file the first time it is saved.
79 This can be done by renaming the file or by copying.
81 Renaming means that Emacs renames the existing file so that it is a
82 backup file, then writes the buffer into a new file. Any other names
83 that the old file had will now refer to the backup file. The new file
84 is owned by you and its group is defaulted.
86 Copying means that Emacs copies the existing file into the backup
87 file, then writes the buffer on top of the existing file. Any other
88 names that the old file had will now refer to the new (edited) file.
89 The file's owner and group are unchanged.
91 The choice of renaming or copying is controlled by the variables
92 `backup-by-copying', `backup-by-copying-when-linked',
93 `backup-by-copying-when-mismatch' and
94 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
98 ;; Do this so that local variables based on the file name
99 ;; are not overridden by the major mode.
101 "Non-nil means don't make a backup, regardless of the other parameters.
102 This variable is intended for use by making it local to a buffer.
107 "Non-nil means always use copying to create backup files.
108 See documentation of variable `make-backup-files'."
113 "Non-nil means use copying to create backups for files with multiple names.
114 This causes the alternate names to refer to the latest version as edited.
115 This variable is relevant only if `backup-by-copying' is nil."
120 "Non-nil means create backups by copying if this preserves owner or group.
121 Renaming may still be used (subject to control of other variables)
122 when it would not result in changing the owner or group of the file;
123 that is, for files which are owned by you and whose group matches
124 the default for a new file created there by you.
125 This variable is relevant only if `backup-by-copying' is nil."
132 "Non-nil means create backups by copying to preserve a privileged owner.
133 Renaming may still be used (subject to control of other variables)
134 when it would not result in changing the owner of the file or if the owner
135 has a user id greater than the value of this variable. This is useful
136 when low-numbered uid's are used for special system users (such as root)
137 that must maintain ownership of certain files.
138 This variable is relevant only if `backup-by-copying' and
139 `backup-by-copying-when-mismatch' are nil."
144 "Predicate that looks at a file name and decides whether to make backups.
148 "Non-nil in a buffer means always offer to save buffer on exit.
149 Do so even if the buffer is not visiting a file.
150 Automatically local in all buffers."
156 "Non-nil means find a file under alternative names, in existing buffers.
157 This means if any existing buffer is visiting the file you want
158 under another name, you get the existing buffer instead of a new buffer."
163 "Non-nil means visit a file under its truename.
164 The truename of a file is found by chasing all links
165 both at the file level and at the levels of the containing directories."
171 "Specify which files should be reverted without query.
172 The value is a list of regular expressions.
173 If the file name matches one of these regular expressions,
174 then `revert-buffer' reverts the file without querying
175 if the file has changed on disk and you have not edited the buffer."
180 "The device number and file number of the file visited in the current buffer.
181 The value is a list of the form (FILENUM DEVNUM).
182 This pair of numbers uniquely identifies the file.
196 "The directory for writing small temporary files.
197 If non-nil, this directory is used instead of `temporary-file-directory'
198 by programs that create small temporary files. This is for systems that
199 have fast storage with limited space, such as a RAM disk."
204 ;; The system null device. (Should reference NULL_DEVICE from C.)
232 "Non-nil means protect against I/O errors while saving files.
233 Some modes set this non-nil in particular buffers.
235 This feature works by writing the new contents into a temporary file
236 and then renaming the temporary file to replace the original.
237 In this way, any I/O error in writing leaves the original untouched,
238 and there is never any instant where the file is nonexistent.
240 Note that this feature forces backups to be made by copying.
241 Yet, at the same time, saving a precious file
242 breaks any hard links between it and other files.
244 This feature is advisory: for example, if the directory in which the
245 file is being saved is not writable, Emacs may ignore a non-nil value
246 of `file-precious-flag' and write directly into the file.
248 See also: `break-hardlink-on-save'."
253 "Non-nil means when saving a file that exists under several names
254 \(i.e., has multiple hardlinks), break the hardlink associated with
255 `buffer-file-name' and write to a new file, so that the other
256 instances of the file are not affected by the save.
258 If `buffer-file-name' refers to a symlink, do not break the symlink.
260 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
261 For example, if the directory in which a file is being saved is not
262 itself writable, then error instead of saving in some
263 hardlink-nonbreaking way.
265 See also `backup-by-copying' and `backup-by-copying-when-linked'."
271 "Control use of version numbers for backup files.
272 When t, make numeric backup versions unconditionally.
273 When nil, make them for files that have some already.
274 The value `never' means do not make them."
284 "When cleaning directory, number of versions to keep."
290 "If t, delete excess backup versions silently.
291 If nil, ask confirmation. Any other value prevents any trimming."
298 "Number of oldest versions to keep when a new numbered backup is made."
304 "Number of newest versions to keep when a new numbered backup is made.
305 Includes the new backup. Must be > 0"
311 "Whether to add a newline automatically at the end of the file.
313 A value of t means do this only when the file is about to be saved.
314 A value of `visit' means do this right after the file is visited.
315 A value of `visit-save' means do it at both of those times.
316 Any other non-nil value means ask user whether to add a newline, when saving.
317 A value of nil means don't add newlines.
319 Certain major modes set this locally to the value obtained
320 from `mode-require-final-newline'."
329 "Whether to add a newline at end of file, in certain major modes.
330 Those modes set `require-final-newline' to this value when you enable them.
331 They do so because they are often used for files that are supposed
332 to end in newlines, and the question is how to arrange that.
334 A value of t means do this only when the file is about to be saved.
335 A value of `visit' means do this right after the file is visited.
336 A value of `visit-save' means do it at both of those times.
337 Any other non-nil value means ask user whether to add a newline, when saving.
339 A value of nil means do not add newlines. That is a risky choice in this
340 variable since this value is used for modes for files that ought to have
341 final newlines. So if you set this to nil, you must explicitly check and
342 add a final newline, whenever you save a file that really needs one."
352 "Non-nil says by default do auto-saving of every file-visiting buffer."
358 ;; Don't put "\\2" inside expand-file-name, since it will be
359 ;; transformed to "/2" on DOS/Windows.
361 "Transforms to apply to buffer file name before making auto-save file name.
362 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
363 REGEXP is a regular expression to match against the file name.
364 If it matches, `replace-match' is used to replace the
365 matching part with REPLACEMENT.
366 If the optional element UNIQUIFY is non-nil, the auto-save file name is
367 constructed by taking the directory part of the replaced file-name,
368 concatenated with the buffer file name with all directory separators
369 changed to `!' to prevent clashes. This will not work
370 correctly if your filesystem truncates the resulting name.
372 All the transforms in the list are tried, in the order they are listed.
373 When one transform applies, its result is final;
374 no further transforms are tried.
376 The default value is set up to put the auto-save file into the
377 temporary directory (see the variable `temporary-file-directory') for
378 editing a remote file.
380 On MS-DOS filesystems without long names this variable is always
381 ignored."
389 "Non-nil means save word abbrevs too when files are saved.
390 If `silently', don't ask the user before saving."
395 "Non-nil means allow `find-file' to visit directories.
396 To visit the directory, `find-file' runs `find-directory-functions'."
401 "List of functions to try in sequence to visit a directory.
402 Each function is called with the directory name as the sole argument
403 and should return either a buffer or nil."
407 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
409 "List of functions to try in sequence to get a file name at point.
410 Each function should return either nil or a file name found at the
411 location of point in the current buffer."
415 ;;;It is not useful to make this a local variable.
416 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
418 "List of functions to be called for `find-file' on nonexistent file.
419 These functions are called as soon as the error is detected.
420 Variable `buffer-file-name' is already set up.
425 ;;;It is not useful to make this a local variable.
426 ;;;(put 'find-file-hooks 'permanent-local t)
429 "List of functions to be called after a buffer is loaded from a file.
430 The buffer's local variables (if any) will have been processed before the
431 functions are called."
438 "List of functions to be called before writing out a buffer to a file.
439 If one of them returns non-nil, the file is considered already written
440 and the rest are not called.
441 These hooks are considered to pertain to the visited file.
442 So any buffer-local binding of this variable is discarded if you change
444 change the major mode.
446 This hook is not run if any of the functions in
447 `write-contents-functions' returns non-nil. Both hooks pertain
448 to how to save a buffer to file, for instance, choosing a suitable
449 coding system and setting mode bits. (See Info
450 node `(elisp)Saving Buffers'.) To perform various checks or
461 "List of functions to be called before writing out a buffer to a file.
462 If one of them returns non-nil, the file is considered already written
463 and the rest are not called and neither are the functions in
464 `write-file-functions'.
466 This variable is meant to be used for hooks that pertain to the
467 buffer's contents, not to the particular visited file; thus,
468 `set-visited-file-name' does not clear this variable; but changing the
469 major mode does clear it.
471 For hooks that _do_ pertain to the particular visited file, use
472 `write-file-functions'. Both this variable and
473 `write-file-functions' relate to how a buffer is saved to file.
474 To perform various checks or updates before the buffer is saved,
481 "Control use of local variables in files you visit.
482 The value can be t, nil, :safe, :all, or something else.
484 A value of t means file local variables specifications are obeyed
485 if all the specified variable values are safe; if any values are
486 not safe, Emacs queries you, once, whether to set them all.
487 \(When you say yes to certain values, they are remembered as safe.)
489 :safe means set the safe variables, and ignore the rest.
490 :all means set all variables, whether safe or not.
491 (Don't set it permanently to :all.)
492 A value of nil means always ignore the file local variables.
494 Any other value means always query you once whether to set them all.
495 \(When you say yes to certain values, they are remembered as safe, but
498 This variable also controls use of major modes specified in
499 a -*- line.
502 always obeys file local variable specifications and the -*- line,
503 and ignores this variable."
504 :risky t
513 "Like `enable-local-variables' but meant for buffer-local bindings.
514 The meaningful values are nil and non-nil. The default is non-nil.
515 If a major mode sets this to nil, buffer-locally, then any local
516 variables list in the file will be ignored.
518 This variable does not affect the use of major modes
523 The value can be t, nil or something else.
524 A value of t means obey `eval' variables.
525 A value of nil means ignore them; anything else means query."
526 :risky t
532 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
541 "Non-nil means buffers visiting files read-only do so in view mode.
542 In fact, this means that all read-only buffers normally have
543 View mode enabled, including buffers that are read-only because
544 you visit a file you cannot alter, and buffers you make read-only
550 "History list of file names entered in the minibuffer.
552 Maximum length of the history list is determined by the value
554 \f
557 "Provides support for ange-ftp host name completion.
558 Runs the usual ange-ftp hook, but only for completion operations."
559 ;; Having this here avoids the need to load ange-ftp when it's not
560 ;; really in use.
566 inhibit-file-name-handlers)))
574 "Convert a standard file's name to something suitable for the OS.
575 This means to guarantee valid names and perhaps to canonicalize
576 certain patterns.
578 FILENAME should be an absolute file name since the conversion rules
579 sometimes vary depending on the position in the file name. E.g. c:/foo
580 is a valid DOS file name, but c:/bar/c:/foo is not.
582 This function's standard definition is trivial; it just returns
583 the argument. However, on Windows and DOS, replace invalid
584 characters. On DOS, make sure to obey the 8.3 limitations.
585 In the native Windows build, turn Cygwin names into native names,
586 and also turn slashes into backslashes if the shell requires it (see
587 `w32-shell-dos-semantics').
589 See Info node `(elisp)Standard File Names' for more details."
594 ;; Replace invalid filename characters with !
598 name))
606 "Read directory name, prompting with PROMPT and completing in directory DIR.
607 Value is not expanded---you must call `expand-file-name' yourself.
608 Default name to DEFAULT-DIRNAME if user exits with the same
609 non-empty string that was inserted by this function.
610 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
611 or just DIR if INITIAL is nil.)
612 If the user exits with an empty minibuffer, this function returns
613 an empty string. (This can only happen if the user erased the
614 pre-inserted contents or if `insert-default-directory' is nil.)
615 Fourth arg MUSTMATCH non-nil means require existing directory's name.
616 Non-nil and non-t means also require confirmation after completion.
617 Fifth arg INITIAL specifies text to start with.
618 DIR should be an absolute directory name. It defaults to
619 the value of `default-directory'."
624 dir))
625 mustmatch initial
628 \f
630 "Show the current default directory."
635 "Value of the CDPATH environment variable, as a list.
639 "Explode a search path into a list of directory names.
640 Directories are separated by occurrences of `path-separator'
641 \(which is colon in GNU and GNU-like systems)."
642 ;; We could use split-string here.
650 nil
655 cd-list)))
658 "Change current directory to given absolute file name DIR."
659 ;; Put the name into directory syntax now,
660 ;; because otherwise expand-file-name may give some bad results.
662 ;; We used to additionally call abbreviate-file-name here, for an
663 ;; unknown reason. Problem is that most buffers are setup
664 ;; without going through cd-absolute and don't call
665 ;; abbreviate-file-name on their default-directory, so the few that
666 ;; do end up using a superficially different directory.
678 "Make DIR become the current buffer's default directory.
679 If your environment includes a `CDPATH' variable, try each one of
680 that list of directories (separated by occurrences of
681 `path-separator') when resolving a relative directory name.
682 The path separator is colon in GNU and GNU-like systems."
685 ;; FIXME: There's a subtle bug in the completion below. Seems linked
686 ;; to a fundamental difficulty of implementing `predicate' correctly.
687 ;; The manifestation is that TAB may list non-directories in the case where
688 ;; those files also correspond to valid directories (if your cd-path is (A/
689 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
690 ;; will be listed as valid completions).
691 ;; This is because `a' (listed because of A/a) is indeed a valid choice
692 ;; (which will lead to the use of B/a).
697 cd-path nil))
706 default-directory default-directory
707 t))))
717 "Load the Lisp file named FILE."
718 ;; This is a case where .elc makes a lot of sense.
725 "Search for FILENAME through PATH.
726 If found, return the absolute file name of FILENAME, with its suffixes;
727 otherwise return nil.
728 PATH should be a list of directories to look in, like the lists in
729 `exec-path' or `load-path'.
730 If SUFFIXES is non-nil, it should be a list of suffixes to append to
733 If non-nil, PREDICATE is used instead of `file-readable-p'.
735 This function will normally skip directories, so if you want it to find
736 directories, make sure the PREDICATE function returns `dir-ok' for them.
738 PREDICATE can also be an integer to pass to the `access' system call,
739 in which case file-name handlers are ignored. This usage is deprecated.
740 For compatibility, PREDICATE can also be one of the symbols
741 `executable', `readable', `writable', or `exists', or a list of
742 one or more of those symbols."
753 "Do completion for file names passed to `locate-file'."
756 ;; FIXME: maybe we should use completion-file-name-table instead,
757 ;; tho at least for `load', the arg is passed through
758 ;; substitute-in-file-name for historical reasons.
768 ;; If we have files like "foo.el" and "foo.elc", we could load one of
769 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
770 ;; preferred way. So if we list all 3, that gives a lot of redundant
771 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
772 ;; the user does want to pay attention to the extension. We try to
773 ;; diffuse this tension by stripping the suffix, except when the
774 ;; result is a single element (i.e. usually we only list "foo" unless
775 ;; it's the only remaining element in the list, in which case we do
776 ;; list "foo", "foo.elc" and "foo.el").
787 string-file dir))
792 ;; Switching from names to names+fullnames creates a non-monotonicity
793 ;; which can cause problems with things like partial-completion.
794 ;; To minimize the problem, filter out completion-regexp-list, so that
795 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
796 ;; from `names' which only matched `string' when they still had
797 ;; their suffix.
799 ;; Remove duplicates of the first element, so that we can easily check
800 ;; if `names' really only contains a single element.
803 ;; There's no more than one matching non-suffixed element, so expand
804 ;; the list by adding the suffixed elements as well.
807 string-dir names string-file pred action)))))
810 "Do completion for file names passed to `locate-file'.
811 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
814 string nil action))
819 "Regexp of directory names which stop the search in `locate-dominating-file'.
820 Any directory whose name matches this regexp will be treated like
821 a kind of root directory by `locate-dominating-file' which will stop its search
822 when it bumps into it.
823 The default regexp prevents fruitless and time-consuming attempts to find
824 special files in directories in which filenames are interpreted as hostnames,
827 ;; (defun locate-dominating-files (file regexp)
828 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
829 ;; Stop at the first parent where a matching file is found and return the list
830 ;; of files that that match in this directory."
831 ;; (catch 'found
832 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
833 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
834 ;; (let ((user nil)
835 ;; ;; Abbreviate, so as to stop when we cross ~/.
836 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
837 ;; files)
838 ;; (while (and dir
839 ;; ;; As a heuristic, we stop looking up the hierarchy of
840 ;; ;; directories as soon as we find a directory belonging to
841 ;; ;; another user. This should save us from looking in
842 ;; ;; things like /net and /afs. This assumes that all the
843 ;; ;; files inside a project belong to the same user.
844 ;; (let ((prev-user user))
845 ;; (setq user (nth 2 (file-attributes dir)))
846 ;; (or (null prev-user) (equal user prev-user))))
847 ;; (if (setq files (condition-case nil
848 ;; (directory-files dir 'full regexp 'nosort)
849 ;; (error nil)))
850 ;; (throw 'found files)
851 ;; (if (equal dir
852 ;; (setq dir (file-name-directory
853 ;; (directory-file-name dir))))
854 ;; (setq dir nil))))
855 ;; nil)))
858 "Look up the directory hierarchy from FILE for a file named NAME.
859 Stop at the first parent directory containing a file NAME,
860 and return the directory. Return nil if not found."
861 ;; We used to use the above locate-dominating-files code, but the
862 ;; directory-files call is very costly, so we're much better off doing
863 ;; multiple calls using the code in here.
864 ;;
865 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
866 ;; `name' in /home or in /.
869 ;; `user' is not initialized outside the loop because
870 ;; `file' may not exist, so we may have to walk up part of the
871 ;; hierarchy before we find the "initial UID". Note: currently unused
872 ;; (user nil)
873 try)
876 ;; FIXME: Disabled this heuristic because it is sometimes
877 ;; inappropriate.
878 ;; As a heuristic, we stop looking up the hierarchy of
879 ;; directories as soon as we find a directory belonging
880 ;; to another user. This should save us from looking in
881 ;; things like /net and /afs. This assumes that all the
882 ;; files inside a project belong to the same user.
883 ;; (let ((prev-user user))
884 ;; (setq user (nth 2 (file-attributes file)))
885 ;; (and prev-user (not (equal user prev-user))))
892 root))
896 "Search for COMMAND in `exec-path' and return the absolute file name.
897 Return nil if COMMAND is not found anywhere in `exec-path'."
898 ;; Use 1 rather than file-executable-p to better match the behavior of
899 ;; call-process.
903 "Load the Emacs Lisp library named LIBRARY.
904 This is an interface to the function `load'. LIBRARY is searched
905 for in `load-path', both with and without `load-suffixes' (as
906 well as `load-file-rep-suffixes').
908 See Info node `(emacs)Lisp Libraries' for more details.
909 See `load-file' for a different interface to `load'."
913 load-path
918 "Test whether FILE specifies a location on a remote system.
919 Returns nil or a string identifying the remote connection (ideally
920 a prefix of FILE). For example, the remote identification for filename
923 less reliable than accessing local files.
924 Furthermore, relative file names do not work across remote connections.
926 IDENTIFICATION specifies which part of the identification shall
927 be returned as string. IDENTIFICATION can be the symbol
928 `method', `user', `host' or `localname'; any other value is
929 handled like nil and means to return the complete identification
930 string.
932 If CONNECTED is non-nil, the function returns an identification only
933 if FILE is located on a remote system, and a connection is established
934 to that remote system.
936 `file-remote-p' will never open a connection on its own."
940 nil)))
943 "Whether to use the remote file-name cache for read access.
945 When `nil', always use the cached values.
946 When `t', never use them.
947 A number means use them for that amount of seconds since they were
948 cached.
950 File attributes of remote files are cached for better performance.
951 If they are changed out of Emacs' control, the cached values
952 become invalid, and must be invalidated.
954 In case a remote file is checked regularly, it might be
955 reasonable to let-bind this variable to a value less then the
956 time period between two checks.
957 Example:
959 (defun display-time-file-nonempty-p (file)
960 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
961 (and (file-exists-p file)
962 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
973 "Copy the file FILE into a temporary file on this machine.
974 Returns the name of the local copy, or nil, if FILE is directly
975 accessible."
976 ;; This formerly had an optional BUFFER argument that wasn't used by
977 ;; anything.
981 nil)))
984 "Return the truename of FILENAME.
985 If FILENAME is not absolute, first expands it against `default-directory'.
986 The truename of a file name is found by chasing symbolic links
987 both at the level of the file and at the level of the directories
988 containing it, until no links are left at any level.
991 ;; COUNTER and PREV-DIRS are only used in recursive calls.
992 ;; COUNTER can be a cons cell whose car is the count of how many
993 ;; more links to chase before getting an error.
994 ;; PREV-DIRS can be a cons cell whose car is an alist
995 ;; of truenames we've just recently computed.
1009 ;; For speed, remove the ange-ftp completion handler from the list.
1010 ;; We know it's not needed here.
1011 ;; For even more speed, do this only on the outermost call.
1018 ;; andrewi@harlequin.co.uk - none of the following code (except for
1019 ;; invoking the file-name handler) currently applies on Windows
1020 ;; (ie. there are no native symlinks), but there is an issue with
1021 ;; case differences being ignored by the OS, and short "8.3 DOS"
1022 ;; name aliases existing for all files. (The short names are not
1023 ;; reported by directory-files, but can be used to refer to files.)
1024 ;; It seems appropriate for file-truename to resolve these issues in
1025 ;; the most natural way, which on Windows is to call the function
1026 ;; `w32-long-file-name' - this returns the exact name of a file as
1027 ;; it is stored on disk (expanding short name aliases with the full
1028 ;; name in the process).
1031 ;; For file name that has a special handler, call handler.
1032 ;; This is so that ange-ftp can save time by doing a no-op.
1035 ;; If filename contains a wildcard, newname will be the old name.
1037 ;; If filename exists, use the long name. If it doesn't exist,
1038 ;; drill down until we find a directory that exists, and use
1039 ;; the long name of that, with the extra non-existent path
1040 ;; components concatenated.
1042 missing rest)
1045 ;; Include the preceding directory separator in the missing
1046 ;; part so subsequent recursion on the rest works.
1051 ""
1056 ;; If this file directly leads to a link, process that iteratively
1057 ;; so that we don't use lots of stack.
1063 ;; For file name that has a special handler, call handler.
1064 ;; This is so that ange-ftp can save time by doing a no-op.
1067 done t)
1069 target dirfile)
1070 ;; Get the truename of the directory.
1072 ;; If these are equal, we have the (or a) root directory.
1074 ;; If this is the same dir we last got the truename for,
1075 ;; save time--don't recalculate.
1085 done t)
1088 done t)
1089 ;; Put it back on the file name.
1091 ;; Is the file name the name of a link?
1094 ;; Yes => chase that link, then start all over
1095 ;; since the link may point to a directory name that uses links.
1096 ;; We can't safely use expand-file-name here
1097 ;; since target might look like foo/../bar where foo
1098 ;; is itself a link. Instead, we handle . and .. above.
1101 target
1103 done nil)
1104 ;; No, we are done!
1106 filename))
1109 "Chase links in FILENAME until a name that is not a link.
1110 Unlike `file-truename', this does not check whether a parent
1111 directory name is a symbolic link.
1112 If the optional argument LIMIT is a number,
1113 it means chase no more than that many links and then stop."
1121 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1124 ;; Handle `..' by hand, since it needs to work in the
1125 ;; target of any directory symlink.
1126 ;; This code is not quite complete; it does not handle
1127 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1131 ;; Chase links in the default dir of the symlink.
1135 ;; Now find the parent of that dir.
1139 newname))
1141 ;; A handy function to display file sizes in human-readable form.
1142 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1144 "Produce a string showing FILE-SIZE in human-readable form.
1146 Optional second argument FLAVOR controls the units and the display format:
1148 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1150 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1152 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1155 1024.0
1158 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1164 "%.1f%s%s"
1166 file-size
1168 "K"
1173 "Create a temporary file.
1174 The returned file name (created by appending some random characters at the end
1175 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1176 is guaranteed to point to a newly created empty file.
1177 You can then use `write-region' to write new data into the file.
1179 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1181 If SUFFIX is non-nil, add that at the end of the file name."
1183 file)
1186 ;; Create temp files with strict access rights. It's easy to
1187 ;; loosen them later, whereas it's impossible to close the
1188 ;; time-window of loose permissions otherwise.
1196 temporary-file-directory)
1198 temporary-file-directory))))
1204 nil)
1206 ;; the file was somehow created by someone else between
1207 ;; `make-temp-name' and `write-region', let's try again.
1208 nil)
1209 file)
1210 ;; Reset the umask.
1214 "Change the encoding of FILE's name from CODING to NEW-CODING.
1215 The value is a new name of FILE.
1216 Signals a `file-already-exists' error if a file of the new name
1217 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1218 is non-nil. A number as fourth arg means request confirmation if
1219 the new name already exists. This is what happens in interactive
1220 use with M-x."
1223 default-file-name-coding-system))
1225 from-coding to-coding)
1227 ;; We provide the default coding only when it seems that
1228 ;; the filename is correctly decoded by the default
1229 ;; coding.
1235 filename default-coding)
1236 default-coding))
1240 ;; We provide the default coding only when a user is going to
1241 ;; change the encoding not from the default coding.
1245 filename from-coding)))
1248 filename from-coding default-coding)
1249 default-coding)))
1253 default-file-name-coding-system))
1254 ;; FILE should have been decoded by DEFAULT-CODING.
1258 ;; Suppress further encoding.
1263 newname))
1264 \f
1266 "Whether confirmation is requested before visiting a new file or buffer.
1267 If nil, confirmation is not requested.
1268 If the value is `after-completion', confirmation is only
1269 requested if the user called `minibuffer-complete' right before
1270 `minibuffer-complete-and-exit'.
1271 Any other non-nil value means to request confirmation.
1273 This affects commands like `switch-to-buffer' and `find-file'."
1281 "Whether to request confirmation before visiting a new file or buffer.
1282 The variable `confirm-nonexistent-file-or-buffer' determines the
1283 return value, which may be passed as the REQUIRE-MATCH arg to
1284 `read-buffer' or `find-file-read-args'."
1292 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1293 BODY should use the minibuffer at most once.
1294 Recursive uses of the minibuffer are unaffected (FUN is not
1295 called additional times).
1297 This macro actually adds an auxiliary function that calls FUN,
1298 rather than FUN itself, to `minibuffer-setup-hook'."
1304 ;; Clear out this hook so it does not interfere
1305 ;; with any recursive minibuffer usage.
1316 t))
1319 "Edit file FILENAME.
1320 Switch to a buffer visiting file FILENAME,
1321 creating one if none already exists.
1322 Interactively, the default if you just type RET is the current directory,
1323 but the visited file name is available through the minibuffer history:
1324 type M-n to pull it into the minibuffer.
1326 You can visit files on remote machines by specifying something
1327 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1328 also visit local files as a different user by specifying
1329 /sudo::FILE for the file name.
1330 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1331 manual, for more about this.
1333 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1334 expand wildcards (if any) and visit multiple files. You can
1335 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1337 To visit a file without any kind of conversion and without
1348 "Edit file FILENAME, in another window.
1351 an existing one. See the function `display-buffer'.
1353 Interactively, the default if you just type RET is the current directory,
1354 but the visited file name is available through the minibuffer history:
1355 type M-n to pull it into the minibuffer.
1357 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1358 expand wildcards (if any) and visit multiple files."
1371 "Edit file FILENAME, in another frame.
1374 an existing one. See the function `display-buffer'.
1376 Interactively, the default if you just type RET is the current directory,
1377 but the visited file name is available through the minibuffer history:
1378 type M-n to pull it into the minibuffer.
1380 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1381 expand wildcards (if any) and visit multiple files."
1394 "Edit the existing file FILENAME.
1396 file names with wildcards."
1405 "Edit file FILENAME but don't allow changes.
1419 value))
1422 "Edit file FILENAME in another window but don't allow changes.
1436 value))
1439 "Edit file FILENAME in another frame but don't allow changes.
1453 value))
1456 "Find file FILENAME as a replacement for the file in the next window.
1457 This command does not select that window.
1461 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1462 expand wildcards (if any) and replace the file with multiple files."
1473 "Find alternate file: " file-dir nil
1475 t))))
1485 "Find file FILENAME, select its buffer, kill previous buffer.
1486 If the current buffer now contains an empty file that you just visited
1487 \(presumably by mistake), use this command to visit the file you really want.
1491 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1492 expand wildcards (if any) and replace the file with multiple files.
1494 If the current buffer is an indirect buffer, or the base buffer
1495 for one or more indirect buffers, the other buffer(s) are not
1496 killed."
1505 "Find alternate file: " file-dir nil
1507 t)))
1522 ;; Run `kill-buffer-hook' here. It needs to happen before
1523 ;; variables like `buffer-file-name' etc are set to nil below,
1524 ;; because some of the hooks that could be invoked
1525 ;; (e.g., `save-place-to-alist') depend on those variables.
1526 ;;
1527 ;; Note that `kill-buffer-hook' is not what queries whether to
1528 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1529 ;; asks that itself. Thus, there's no need to temporarily do
1530 ;; `(set-buffer-modified-p nil)' before running this hook.
1532 ;; Okay, now we can end-of-life the old buffer.
1539 ;; This prevents us from finding the same buffer
1540 ;; if we specified the same file again.
1544 ;; Likewise for dired buffers.
1548 ;; This executes if find-file gets an error
1549 ;; and does not really find anything.
1550 ;; We put things back as they were.
1551 ;; If find-file actually finds something, we kill obuf below.
1560 ;; We already ran these; don't run them again.
1563 \f
1565 "Create a suitably named buffer for visiting FILENAME, and return it.
1566 FILENAME (sans directory) is used unchanged if that name is free;
1567 otherwise a string <2> or <3> or ... is appended to get an unused name.
1568 Spaces at the start of FILENAME (sans directory) are removed."
1577 "Create and return a buffer with a name based on NAME.
1578 Choose the buffer's name using `generate-new-buffer-name'."
1582 "Regexp to match the automounter prefix in a directory name."
1590 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1592 home directory is a root directory) and removes automounter prefixes
1593 \(see the variable `automount-dir-prefix')."
1594 ;; Get rid of the prefixes added by the automounter.
1601 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1602 ;; To fix this right, we need a `file-name-case-sensitive-p'
1603 ;; function, but we don't have that yet, so just guess.
1606 ;; If any elt of directory-abbrev-alist matches this name,
1607 ;; abbreviate accordingly.
1613 ;; Compute and save the abbreviated homedir name.
1614 ;; We defer computing this until the first time it's needed, to
1615 ;; give time for directory-abbrev-alist to be set properly.
1616 ;; We include a slash at the end, to avoid spurious matches
1617 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1624 ;; If FILENAME starts with the abbreviated homedir,
1625 ;; make it start with `~' instead.
1627 ;; If the home dir is just /, don't change it.
1630 ;; MS-DOS root directories can come with a drive letter;
1631 ;; Novell Netware allows drive letters beyond `Z:'.
1639 filename)))
1642 "List of logical names for which visiting shouldn't save the true dirname."
1647 "Return the buffer visiting file FILENAME (a string).
1648 This is like `get-file-buffer', except that it checks for any buffer
1649 visiting the same file, possibly under a different name.
1650 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1651 and others are ignored.
1652 If there is no such live buffer, return nil."
1665 found)
1675 ;; Verify this buffer's file number
1676 ;; still belongs to its file.
1679 attributes)
1683 found))))
1684 \f
1686 "Non-nil means file-visiting commands should handle wildcards.
1687 For example, if you specify `*.c', that would visit all the files
1688 whose names match the pattern."
1694 "Non-nil means suppress warning messages for symlinked files.
1695 When nil, Emacs prints a warning when visiting a file that is already
1696 visited, but with a different name. Setting this option to t
1697 suppresses this warning."
1703 "Maximum size of file above which a confirmation is requested.
1704 When nil, never request confirmation."
1711 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1712 OP-TYPE specifies the file operation being performed (for message to user)."
1721 "Read file FILENAME into a buffer and return the buffer.
1722 If a buffer exists visiting FILENAME, return that one, but
1723 verify that the file has not changed since visited or saved.
1724 The buffer is not selected, just returned to the caller.
1725 Optional second arg NOWARN non-nil means suppress any warning messages.
1726 Optional third arg RAWFILE non-nil means the file is read literally.
1727 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1728 and visit all the matching files. When wildcards are actually
1729 used and expanded, return a list of buffers that are visiting
1730 the various files."
1737 'find-directory-functions
1740 filename)))
1743 find-file-wildcards
1757 ;; Find any buffer for a file which has same truename.
1759 ;; Let user know if there is a buffer with the same truename.
1763 find-file-suppress-same-file-warnings
1767 ;; Optionally also find that buffer.
1770 ;; Check to see if the file looks uncommonly large.
1774 ;; We are using an existing buffer.
1781 ;; Certain files should be reverted automatically
1782 ;; if they have changed on disk and not in the buffer.
1790 found))
1800 "File %s changed on disk. Discard your edits? "
1805 "File %s changed on disk. Discard your edits in %s? "
1813 ;; Check if a formerly read-only file has become
1814 ;; writable and vice versa, but if the buffer agrees
1815 ;; with the new state of the file, that is ok too.
1823 buffer-file-name
1832 ;; It is confusing to ask whether to visit
1833 ;; non-literally if they have the file in
1834 ;; hexl-mode or image-mode.
1840 "The file %s is already visited normally,
1841 and you have edited the buffer. Now you have asked to visit it literally,
1842 meaning no coding system handling, format conversion, or local variables.
1843 Emacs can only visit a file in one way at a time.
1845 Do you want to save the file, and visit it literally instead? "
1846 "The file %s is already visited literally,
1847 meaning no coding system handling, format conversion, or local variables.
1848 You have edited the buffer. Now you have asked to visit the file normally,
1849 but Emacs can only visit a file in one way at a time.
1856 rawfile truename number))
1860 "\
1861 Do you want to discard your changes, and visit the file literally now? "
1862 "\
1865 rawfile truename number)
1871 "The file %s is already visited normally.
1872 You have asked to visit it literally,
1873 meaning no coding system decoding, format conversion, or local variables.
1874 But Emacs can only visit a file in one way at a time.
1876 Do you want to revisit the file literally now? "
1877 "The file %s is already visited literally,
1878 meaning no coding system decoding, format conversion, or local variables.
1879 You have asked to visit it normally,
1880 but Emacs can only visit a file in one way at a time.
1885 rawfile truename number)
1888 ;; Return the buffer we are using.
1889 buf)
1890 ;; Create a new buffer.
1892 ;; find-file-noselect-1 may use a different buffer.
1894 rawfile truename number))))))
1900 ;; Needed in case we are re-visiting the file with a different
1901 ;; text representation.
1918 filename)))
1919 ;; Unconditionally set error
1929 filename)))
1930 ;; Run find-file-not-found-functions until one returns non-nil.
1932 ;; If they fail too, set error.
1934 ;; Record the file's truename, and maybe use that as visited name.
1942 ;; Set buffer's default directory to that of the file.
1944 ;; Turn off backup files for certain file names. Since
1945 ;; this is a permanent local, the major mode won't eliminate it.
1960 \f
1962 "Like `insert-file-contents', but only reads in the file literally.
1963 A buffer may be modified in several ways after reading into the buffer,
1964 to Emacs features such as format decoding, character code
1965 conversion, `find-file-hook', automatic uncompression, etc.
1967 This function ensures that none of these modifications will take place."
1975 nil))
1978 inhibit-file-name-handlers))
1991 filename)))
1992 ;; Check whether the file is uncommonly large
2003 "Insert contents of file FILENAME into buffer after point with no conversion.
2005 This function is meant for the user to run interactively.
2006 Don't call it from programs! Use `insert-file-contents-literally' instead.
2007 \(Its calling sequence is different; see its documentation)."
2012 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2013 This has the `permanent-local' property, which takes effect if you
2018 "Visit file FILENAME with no conversion of any kind.
2019 Format conversion and character code conversion are both disabled,
2020 and multibyte characters are disabled in the resulting buffer.
2021 The major mode used is Fundamental mode regardless of the file name,
2022 and local variable specifications in the file are ignored.
2023 Automatic uncompression and adding a newline at the end of the
2024 file due to `require-final-newline' is also disabled.
2026 You cannot absolutely rely on this function to result in
2027 visiting the file literally. If Emacs already has a buffer
2028 which is visiting the file, you get the existing buffer,
2029 regardless of whether it was created literally or not.
2031 In a Lisp program, if you want to be sure of accessing a file's
2032 contents literally, you should create a temporary buffer and then read
2033 the file contents into it using `insert-file-contents-literally'."
2036 "Find file literally: " nil default-directory
2039 \f
2041 _after-find-file-from-revert-buffer
2042 nomodes)
2043 "Called after finding a file and by the default revert function.
2044 Sets buffer mode, parses local variables.
2045 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2046 error in reading the file. WARN non-nil means warn if there
2047 exists an auto-save file more recent than the visited file.
2048 NOAUTO means don't mess with auto-save mode.
2049 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2050 \(see `revert-buffer-in-progress-p' for similar functionality).
2051 Fifth arg NOMODES non-nil means don't alter the file's modes.
2052 Finishes by calling the functions in `find-file-hook'
2053 unless NOMODES is non-nil."
2056 nil
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.
2468 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2469 When checking `inhibit-first-line-modes-regexps', we first discard
2475 "Regexp matching interpreters, for file mode determination.
2476 This regular expression is matched against the first line of a file
2477 to determine the file's mode in `set-auto-mode'. If it matches, the file
2478 is assumed to be interpreted by the interpreter matched by the second group
2479 of the regular expression. The mode is then determined as the mode
2483 "Alist of buffer beginnings vs. corresponding major mode functions.
2484 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2485 After visiting a file, if REGEXP matches the text at the beginning of the
2486 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2487 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2488 major mode.
2490 If FUNCTION is nil, then it is not called. (That is a way of saying
2498 ;; The < comes before the groups (but the first) to reduce backtracking.
2499 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2500 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2504 comment-re "*"
2507 . html-mode)
2509 ;; These two must come after html, because they are more general:
2514 . sgml-mode)
2517 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2518 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2519 After visiting a file, if REGEXP matches the text at the beginning of the
2520 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2521 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2522 have not specified a mode for this file.
2528 "Upper limit on `magic-mode-alist' regexp matches.
2532 "Select major mode appropriate for current buffer.
2534 To find the right major mode, this function checks for a -*- mode tag,
2535 checks for a `mode:' entry in the Local Variables section of the file,
2536 checks if it uses an interpreter listed in `interpreter-mode-alist',
2537 matches the buffer beginning against `magic-mode-alist',
2538 compares the filename against the entries in `auto-mode-alist',
2539 then matches the buffer beginning against `magic-fallback-mode-alist'.
2541 If `enable-local-variables' is nil, this function does not check for
2542 any mode: tag anywhere in the file.
2544 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2545 set the major mode only if that would change it. In other words
2546 we don't actually set it to the same mode the buffer already has."
2547 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2549 ;; Once we drop the deprecated feature where mode: is also allowed to
2550 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2551 ;; remove this section and just let (hack-local-variables t) handle it.
2552 ;; Find a -*- mode tag.
2559 ;; Find all specifications for the `mode:' variable
2560 ;; and execute them left to right.
2572 modes)))
2573 ;; Simple -*-MODE-*- case.
2576 modes))))
2577 ;; If we found modes to use, invoke them now, outside the save-excursion.
2585 ;; continuing would call minor modes again, toggling them off
2588 enable-local-variables
2595 ;; If we didn't, look for an interpreter specified in the first line.
2596 ;; As a special case, allow for things like "#!/bin/env perl", which
2597 ;; finds the interpreter anywhere in $PATH.
2604 ;; Map interpreter name to a mode, signalling we're done at the
2605 ;; same time.
2607 interpreter-mode-alist))
2608 ;; If we found an interpreter mode to use, invoke it now.
2611 ;; Next try matching the buffer beginning against magic-mode-alist.
2625 ;; Next compare the filename against the entries in auto-mode-alist.
2630 ;; Remove remote file name identification.
2634 ;; Remove backup-suffixes from file name.
2637 ;; Find first matching alist entry.
2640 ;; System is case-insensitive.
2644 ;; System is case-sensitive.
2646 ;; First match case-sensitively.
2650 ;; Fallback to case-insensitive match.
2664 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2679 ;; When `keep-mode-if-same' is set, we are working on behalf of
2680 ;; set-visited-file-name. In that case, if the major mode specified is the
2681 ;; same one we already have, don't actually reset it. We don't want to lose
2682 ;; minor modes such as Font Lock.
2684 "Apply MODE and return it.
2685 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2686 any aliases and compared to current major mode. If they are the
2687 same, do nothing and return nil."
2693 mode)))
2696 "Find the -*- spec in the buffer.
2697 Call with point at the place to start searching from.
2698 If one is found, set point to the beginning
2699 and return the position of the end.
2700 Otherwise, return nil; point may be changed."
2703 ;; Don't look for -*- if this file name matches any
2704 ;; of the regexps in inhibit-first-line-modes-regexps.
2712 sufs)
2720 ;; If the file begins with "#!"
2721 ;; (exec interpreter magic), look
2722 ;; for mode frobs in the first two
2723 ;; lines. You cannot necessarily
2724 ;; put them in the first line of
2725 ;; such a file without screwing up
2726 ;; the interpreter invocation.
2727 ;; The same holds for
2728 ;; '\"
2729 ;; in man pages (preprocessor
2730 ;; magic for the `man' program).
2741 end))))
2742 \f
2743 ;;; Handling file local variables
2747 file-local-variables-alist dir-local-variables-alist)
2752 "Normal hook run after processing a file's local variables specs.
2753 Major modes can use this to examine user-specified local variables
2757 "List variable-value pairs that are considered safe.
2758 Each element is a cons cell (VAR . VAL), where VAR is a variable
2759 symbol and VAL is a value that is considered safe."
2760 :risky t
2765 ;; This should be here at least as long as Emacs supports write-file-hooks.
2769 "Expressions that are considered safe in an `eval:' local variable.
2770 Add expressions to this list if you want Emacs to evaluate them, when
2771 they appear in an `eval' local variable specification, without first
2772 asking you for confirmation."
2773 :risky t
2778 ;; Risky local variables:
2781 buffer-auto-save-file-name
2782 buffer-file-name
2783 buffer-file-truename
2784 buffer-undo-list
2785 debugger
2786 default-text-properties
2787 eval
2788 exec-directory
2789 exec-path
2790 file-name-handler-alist
2791 frame-title-format
2792 global-mode-string
2793 header-line-format
2794 icon-title-format
2795 inhibit-quit
2796 load-path
2797 max-lisp-eval-depth
2798 max-specpdl-size
2799 minor-mode-map-alist
2800 minor-mode-overriding-map-alist
2801 mode-line-format
2802 mode-name
2803 overriding-local-map
2804 overriding-terminal-local-map
2805 process-environment
2806 standard-input
2807 standard-output
2808 unread-command-events))
2810 ;; Safe local variables:
2811 ;;
2812 ;; For variables defined by major modes, the safety declarations can go into
2813 ;; the major mode's file, since that will be loaded before file variables are
2814 ;; processed.
2815 ;;
2816 ;; For variables defined by minor modes, put the safety declarations in the
2817 ;; file defining the minor mode after the defcustom/defvar using an autoload
2818 ;; cookie, e.g.:
2819 ;;
2820 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2821 ;;
2822 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2823 ;; minor mode file may not be loaded yet.
2824 ;;
2825 ;; For variables defined in the C source code the declaration should go here:
2847 "Alist of file-local variable settings in the current buffer.
2848 Each element in this list has the form (VAR . VALUE), where VAR
2849 is a file-local variable (a symbol) and VALUE is the value
2850 specified. The actual value in the buffer may differ from VALUE,
2856 "Alist of directory-local variable settings in the current buffer.
2857 Each element in this list has the form (VAR . VALUE), where VAR
2858 is a directory-local variable (a symbol) and VALUE is the value
2859 specified in .dir-locals.el. The actual value in the buffer
2860 may differ from VALUE, if it is changed by the major or minor modes,
2865 "Normal hook run before setting file-local variables.
2866 It is called after checking for unsafe/risky variables and
2867 setting `file-local-variables-alist', and before applying the
2868 variables stored in `file-local-variables-alist'. A hook
2869 function is allowed to change the contents of this alist.
2871 This hook is called only if there is at least one file-local
2875 "Get confirmation before setting up local variable values.
2876 ALL-VARS is the list of all variables to be set up.
2877 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2878 RISKY-VARS is the list of those that are marked as risky.
2879 If these settings come from directory-local variables, then
2880 DIR-NAME is the name of the associated directory. Otherwise it is nil."
2882 nil
2889 unsafe-vars))
2893 prompt char)
2901 ", and variables that are risky (**)."
2909 y -- to apply the local variables list.
2913 ! -- to apply the local variables list, and permanently mark these
2925 ;; Make strings with embedded whitespace easier to read.
2933 ""
2950 "Return local variables specified in the -*- line.
2951 Returns an alist of elements (VAR . VAL), where VAR is a variable
2952 and VAL is the specified value. Ignores any specification for
2953 `mode:' and `coding:' (which should have already been handled
2954 by `set-auto-mode' and `set-auto-coding', respectively).
2955 Throws an error if the -*- line is malformed.
2957 If MODE-ONLY is non-nil, just returns the symbol specifying the
2958 mode, if there is one, otherwise nil."
2962 result)
2964 nil)
2966 ;; Simple form: "-*- MODENAME -*-".
2970 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2971 ;; (last ";" is optional).
2972 ;; If MODE-ONLY, just check for `mode'.
2973 ;; Otherwise, parse the -*- line into the RESULT alist.
2980 ;; There used to be a downcase here,
2981 ;; but the manual didn't say so,
2982 ;; and people want to set var names that aren't all lc.
2988 ;; It is traditional to ignore
2989 ;; case when checking for `mode' in set-auto-mode,
2990 ;; so we must do that here as well.
2991 ;; That is inconsistent, but we're stuck with it.
2992 ;; The same can be said for `coding' in set-auto-coding.
3002 'eval
3007 result)))))
3010 "Filter local variable settings, querying the user if necessary.
3011 VARIABLES is the alist of variable-value settings. This alist is
3012 filtered based on the values of `ignored-local-variables',
3013 `enable-local-eval', `enable-local-variables', and (if necessary)
3014 user interaction. The results are added to
3015 `file-local-variables-alist', without applying them.
3016 If these settings come from directory-local variables, then
3017 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3018 ;; Find those variables that we may want to save to
3019 ;; `safe-local-variable-values'.
3025 ;; Ignore any variable in `ignored-local-variables'.
3026 nil)
3027 ;; Obey `enable-local-eval'.
3035 ;; Ignore duplicates (except `mode') in the present list.
3037 ;; Accept known-safe variables.
3041 ;; The variable is either risky or unsafe:
3048 ;; Query, unless all vars are safe or user wants no querying.
3054 risky-vars dir-name))
3065 "Parse and put into effect this buffer's local variables spec.
3066 Uses `hack-local-variables-apply' to apply the variables.
3069 is specified, and return the corresponding mode symbol, or nil.
3070 In this case, we try to ignore minor-modes, and only return a
3071 major-mode."
3074 result)
3080 ;; If MODE-ONLY is non-nil, and the prop line specifies a mode,
3081 ;; then we're done, and have no need to scan further.
3083 mode-only)
3084 ;; Look for "Local variables:" line in last page.
3092 ;; suffix is what comes after "local variables:" in its line.
3093 ;; prefix is what comes before "local variables:" in its line.
3103 beg)
3107 endpos
3113 nil t))
3114 ;; This used to be an error, but really all it means is
3115 ;; that this may simply not be a local-variables section,
3116 ;; so just ignore it.
3126 ;; Discard the prefix.
3131 ;; Discard the suffix.
3141 ;; Find the variable name; strip whitespace.
3150 val val2)
3151 ;; Read the variable value.
3158 ;; Specifying minor-modes via mode: is
3159 ;; deprecated, but try to reject them anyway.
3167 'eval
3172 ;; Now we've read all the local variables.
3173 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3175 ;; Otherwise, set the variables.
3181 "Apply the elements of `file-local-variables-alist'.
3182 If there are any elements, runs `before-hack-local-variables-hook',
3183 then calls `hack-one-local-variable' to apply the alist elements one by one.
3184 Finishes by running `hack-local-variables-hook', regardless of whether
3185 the alist is empty or not.
3187 Note that this function ignores a `mode' entry if it specifies the same
3188 major mode as the buffer already has."
3190 ;; Any 'evals must run in the Right sequence.
3199 "Non-nil if SYM is safe as a file-local variable with value VAL.
3200 It is safe if any of these conditions are met:
3202 * There is a matching entry (SYM . VAL) in the
3203 `safe-local-variable-values' user option.
3205 * The `safe-local-variable' property of SYM is a function that
3206 evaluates to a non-nil value with VAL as an argument."
3210 ;; If the function signals an error, that means it
3211 ;; can't assure us that the value is safe.
3215 "Non-nil if SYM could be dangerous as a file-local variable.
3216 It is dangerous if either of these conditions are met:
3218 * Its `risky-local-variable' property is non-nil.
3224 ;; If this is an alias, check the base name.
3244 "Return t if it is safe to eval EXP when it is found in a file."
3246 ;; Detect certain `put' expressions.
3253 lisp-indent-function
3254 scheme-indent-function))
3255 ;; Only allow safe values (not functions).
3260 ;; Only allow indirect form specs.
3261 ;; During bootstrapping, edebug-basic-spec might not be
3262 ;; defined yet.
3266 ;; Allow expressions that the user requested.
3268 ;; Certain functions can be allowed with safe arguments
3269 ;; or can specify verification functions to try.
3271 ;; Allow (minor)-modes calls with no arguments.
3272 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3281 ok))
3289 ok))))))))
3292 "Set local variable VAR with value VAL.
3293 If VAR is `mode', call `VAL-mode' as a function unless it's
3294 already the major mode."
3301 ;; A minor mode must be passed an argument.
3302 ;; Otherwise, if the user enables the minor mode in a
3303 ;; major mode hook, this would toggle it off.
3309 ;; Make sure the string has no text properties.
3310 ;; Some text properties can get evaluated in various ways,
3311 ;; so it is risky to put them on with a local variable list.
3315 \f
3316 ;;; Handling directory-local variables, aka project settings.
3322 "List of cached directory roots for directory-local variable classes.
3323 Each element in this list has the form (DIR CLASS MTIME).
3324 DIR is the name of the directory.
3325 CLASS is the name of a variable class (a symbol).
3326 MTIME is the recorded modification time of the directory-local
3327 variables file associated with this entry. This time is a list
3328 of two integers (the same format as `file-attributes'), and is
3329 used to test whether the cache entry is still valid.
3330 Alternatively, MTIME can be nil, which means the entry is always
3334 "Return the variable list for CLASS."
3338 "Collect directory-local variables from MODE-VARIABLES.
3339 VARIABLES is the initial list of variables.
3340 Returns the new list."
3345 ;; If variables are specified more than once, only use the last. (Why?)
3346 ;; The pseudo-variables mode and eval are different (bug#3430).
3349 ;; Need a new cons in case we setcdr later.
3353 "Collect entries from CLASS-VARIABLES into VARIABLES.
3354 ROOT is the root directory of the project.
3355 Return the new variables list."
3358 ;; FIXME: Why not use file-relative-name?
3365 ;; Don't include this in the previous condition, because we
3366 ;; want to filter all strings before the next condition.
3380 ;; TODO someone might want to extend this to allow
3381 ;; integer values for subdir, where N means
3382 ;; variables apply to this directory and N levels
3383 ;; below it (0 == nil).
3386 alist variables))))))))
3388 ;; The file's content might be invalid (e.g. have a merge conflict), but
3389 ;; that shouldn't prevent the user from opening the file.
3391 nil))))
3394 "Declare that the DIRECTORY root is an instance of CLASS.
3395 DIRECTORY is the name of a directory, a string.
3396 CLASS is the name of a project class, a symbol.
3397 MTIME is either the modification time of the directory-local
3398 variables file that defined this class, or nil.
3400 When a file beneath DIRECTORY is visited, the mode-specific
3401 variables from CLASS are applied to the buffer. The variables
3402 for a class are defined using `dir-locals-set-class-variables'."
3409 "Map the type CLASS to a list of variable settings.
3410 CLASS is the project class, a symbol. VARIABLES is a list
3411 that declares directory-local variables for the class.
3412 An element in VARIABLES is either of the form:
3413 (MAJOR-MODE . ALIST)
3414 or
3415 (DIRECTORY . LIST)
3417 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3418 whose elements are of the form (VARIABLE . VALUE).
3420 In the second form, DIRECTORY is a directory name (a string), and
3421 LIST is a list of the form accepted by the function.
3423 When a file is visited, the file's class is found. A directory
3424 may be assigned a class using `dir-locals-set-directory-class'.
3425 Then variables are set in the file's buffer according to the
3426 class' LIST. The list is processed in order.
3428 * If the element is of the form (MAJOR-MODE . ALIST), and the
3429 buffer's major mode is derived from MAJOR-MODE (as determined
3430 by `derived-mode-p'), then all the variables in ALIST are
3431 applied. A MAJOR-MODE of nil may be used to match any buffer.
3432 `make-local-variable' is called for each variable before it is
3433 set.
3435 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3436 is an initial substring of the file's directory, then LIST is
3437 applied by recursively following these rules."
3444 "File that contains directory-local variables.
3445 It has to be constant to enforce uniform values
3449 "Find the directory-local variables for FILE.
3450 This searches upward in the directory tree from FILE.
3451 It stops at the first directory that has been registered in
3452 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3453 If it finds an entry in the cache, it checks that it is valid.
3454 A cache entry with no modification time element (normally, one that
3455 has been assigned directly using `dir-locals-set-directory-class', not
3456 set from a file) is always valid.
3457 A cache entry based on a `dir-locals-file' is valid if the modification
3458 time stored in the cache matches the current file modification time.
3459 If not, the cache entry is cleared so that the file will be re-read.
3461 This function returns either nil (no directory local variables found),
3462 or the matching entry from `dir-locals-directory-cache' (a list),
3463 or the full path to the `dir-locals-file' (a string) in the case
3464 of no valid cache entry."
3469 dir-locals-file))
3472 ;; `locate-dominating-file' may have abbreviated the name.
3475 ;; Find the best cached value in `dir-locals-directory-cache'.
3487 ;; Found a potential cache entry. Check validity.
3488 ;; A cache entry with no MTIME is assumed to always be valid
3489 ;; (ie, set directly, not from a dir-locals file).
3490 ;; Note, we don't bother to check that there is a matching class
3491 ;; element in dir-locals-class-alist, since that's done by
3492 ;; dir-locals-set-directory-class.
3499 ;; This cache entry is OK.
3500 dir-elt
3501 ;; This cache entry is invalid; clear it.
3504 ;; Return the first existing dir-locals file. Might be the same
3505 ;; as dir-elt's, might not (eg latter might have been deleted).
3506 locals-file)
3507 ;; No cache entry.
3508 locals-file)))
3511 "Load a variables FILE and register a new class and instance.
3512 FILE is the name of the file holding the variables to apply.
3513 The new class name is the same as the directory in which FILE
3514 is found. Returns the new class name."
3524 class-name)))
3527 "Read per-directory local variables for the current buffer.
3528 Store the directory-local variables in `dir-local-variables-alist'
3529 and `file-local-variables-alist', without applying them."
3532 ;; Find the variables file.
3559 \f
3562 However, the mode will not be changed if
3563 \(1) a local variables list or the `-*-' line specifies a major mode, or
3565 \ not suitable for ordinary files, or
3566 \(3) the new file name does not particularly specify any mode."
3571 "Change name of file visited in current buffer to FILENAME.
3572 This also renames the buffer to correspond to the new file.
3573 The next time the buffer is saved it will go in the newly specified file.
3574 FILENAME nil or an empty string means mark buffer as not visiting any file.
3575 Remember to delete the initial contents of the minibuffer
3576 if you wish to pass an empty string as the argument.
3578 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3579 confirmation in the case where another buffer is already visiting FILENAME.
3581 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3582 the old visited file has been renamed to the new name FILENAME."
3590 nil
3605 filename)))
3615 ;; If new-name == old-name, renaming would add a spurious <2>
3616 ;; and it's considered as a feature in rename-buffer.
3622 ;; Abbreviate the file names of the buffer.
3631 nil)))
3632 ;; write-file-functions is normally used for things like ftp-find-file
3633 ;; that visit things that are not local files as if they were files.
3634 ;; Changing to visit an ordinary local file instead should flush the hook.
3639 ;; If buffer was read-only because of version control,
3640 ;; that reason is gone now, so make it writable.
3644 ;; Turn off backup files for certain file names.
3645 ;; Since this is a permanent local, the major mode won't eliminate it.
3647 backup-enable-predicate
3653 ;; If auto-save was not already on, turn it on if appropriate.
3657 ;; If auto save is on, start using a new name.
3658 ;; We deliberately don't rename or delete the old auto save
3659 ;; for the old visited file name. This is because perhaps
3660 ;; the user wants to save the new state and then compare with the
3661 ;; previous state from the auto save file.
3664 ;; Rename the old auto save file if any.
3671 ;; Update the major mode, if the file name determines it.
3673 ;; Don't change the mode if it is special.
3676 ;; Don't change the mode if the local variable list specifies it.
3682 "Write current buffer into file FILENAME.
3683 This makes the buffer visit that file, and marks it as not modified.
3685 If you specify just a directory name as FILENAME, that means to use
3686 the default file name but in that directory. You can also yank
3687 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3689 If the buffer is not already visiting a file, the default file name
3690 for the output file is the buffer name.
3692 If optional second arg CONFIRM is non-nil, this function
3693 asks for confirmation before overwriting an existing file.
3694 Interactively, confirmation is required unless you supply a prefix argument."
3695 ;; (interactive "FWrite file: ")
3699 nil nil nil nil)
3703 default-directory)
3704 nil nil))
3708 ;; If arg is just a directory,
3709 ;; use the default file name, but in that directory.
3720 ;; Make buffer writable if file is writable.
3725 ;; It's likely that the VC status at the new location is different from
3726 ;; the one at the old location.
3728 \f
3730 "Make a backup of the disk file visited by the current buffer, if appropriate.
3731 This is normally done before saving the buffer the first time.
3733 A backup may be done by renaming or by copying; see documentation of
3734 variable `make-backup-files'. If it's done by renaming, then the file is
3735 no longer accessible under its old name.
3737 The value is non-nil after a backup was made by renaming.
3738 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3739 MODES is the result of `file-modes' on the original
3740 file; this means that the caller, after saving the buffer, should change
3741 the modes of the new file to agree with the old modes.
3742 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3743 file; this means that the caller, after saving the buffer, should change
3744 the SELinux context of the new file to agree with the old context.
3745 BACKUPNAME is the backup file name, which is the old file renamed."
3752 backup-info backupname targets setmodes)
3753 ;; If specified name is a symbolic link, chase it to the target.
3754 ;; Thus we make the backups in the directory where the real file is.
3759 ;; (if (file-directory-p buffer-file-name)
3760 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3764 ;; If have old versions to maybe delete,
3765 ;; ask the user to confirm now, before doing anything.
3766 ;; But don't actually delete til later.
3771 real-file-name)))))
3774 ;; Actually write the back up file.
3777 ; (file-symlink-p buffer-file-name)
3778 backup-by-copying
3779 ;; Don't rename a suid or sgid file.
3794 ;; rename-file should delete old backup.
3798 ;; If trouble writing the backup, write it in
3799 ;; .emacs.d/%backup%.
3802 backupname)
3806 ;; Now delete the old versions, if desired.
3813 setmodes)
3820 ;; Create temp files with strict access rights. It's easy to
3821 ;; loosen them later, whereas it's impossible to close the
3822 ;; time-window of loose permissions otherwise.
3825 ;; Try to overwrite old backup first.
3833 nil)
3835 ;; The file was somehow created by someone else between
3836 ;; `delete-file' and `copy-file', so let's try again.
3837 ;; rms says "I think there is also a possible race
3838 ;; condition for making backup files" (emacs-devel 20070821).
3839 nil)))
3840 ;; Reset the umask.
3849 ;; The last ~[[:digit]]+ matches relative versions in git,
3850 ;; e.g. `foo.js.~HEAD~1~'.
3851 "Regular expression matching the backup/version part of a file name.
3855 "Return file NAME sans backup versions or strings.
3856 This is a separate procedure so your site-init or startup file can
3857 redefine it.
3858 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3859 we do not remove backup version numbers, only true file version numbers.
3860 See also `file-name-version-regexp'."
3867 name))))))
3870 "Return t if deleting FILE and rewriting it would preserve the owner."
3875 ;; Return t if the file doesn't exist, since it's true that no
3876 ;; information would be lost by an (attempted) delete and create.
3879 ;; Files created on Windows by Administrator (RID=500)
3880 ;; have the Administrators group (RID=544) recorded as
3881 ;; their owner. Rewriting them will still preserve the
3882 ;; owner.
3888 The extension, in a file name, is the part that follows the last `.',
3889 except that a leading `.', if any, doesn't count."
3892 directory)
3896 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3897 ;; we don't want to expand it.
3900 filename))))
3904 The extension, in a file name, is the part that follows the last `.',
3905 excluding version numbers and backup suffixes,
3906 except that a leading `.', if any, doesn't count.
3907 Return nil for extensionless file names such as `foo'.
3908 Return the empty string for file names such as `foo.'.
3910 If PERIOD is non-nil, then the returned value includes the period
3911 that delimits the extension, and if FILENAME has no extension,
3922 "A function to use instead of the default `make-backup-file-name'.
3923 A value of nil gives the default `make-backup-file-name' behavior.
3925 This could be buffer-local to do something special for specific
3926 files. If you define it, you may need to change `backup-file-name-p'
3927 and `file-name-sans-versions' too.
3929 See also `backup-directory-alist'."
3935 "Alist of filename patterns and backup directory names.
3936 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3937 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3938 relative or absolute. If it is absolute, so that all matching files
3939 are backed up into the same directory, the file names in this
3940 directory will be the full name of the file backed up with all
3941 directory separators changed to `!' to prevent clashes. This will not
3942 work correctly if your filesystem truncates the resulting name.
3944 For the common case of all backups going into one directory, the alist
3946 directory name.
3948 If this variable is nil, or it fails to match a filename, the backup
3949 is made in the original file's directory.
3951 On MS-DOS filesystems without long names this variable is always
3952 ignored."
3958 "Default `backup-enable-predicate' function.
3959 Checks for files in `temporary-file-directory',
3960 `small-temporary-file-directory', and /tmp."
3963 ;; Directory is under temporary-file-directory.
3968 ;; Directory is under /tmp.
3973 0 nil
3975 ;; Directory is under small-temporary-file-directory.
3980 "Create the non-numeric backup file name for FILE.
3981 Normally this will just be the file's name with `~' appended.
3982 Customization hooks are provided as follows.
3984 If the variable `make-backup-file-name-function' is non-nil, its value
3985 should be a function which will be called with FILE as its argument;
3986 the resulting name is used.
3988 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3989 the documentation of that variable. If the directory for the backup
3990 doesn't exist, it is created."
4004 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
4006 elt backup-directory abs-backup-directory)
4011 alist nil)))
4012 ;; If backup-directory is relative, it should be relative to the
4013 ;; file's directory. By expanding explicitly here, we avoid
4014 ;; depending on default-directory.
4023 abs-backup-directory nil))))
4025 file
4029 ;; Normalize DOSish file names: downcase the drive
4030 ;; letter, if any, and replace the leading "x:" with
4031 ;; "/drive_x".
4034 ;; Replace any invalid file-name characters (for the
4035 ;; case of backing up remote files).
4039 "drive_"
4042 ""
4045 ;; Make the name unique by substituting directory
4046 ;; separators. It may not really be worth bothering about
4047 ;; doubling `!'s in the original name...
4052 backup-directory))
4057 "Return non-nil if FILE is a backup file name (numeric or not).
4058 This is a separate function so you can redefine it for customization.
4059 You may need to redefine `file-name-sans-versions' as well."
4064 ;; This is used in various files.
4065 ;; The usage of backup-extract-version-start is not very clean,
4066 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4068 "Given the name of a numeric backup file, FN, return the backup number.
4069 Uses the free variable `backup-extract-version-start', whose value should be
4070 the index in the name where the version number begins."
4077 "Find a file name for a backup file FN, and suggestions for deletions.
4078 Value is a list whose car is the name for the backup file
4079 and whose cdr is a list of old versions to consider deleting now.
4080 If the value is nil, don't make a backup.
4081 Uses `backup-directory-alist' in the same way as does
4082 `make-backup-file-name'."
4084 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4088 ;; We don't support numbered backups on plain MS-DOS
4089 ;; when long file names are unavailable.
4099 possibilities deserve-versions-p versions)
4102 base-versions
4105 possibilities)
4106 #'<)
4111 kept-old-versions
4112 kept-new-versions
4119 ;; Delete nothing if there is overflow
4120 ;; in the number of versions to keep.
4126 v))))))))))
4129 "Return number of names file FILENAME has."
4132 ;; (defun file-relative-name (filename &optional directory)
4133 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4134 ;; This function returns a relative file name which is equivalent to FILENAME
4135 ;; when used with that default directory as the default.
4136 ;; If this is impossible (which can happen on MSDOS and Windows
4137 ;; when the file name and directory use different drive names)
4138 ;; then it returns FILENAME."
4139 ;; (save-match-data
4140 ;; (let ((fname (expand-file-name filename)))
4141 ;; (setq directory (file-name-as-directory
4142 ;; (expand-file-name (or directory default-directory))))
4143 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4144 ;; ;; drive names, they can't be relative, so return the absolute name.
4145 ;; (if (and (or (eq system-type 'ms-dos)
4146 ;; (eq system-type 'cygwin)
4147 ;; (eq system-type 'windows-nt))
4148 ;; (not (string-equal (substring fname 0 2)
4149 ;; (substring directory 0 2))))
4150 ;; filename
4151 ;; (let ((ancestor ".")
4152 ;; (fname-dir (file-name-as-directory fname)))
4153 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4154 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4155 ;; (setq directory (file-name-directory (substring directory 0 -1))
4156 ;; ancestor (if (equal ancestor ".")
4157 ;; ".."
4158 ;; (concat "../" ancestor))))
4159 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4160 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4161 ;; ;; We matched within FNAME's directory part.
4162 ;; ;; Add the rest of FNAME onto ANCESTOR.
4163 ;; (let ((rest (substring fname (match-end 0))))
4164 ;; (if (and (equal ancestor ".")
4165 ;; (not (equal rest "")))
4166 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4167 ;; rest
4168 ;; (concat (file-name-as-directory ancestor) rest)))
4169 ;; ;; We matched FNAME's directory equivalent.
4170 ;; ancestor))))))
4173 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4174 This function returns a relative file name which is equivalent to FILENAME
4175 when used with that default directory as the default.
4176 If FILENAME and DIRECTORY lie on different machines or on different drives
4177 on a DOS/Windows machine, it returns FILENAME in expanded form."
4181 default-directory))))
4187 ;; Test for different filesystems on DOS/Windows
4189 ;; Should `cygwin' really be included here? --stef
4192 ;; Test for different drive letters
4194 ;; Test for UNCs on different servers
4199 ;; Windows file names cannot have ? in
4200 ;; them, so use that to detect when
4201 ;; neither FILENAME nor DIRECTORY is a
4202 ;; UNC.
4204 0 nil
4210 ;; Test for different remote file system identification
4212 filename
4218 directory nil nil case-fold-search))
4220 directory nil nil case-fold-search))))
4223 ".."
4225 ;; Now ancestor is empty, or .., or ../.., etc.
4227 directory nil nil case-fold-search))
4228 ;; We matched within FILENAME's directory part.
4229 ;; Add the rest of FILENAME onto ANCESTOR.
4232 ;; But don't bother with ANCESTOR if it would give us `./'.
4233 rest
4235 ;; We matched FILENAME's directory equivalent.
4236 ancestor))))))
4237 \f
4239 "Save current buffer in visited file if modified.
4240 Variations are described below.
4242 By default, makes the previous version into a backup file
4243 if previously requested or if this is the first save.
4245 to become a backup when the next save is done.
4247 unconditionally makes the previous version into a backup file.
4249 to become a backup when the next save is done,
4250 and unconditionally makes the previous version into a backup file.
4252 With a numeric argument of 0, never make the previous version
4253 into a backup file.
4255 If a file's name is FOO, the names of its numbered backup versions are
4256 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4257 Numeric backups (rather than FOO~) will be made if value of
4258 `version-control' is not the atom `never' and either there are already
4259 numeric versions of the file being backed up, or `version-control' is
4260 non-nil.
4261 We don't want excessive versions piling up, so there are variables
4262 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4263 and `kept-new-versions', which tells how many newest versions to keep.
4264 Defaults are 2 old versions and 2 new.
4265 `dired-kept-versions' controls dired's clean-directory (.) command.
4266 If `delete-old-versions' is nil, system will query user
4267 before trimming versions. Otherwise it does it silently.
4269 If `vc-make-backup-files' is nil, which is the default,
4270 no backup files are made for files managed by version control.
4271 (This is because the version control system itself records previous versions.)
4273 See the subroutine `basic-save-buffer' for more information."
4279 ;; We used to display the message below only for files > 50KB, but
4280 ;; then Rmail-mbox never displays it due to buffer swapping. If
4281 ;; the test is ever re-introduced, be sure to handle saving of
4282 ;; Rmail files.
4289 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4290 Normally delete only if the file was written by this Emacs since
4291 the last real save, but optional arg FORCE non-nil means delete anyway."
4305 "Normal hook that is run before a buffer is saved to its file."
4311 "Normal hook that is run after a buffer is saved to its file."
4317 "If non-nil, use this coding system for saving the buffer.
4318 More precisely, use this coding system in place of the
4319 value of `buffer-file-coding-system', when saving the buffer.
4320 Calling `write-region' for any purpose other than saving the buffer
4321 will still use `buffer-file-coding-system'; this variable has no effect
4328 "Save the current buffer in its visited file, if it has been modified.
4329 The hooks `write-contents-functions' and `write-file-functions' get a chance
4330 to do the job of saving; if they do not, then the buffer is saved in
4331 the visited file in the usual way.
4332 Before and after saving the buffer, this function runs
4333 `before-save-hook' and `after-save-hook', respectively."
4336 ;; In an indirect buffer, save its base buffer instead.
4340 ;; handle the case when no modification has been made but
4341 ;; the file disappeared since visited
4345 setmodes)
4346 ;; If buffer has no file name, ask user for one.
4353 ;; Signal an error if the user specified the name of an
4354 ;; existing directory.
4357 filename))
4359 ;; Signal an error if the specified name refers to a
4360 ;; non-existing directory.
4371 "%s has changed since visited or saved. Save anyway? "
4391 ;; Support VC version backups.
4397 ;; If a hook returned t, file is already "written".
4398 ;; Otherwise, write it the usual way now.
4400 ;; Now we have saved the current buffer. Let's make sure
4401 ;; that buffer-file-coding-system is fixed to what
4402 ;; actually used for saving by binding it locally.
4414 ;; If the auto-save file was recent before this command,
4415 ;; delete it now.
4417 ;; Support VC `implicit' locking.
4422 ;; This does the "real job" of writing a buffer into its visited file
4423 ;; and making a backup file. This is what is normally done
4424 ;; but inhibited if one of write-file-functions returns non-nil.
4425 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4437 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4450 "File %s is write-protected; try to save anyway? "
4452 buffer-file-name)))
4467 ;; Write temp name, then rename it.
4468 ;; This requires write access to the containing dir,
4469 ;; which is why we don't try it if we don't have that access.
4471 tempname succeed
4474 ;; Create temp files with strict access rights. It's easy to
4475 ;; loosen them later, whereas it's impossible to close the
4476 ;; time-window of loose permissions otherwise.
4481 ;; Try various temporary names.
4482 ;; This code follows the example of make-temp-file,
4483 ;; but it calls write-region in the appropriate way
4484 ;; for saving the buffer.
4490 ;; Pass in nil&nil rather than point-min&max
4491 ;; cause we're saving the whole buffer.
4492 ;; write-region-annotate-functions may use it.
4494 tempname nil realname
4496 nil)
4498 ;; The file was somehow created by someone else between
4499 ;; `make-temp-name' and `write-region', let's try again.
4500 nil)
4502 ;; Reset the umask.
4504 ;; If we failed, restore the buffer's modtime.
4507 ;; Since we have created an entirely new file,
4508 ;; make sure it gets the right permission bits set.
4513 buffer-file-name)))
4514 ;; We succeeded in writing the temp file,
4515 ;; so rename it.
4517 ;; If file not writable, see if we can make it writable
4518 ;; temporarily while we write it.
4519 ;; But no need to do so if we have just backed it up
4520 ;; (setmodes is set) because that says we're superseding.
4522 ;; Change the mode back, after writing.
4525 buffer-file-name))
4531 ;; Pass in nil&nil rather than point-min&max to indicate
4532 ;; we're saving the buffer rather than just a region.
4533 ;; write-region-annotate-functions may make us of it.
4535 buffer-file-name nil t buffer-file-truename)
4537 ;; If we get an error writing the new file, and we made
4538 ;; the backup by renaming, undo the backing-up.
4543 setmodes))
4549 `((?\C-r
4556 ;; Return nil to ask about BUF again.
4557 nil)
4570 ;; Return nil to ask about BUF again.
4571 nil)
4581 "Save some modified file-visiting buffers. Asks user about each one.
4582 You can answer `y' to save, `n' not to save, `C-r' to look at the
4583 buffer in question with `view-buffer' before deciding or `d' to
4584 view the differences using `diff-buffer-with-file'.
4586 This command first saves any buffers where `buffer-save-without-query' is
4587 non-nil, without asking.
4589 Optional argument (the prefix) non-nil means save all with no questions.
4590 Optional second argument PRED determines which buffers are considered:
4591 If PRED is nil, all the file-visiting buffers are considered.
4592 If PRED is t, then certain non-file buffers will also be considered.
4593 If PRED is a zero-argument function, it indicates for each buffer whether
4594 to consider it or not when called with that buffer current.
4596 See `save-some-buffers-action-alist' if you want to
4597 change the additional actions you can take on files."
4601 files-done abbrevs-done)
4603 ;; First save any buffers that we're supposed to save unconditionally.
4604 ;; That way the following code won't ask about them.
4609 ;; Ask about those buffers that merit it,
4610 ;; and record the number thus saved.
4614 ;; Note that killing some buffers may kill others via
4615 ;; hooks (e.g. Rmail and its viewing buffer).
4628 t
4640 save-some-buffers-action-alist))
4641 ;; Maybe to save abbrevs, and record whether
4642 ;; we either saved them or asked to.
4649 ;; Don't keep bothering user if he says no.
4662 \f
4664 "Mark current buffer as unmodified, not needing to be saved.
4667 It is not a good idea to use this function in Lisp programs, because it
4668 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4675 "Change whether this buffer is read-only.
4676 With prefix argument ARG, make the buffer read-only if ARG is
4677 positive, otherwise make it writable. If buffer is read-only
4678 and `view-read-only' is non-nil, enter view mode."
4683 nil ; do nothing.
4684 ;; Toggle.
4691 ;; If view-mode is already active, `view-mode-enter' is a nop.
4703 "Insert contents of file FILENAME into buffer after point.
4704 Set mark after the inserted text.
4706 This function is meant for the user to run interactively.
4707 Don't call it from programs! Use `insert-file-contents' instead.
4708 \(Its calling sequence is different; see its documentation)."
4713 "Append the contents of the region to the end of file FILENAME.
4714 When called from a function, expects three arguments,
4715 START, END and FILENAME. START and END are normally buffer positions
4716 specifying the part of the buffer to write.
4717 If START is nil, that means to use the entire buffer contents.
4718 If START is a string, then output that string to the file
4719 instead of any buffer contents; END is ignored.
4721 This does character code conversion and applies annotations
4722 like `write-region' does."
4727 "Return most recent backup file for FILENAME or nil if no backups exist."
4728 ;; `make-backup-file-name' will get us the right directory for
4729 ;; ordinary or numeric backups. It might create a directory for
4730 ;; backups as a side-effect, according to `backup-directory-alist'.
4737 tem)
4746 newest))
4749 "Rename current buffer to a similar name not already taken.
4750 This function is useful for creating multiple shell process buffers
4751 or multiple mail buffers, etc."
4759 ;; If the existing buffer name has a <NNN>,
4760 ;; which isn't part of the file name (if any),
4761 ;; then get rid of that.
4767 "Create the directory DIR and optionally any nonexistent parent dirs.
4768 If DIR already exists as a directory, signal an error, unless
4769 PARENTS is non-nil.
4771 Interactively, the default choice of directory to create is the
4772 current buffer's default directory. That is useful when you have
4773 visited a file in a nonexistent directory.
4775 Noninteractively, the second (optional) argument PARENTS, if
4776 non-nil, says whether to create parent directories that don't
4777 exist. Interactively, this happens by default."
4780 nil nil)
4781 t))
4782 ;; If default-directory is a remote directory,
4783 ;; make sure we find its make-directory handler.
4791 create-list)
4793 ;; If directory is its own parent, then we can't
4794 ;; keep looping forever
4809 "Delete the directory named DIRECTORY. Does not follow symlinks.
4810 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4811 TRASH non-nil means to trash the directory instead, provided
4812 `delete-by-moving-to-trash' is non-nil.
4814 When called interactively, TRASH is t if no prefix argument is
4815 given. With a prefix argument, TRASH is nil."
4822 "Move directory to trash: "
4824 default-directory default-directory nil nil))))
4830 nil)
4832 ;; If default-directory is a remote directory, make sure we find its
4833 ;; delete-directory handler.
4840 ;; Only move non-empty dir to trash if recursive deletion was
4841 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4842 ;; case, where the operation fails in delete-directory-internal.
4843 ;; As `move-file-to-trash' trashes directories (empty or
4844 ;; otherwise) as a unit, we do not need to recurse here.
4846 ;; Check if directory is empty apart from "." and "..".
4851 ;; Otherwise, call outselves recursively if needed.
4855 ;; This test is equivalent to
4856 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4857 ;; but more efficient
4861 ;; We do not want to delete "." and "..".
4867 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4868 This function always sets the file modes of the output files to match
4869 the corresponding input file.
4871 The third arg KEEP-TIME non-nil means give the output files the same
4872 last-modified time as the old ones. (This works on only some systems.)
4874 A prefix arg makes KEEP-TIME non-nil.
4876 Noninteractively, the last argument PARENTS says whether to
4877 create parent directories if they don't exist. Interactively,
4878 this happens by default.
4880 If NEWNAME names an existing directory, copy DIRECTORY as a
4881 subdirectory there. However, if called from Lisp with a non-nil
4882 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
4883 directly into NEWNAME instead."
4890 default-directory default-directory nil nil)
4891 current-prefix-arg t nil)))
4892 ;; If default-directory is a remote directory, make sure we find its
4893 ;; copy-directory handler.
4899 ;; Compute target name.
4904 ;; If NEWNAME is not an existing directory, create it;
4905 ;; that is where we will copy the files of DIRECTORY.
4907 ;; If NEWNAME is an existing directory and COPY-CONTENTS
4908 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
4913 newname))
4917 newname))
4920 ;; Copy recursively.
4922 ;; We do not want to copy "." and "..".
4924 directory-files-no-dot-files-regexp))
4933 ;; Set directory attributes.
4937 \f
4940 "Function to use to revert this buffer, or nil to do the default.
4941 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4946 "Function to use to insert contents when reverting this buffer.
4947 Gets two args, first the nominal file name to use,
4948 and second, t if reading the auto-save file.
4953 "Function to check whether a non-file buffer needs reverting.
4954 This should be a function with one optional argument NOCONFIRM.
4955 Auto Revert Mode passes t for NOCONFIRM. The function should return
4956 non-nil if the buffer should be reverted. A return value of
4957 `fast' means that the need for reverting was not checked, but
4958 that reverting the buffer is fast. The buffer is current when
4959 this function is called.
4961 The idea behind the NOCONFIRM argument is that it should be
4962 non-nil if the buffer is going to be reverted without asking the
4963 user. In such situations, one has to be careful with potentially
4964 time consuming operations.
4966 For more information on how this variable is used by Auto Revert mode,
4970 "Normal hook for `revert-buffer' to run before reverting.
4971 If `revert-buffer-function' is used to override the normal revert
4975 "Normal hook for `revert-buffer' to run after reverting.
4976 Note that the hook value that it runs is the value that was in effect
4977 before reverting; that makes a difference if you have buffer-local
4978 hook functions.
4980 If `revert-buffer-function' is used to override the normal revert
4984 "Non-nil if a `revert-buffer' operation is in progress, nil otherwise.
4990 "Replace current buffer text with the text of the visited file on disk.
4991 This undoes all changes since the file was visited or saved.
4992 With a prefix argument, offer to revert from latest auto-save file, if
4993 that is more recent than the visited file.
4995 This command also implements an interface for special buffers
4996 that contain text which doesn't come from a file, but reflects
4997 some other data instead (e.g. Dired buffers, `buffer-list'
4998 buffers). This is done via the variable `revert-buffer-function'.
4999 In these cases, it should reconstruct the buffer contents from the
5000 appropriate data.
5002 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5003 to revert from the auto-save file when this is nil. Note that the
5004 sense of this argument is the reverse of the prefix argument, for the
5005 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5006 to nil.
5008 Optional second argument NOCONFIRM means don't ask for confirmation
5009 at all. (The variable `revert-without-query' offers another way to
5010 revert buffers without querying for confirmation.)
5012 Optional third argument PRESERVE-MODES non-nil means don't alter
5013 the files modes. Normally we reinitialize them using `normal-mode'.
5015 If the value of `revert-buffer-function' is non-nil, it is called to
5016 do all the work for this command. Otherwise, the hooks
5017 `before-revert-hook' and `after-revert-hook' are run at the beginning
5018 and the end, and if `revert-buffer-insert-file-contents-function' is
5019 non-nil, it is called instead of rereading visited file contents."
5021 ;; I admit it's odd to reverse the sense of the prefix argument, but
5022 ;; there is a lot of code out there which assumes that the first
5023 ;; argument should be t to avoid consulting the auto-save file, and
5024 ;; there's no straightforward way to encourage authors to notice a
5025 ;; reversal of the argument sense. So I'm just changing the user
5026 ;; interface, but leaving the programmatic interface the same.
5036 buffer-auto-save-file-name
5041 buffer-auto-save-file-name
5042 buffer-file-name)))
5052 file-name)))
5054 ;; If file was backed up but has changed since,
5055 ;; we should make another backup.
5059 ;; Effectively copy the after-revert-hook status,
5060 ;; since after-find-file will clobber it.
5063 after-revert-hook))
5068 ;; Get rid of all undo records for this buffer.
5070 ;; Don't make undo records for the reversion.
5073 file-name auto-save-p)))
5076 "File %s no longer exists!"
5078 file-name))
5081 "File %s no longer readable!"
5083 file-name))
5085 ;; Bind buffer-file-name to nil
5086 ;; so that we don't try to lock the file.
5092 ;; Auto-saved file should be read by Emacs'
5093 ;; internal coding.
5097 buffer-file-coding-system-explicit
5100 coding-system-for-read
5102 coding-system-for-read)
5104 ;; As a coding system suitable for multibyte
5105 ;; buffer is specified, make the current
5106 ;; buffer multibyte.
5109 ;; This force after-insert-file-set-coding
5110 ;; (called from insert-file-contents) to set
5111 ;; buffer-file-coding-system to a proper value.
5114 ;; Note that this preserves point in an intelligent way.
5118 nil nil t))
5120 nil nil t)))))
5121 ;; Recompute the truename in case changes in symlinks
5122 ;; have changed the truename.
5126 ;; Run after-revert-hook as it was before we reverted.
5130 local-hook)
5133 t))))))
5136 "Recover the visited file--get contents from its last auto-save file."
5141 "Visit file FILE, but get contents from its last auto-save file."
5142 ;; Actually putting the file name in the minibuffer should be used
5143 ;; only rarely.
5144 ;; Not just because users often use the default.
5164 ;; Use insert-directory-safely, not insert-directory,
5165 ;; because these files might not exist. In particular,
5166 ;; FILE might not exist if the auto-save file was for
5167 ;; a buffer that didn't visit a file, such as "*mail*".
5168 ;; The code in v20.x called `ls' directly, so we need
5169 ;; to emulate what `ls' did in that case.
5175 ;; Keep the current buffer-file-coding-system.
5177 ;; Auto-saved file should be read with special coding.
5186 "Recover auto save files from a previous Emacs session.
5187 This command first displays a Dired buffer showing you the
5188 previous sessions that you could recover from.
5189 To choose one, move point to the proper line and then type C-c C-c.
5190 Then you'll be asked about a number of files to recover."
5200 auto-save-list-file-prefix)))
5201 t)
5210 ;; Each line starts with a space
5211 ;; so that Font Lock mode won't highlight the first character.
5220 "Choose one saved session to recover auto-save files from.
5221 This command is used in the special Dired buffer created by
5224 ;; Get the name of the session file to recover from.
5226 files
5232 ;; Read in the auto-save-list file.
5235 ;; Loop thru the text of that file
5236 ;; and get out the names of the files to recover.
5240 ;; This is a pair of lines for a non-file-visiting buffer.
5241 ;; Get the auto-save file name and manufacture
5242 ;; a "visited file name" from that.
5245 ;; If there is no auto-save file name, the
5246 ;; auto-save-list file is probably corrupted.
5259 ;; This pair of lines is a file-visiting
5260 ;; buffer. Use the visited file name.
5270 ;; Ignore a file if its auto-save file does not exist now.
5274 ;; The file contains a pair of line for each auto-saved buffer.
5275 ;; The first line of the pair contains the visited file name
5276 ;; or is empty if the buffer was not visiting a file.
5277 ;; The second line is the auto-save file name.
5285 files
5291 "Kill BUFFER if confirmed."
5299 "Kill some buffers. Asks the user whether to kill each one of them.
5300 Non-interactively, if optional argument LIST is non-nil, it
5301 specifies the list of buffers to kill, asking for approval for each one."
5309 ; if we killed the base buffer.
5316 "Kill buffers whose name matches the specified REGEXP.
5317 The optional second argument indicates whether to kill internal buffers too."
5326 \f
5328 "Adjust current buffer's auto save file name for current conditions.
5329 Also rename any existing auto save file, if it was made in this session."
5341 "Return file name to use for auto-saves of current buffer.
5342 Does not consider `auto-save-visited-file-name' as that variable is checked
5343 before calling this function. You can redefine this for customization.
5344 See also `auto-save-file-name-p'."
5352 result uniq)
5353 ;; Apply user-specified translations
5354 ;; to the file name.
5358 filename)
5368 filename))))
5373 ;; We truncate the file name to DOS 8+3 limits
5374 ;; before doing anything else, because the regexp
5375 ;; passed to string-match below cannot handle
5376 ;; extensions longer than 3 characters, multiple
5377 ;; dots, and other atrocities.
5382 fn)
5387 "#"
5390 ;; Make sure auto-save file names don't contain characters
5391 ;; invalid for the underlying filesystem.
5393 ;; Don't modify remote (ange-ftp) filenames
5396 result))))
5398 ;; Deal with buffers that don't have any associated files. (Mail
5399 ;; mode tends to create a good number of these.)
5403 file-name)
5404 ;; Restrict the characters used in the file name to those which
5405 ;; are known to be safe on all filesystems, url-encoding the
5406 ;; rest.
5407 ;; We do this on all platforms, because even if we are not
5408 ;; running on DOS/Windows, the current directory may be on a
5409 ;; mounted VFAT filesystem, such as a USB memory stick.
5413 ;; For multibyte characters, this will produce more than
5414 ;; 2 hex digits, so is not true URL encoding.
5418 ;; Generate the file name.
5424 ;; Try a few alternative directories, to get one we can
5425 ;; write it.
5431 ;; Don't modify remote (ange-ftp) filenames
5433 ;; The call to convert-standard-filename is in case
5434 ;; buffer-name includes characters not allowed by the
5435 ;; DOS/Windows filesystems. make-temp-file writes to the
5436 ;; file it creates, so we must fix the file name _before_
5437 ;; make-temp-file is called.
5439 fname))
5441 ;; make-temp-file creates the file,
5442 ;; but we don't want it to exist until we do an auto-save.
5446 file-name)))
5449 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5450 FILENAME should lack slashes. You can redefine this for customization."
5452 \f
5454 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5455 The generated regexp will match a filename only if the filename
5456 matches that wildcard according to shell rules. Only wildcards known
5457 by `sh' are supported."
5459 ;; Copy the initial run of non-special characters.
5462 ;; If no special characters, we're almost done.
5466 j)
5468 result
5489 ;; Found "[^". Insert a `\0' character
5490 ;; (which cannot happen in a filename)
5491 ;; into the character class, so that `^'
5492 ;; is not the first character after `[',
5493 ;; and thus non-special in a regexp.
5498 ;; I don't think `]' can appear in a
5499 ;; character class in a wildcard, but
5500 ;; let's be general here.
5507 i
5520 ;; Shell wildcards should match the entire filename,
5521 ;; not its part. Make the regexp say so.
5523 \f
5526 "Switches for `list-directory' to pass to `ls' for brief listing."
5532 "Switches for `list-directory' to pass to `ls' for verbose listing."
5537 "Expand wildcard pattern PATTERN.
5538 This returns a list of file names which match the pattern.
5540 If PATTERN is written as an absolute file name,
5541 the values are absolute also.
5543 If PATTERN is written as a relative file name, it is interpreted
5544 relative to the current default directory, `default-directory'.
5545 The file names returned are normally also relative to the current
5546 default directory. However, if FULL is non-nil, they are absolute."
5550 ;; A list of all dirs that DIRPART specifies.
5551 ;; This can be more than one dir
5552 ;; if DIRPART contains wildcards.
5556 dirpart)))
5560 contents)
5566 ;; Filter out "." and ".."
5571 name))
5578 this-dir-contents)
5579 this-dir-contents)
5580 contents))))
5582 contents)))
5584 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5588 "Display a list of files in or matching DIRNAME, a la `ls'.
5589 DIRNAME is globbed by the shell if necessary.
5590 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5591 Actions controlled by variables `list-directory-brief-switches'
5592 and `list-directory-verbose-switches'."
5596 nil default-directory nil)
5597 pfx)))
5599 list-directory-brief-switches))
5600 buffer)
5612 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5620 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5622 PATTERN is assumed to represent a file-name wildcard suitable for the
5623 underlying filesystem. For Unix and GNU/Linux, each character from the
5625 the parts of the pattern which don't include wildcard characters are
5626 quoted with double quotes.
5629 on Windows), so PATTERN can use them to quote wildcard characters that
5630 need to be passed verbatim to shell commands."
5634 ;; DOS/Windows don't allow `"' in file names. So if the
5635 ;; argument has quotes, we can safely assume it is already
5636 ;; quoted by the caller.
5638 ;; We quote [&()#$'] in case their shell is a port of a
5639 ;; Unixy shell. We quote [,=+] because stock DOS and
5640 ;; Windows shells require that in some cases, such as
5641 ;; passing arguments to batch files that use positional
5642 ;; arguments like %1.
5644 pattern
5647 end)
5664 pattern))))
5671 "Program to get the amount of free space on a file system.
5672 We assume the output has the format of `df'.
5673 The value of this variable must be just a command name or file name;
5674 if you want to specify options, use `directory-free-space-args'.
5676 A value of nil disables this feature.
5678 If the function `file-system-info' is defined, it is always used in
5679 preference to the program given by this variable."
5685 "Options to use when running `directory-free-space-program'."
5690 "Return the amount of free space on directory DIR's file system.
5691 The return value is a string describing the amount of free
5692 space (normally, the number of free 1KB blocks).
5694 This function calls `file-system-info' if it is available, or
5695 invokes the program specified by `directory-free-space-program'
5696 and `directory-free-space-args'. If the system call or program
5697 is unsuccessful, or if DIR is a remote directory, this function
5698 returns nil."
5700 ;; Try to find the number of free blocks. Non-Posix systems don't
5701 ;; always have df, but might have an equivalent system call.
5710 ;; Avoid failure if the default directory does
5711 ;; not exist (Bug#2631, Bug#3911).
5714 nil t nil
5715 directory-free-space-args
5716 dir)
5718 ;; Assume that the "available" column is before the
5719 ;; "capacity" column. Find the "%" and scan backward.
5723 "[[:space:]]+[^[:space:]]+%[^%]*$"
5730 ;; The following expression replaces `dired-move-to-filename-regexp'.
5734 ;; In some locales, month abbreviations are as short as 2 letters,
5735 ;; and they can be followed by ".".
5736 ;; In Breton, a month name can include a quote character.
5749 s "+"
5752 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5753 ;; omits the Kanji characters after month and day-of-month.
5754 ;; On Mac OS X 10.3, the date format in East Asian locales is
5755 ;; day-of-month digits followed by month digits.
5761 ;; The "[0-9]" below requires the previous column to end in a digit.
5762 ;; This avoids recognizing `1 may 1997' as a date in the line:
5763 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5765 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5767 ;; For non-iso date formats, we add the ".*" in order to find
5768 ;; the last possible match. This avoids recognizing
5769 ;; `jservice 10 1024' as a date in the line:
5770 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5772 ;; vc dired listings provide the state or blanks between file
5773 ;; permissions and date. The state is always surrounded by
5774 ;; parantheses:
5775 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5776 ;; This is not supported yet.
5781 "Regular expression to match up to the file name in a directory listing.
5782 The default value is designed to recognize dates and times
5787 ;; insert-directory
5788 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5789 ;; FULL-DIRECTORY-P is nil.
5790 ;; The single line of output must display FILE's name as it was
5791 ;; given, namely, an absolute path name.
5792 ;; - must insert exactly one line for each file if WILDCARD or
5793 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5794 ;; before the file lines, plus optional text after the file lines.
5795 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5796 ;; allowed.
5797 ;; File lines should display the basename.
5798 ;; - must be consistent with
5799 ;; - functions dired-move-to-filename, (these two define what a file line is)
5800 ;; dired-move-to-end-of-filename,
5801 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5802 ;; dired-insert-headerline
5803 ;; dired-after-subdir-garbage (defines what a "total" line is)
5804 ;; - variable dired-subdir-regexp
5805 ;; - may be passed "--dired" as the first argument in SWITCHES.
5806 ;; Filename handlers might have to remove this switch if their
5807 ;; "ls" command does not support it.
5809 "Insert directory listing for FILE, formatted according to SWITCHES.
5810 Leaves point after the inserted text.
5811 SWITCHES may be a string of options, or a list of strings
5812 representing individual options.
5813 Optional third arg WILDCARD means treat FILE as shell wildcard.
5814 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5815 switches do not contain `d', so that a full listing is expected.
5817 This works by running a directory listing program
5818 whose name is in the variable `insert-directory-program'.
5819 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5821 When SWITCHES contains the long `--dired' option, this function
5822 treats it specially, for the sake of dired. However, the
5823 normally equivalent short `-D' option is just passed on to
5824 `insert-directory-program', as any other option."
5825 ;; We need the directory in order to find the right handler.
5830 wildcard full-directory-p)
5833 ;; Read the actual directory using `insert-directory-program'.
5834 ;; RESULT gets the status code.
5836 ;; putting text property `dired-filename, decode one
5837 ;; bunch by one to preserve that property.
5839 ;; This is to control encoding the arguments in call-process.
5843 default-file-name-coding-system))))
5846 ;; Run ls in the directory part of the file pattern
5847 ;; using the last component as argument.
5853 ;; NB since switches is passed to the shell, be
5854 ;; careful of malicious values, eg "-l;reboot".
5855 ;; See eg dired-safe-switches-p.
5857 shell-file-name nil t nil
5858 "-c"
5860 ""
5862 insert-directory-program
5863 " -d "
5865 switches
5867 " -- "
5868 ;; Quote some characters that have
5869 ;; special meanings in shells; but
5870 ;; don't quote the wildcards--we want
5871 ;; them to be special. We also
5872 ;; currently don't quote the quoting
5873 ;; characters in case people want to
5874 ;; use them explicitly to quote
5875 ;; wildcard characters.
5877 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5878 ;; directory if FILE is a symbolic link.
5885 insert-directory-program nil t nil
5889 ;; Split the switches at any spaces so we can
5890 ;; pass separate options as separate args.
5892 ;; Avoid lossage if FILE starts with `-'.
5900 file))))))))
5902 ;; If we got "//DIRED//" in the output, it means we got a real
5903 ;; directory listing, even if `ls' returned nonzero.
5904 ;; So ignore any errors.
5917 ;; The first time ls returns an error,
5918 ;; find the version numbers of ls,
5919 ;; and set insert-directory-ls-version
5920 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5921 ;; is equal or if the info cannot be obtained.
5922 ;; (That can mean it isn't GNU ls.)
5932 comparison)
5948 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5952 ;; If `insert-directory-program' failed, signal an error.
5954 ;; Delete the error message it may have output.
5956 ;; On non-Posix systems, we cannot open a directory, so
5957 ;; don't even try, because that will always result in
5958 ;; the ubiquitous "Access denied". Instead, show the
5959 ;; command line so the user can try to guess what went wrong.
5964 insert-directory-program
5966 file result)
5967 ;; Unix. Access the file to get a suitable error.
5974 ;; The following overshoots by one line for an empty
5975 ;; directory listed with "--dired", but without "-a"
5976 ;; switch, where the ls output contains a
5977 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5978 ;; We take care of that case later.
5986 error-lines)
5987 ;; Find all the lines that are error messages,
5988 ;; and record the bounds of each one.
5995 ;; Now read the numeric positions of file names.
6002 error-lines))
6005 error-lines)))
6007 ;; End is followed by \n or by " -> ".
6009 ;; It seems that we can't trust ls's output as to
6010 ;; byte positions of filenames.
6016 ;; Take care of the case where the ls output contains a
6017 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6018 ;; and we went one line too far back (see above).
6023 ;; Now decode what read if necessary.
6025 file-name-coding-system
6026 default-file-name-coding-system
6028 coding-no-eol
6029 val pos)
6033 ;; If no coding system is specified or detection is
6034 ;; requested, detect the coding.
6048 ;; Force no eol conversion on a file name, so
6049 ;; that CR is preserved.
6057 ;; Try to insert the amount of free space.
6060 ;; First find the line to put it on.
6064 ;; Replace "total" with "used", to avoid confusion.
6070 "Convert `ls --dired' file name position value POS to a buffer position.
6071 File name position values returned in ls --dired output
6072 count only stdout; they don't count the error messages sent to stderr.
6073 So this function converts to them to real buffer positions.
6074 ERROR-LINES is a list of buffer positions of error message lines,
6075 of the form (START END)."
6079 pos)
6083 "Insert directory listing for FILE, formatted according to SWITCHES.
6085 Like `insert-directory', but if FILE does not exist, it inserts a
6086 message to that effect instead of signaling an error."
6089 ;; Simulate the message printed by `ls'.
6093 "Functions to call with no arguments to query about killing Emacs.
6094 If any of these functions returns nil, killing Emacs is cancelled.
6095 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6099 "How to ask for confirmation when leaving Emacs.
6100 If nil, the default, don't ask at all. If the value is non-nil, it should
6101 be a predicate function such as `yes-or-no-p'."
6109 "Offer to save each buffer, then kill this Emacs process.
6110 With prefix ARG, silently save all file-visiting buffers, then kill."
6119 ;; process-list is not defined on MSDOS.
6121 active)
6130 ;; Query the user for other things, perhaps.
6137 "Offer to save each buffer, then kill the current connection.
6138 If the current frame has no client, kill Emacs itself.
6140 With prefix ARG, silently save all file-visiting buffers, then kill.
6142 If emacsclient was started with a list of filenames to edit, then
6143 only these files will be asked to be saved."
6148 \f
6149 ;; We use /: as a prefix to "quote" a file name
6150 ;; so that magic file name handlers will not apply to it.
6154 file-name-handler-alist))
6156 ;; We depend on being the last handler on the list,
6157 ;; so that anything else which does need handling
6158 ;; has been handled already.
6159 ;; So it is safe for us to inhibit *all* magic file name handlers.
6168 default-directory))
6169 ;; Get a list of the indices of the args which are file names.
6172 ;; The first six are special because they
6173 ;; return a file name. We want to include the /:
6174 ;; in the return value.
6175 ;; So just avoid stripping it in the first place.
6182 ;; `identity' means just return the first arg
6183 ;; not stripped of its quoting.
6185 ;; `add' means add "/:" to the result.
6188 ;; `unquote-then-quote' means set buffer-file-name
6189 ;; temporarily to unquoted filename.
6191 ;; List the arguments which are filenames.
6199 ;; For all other operations, treat the first argument only
6200 ;; as the file name.
6202 method
6203 ;; Copy ARGUMENTS so we can replace elements in it.
6207 ;; Strip off the /: from the file names that have it.
6215 "/"
6232 \f
6233 ;; Symbolic modes and read-file-modes.
6236 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6237 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6238 Others, or All) for whom to produce the mask.
6239 The bit-mask that is returned extracts from mode bits the access rights
6240 for the specified category of users."
6248 "Convert CHAR to a numeric value of mode bits.
6249 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6250 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6257 ;; Rights relative to the previous file modes.
6268 "Convert a symbolic mode string specification to an equivalent number.
6270 WHO-MASK is the bit-mask specifying the category of users to which to
6271 apply the access permissions. See `file-modes-char-to-who'.
6272 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6273 RIGHTS request to add, remove, or set permissions based on existing ones,
6280 char-right)
6287 num-rights
6291 op char-right)))
6292 num-rights))
6295 "Convert symbolic file modes to numeric file modes.
6296 MODES is the string to convert, it should match
6299 notation.
6300 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6301 MODES request to add, remove, or set permissions based on existing ones,
6315 num-who num-modes)
6318 num-modes)))
6321 "Read file modes in octal or symbolic notation and return its numeric value.
6322 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6323 ORIG-FILE is the name of a file on whose mode bits to base returned
6324 permissions if what user types requests to add, remove, or set permissions
6340 nil nil default)))
6346 \f
6347 ;; Trashcan handling.
6349 "Directory for `move-file-to-trash' to move files and directories to.
6350 This directory is only used when the function `system-move-file-to-trash'
6351 is not defined.
6352 Relative paths are interpreted relative to `default-directory'.
6353 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6363 "Move the file (or directory) named FILENAME to the trash.
6364 When `delete-by-moving-to-trash' is non-nil, this function is
6365 called by `delete-file' and `delete-directory' instead of
6366 deleting files outright.
6368 If the function `system-move-file-to-trash' is defined, call it
6369 with FILENAME as an argument.
6370 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6371 directory.
6372 Otherwise, trash FILENAME using the freedesktop.org conventions,
6373 like the GNOME, KDE and XFCE desktop environments. Emacs only
6377 ;; If `trash-directory' is non-nil, move the file there.
6381 trash-dir)))
6382 ;; We can't trash a parent directory of trash-directory.
6385 trash-dir filename))
6388 ;; Ensure that the trashed file-name is unique.
6395 ;; If `system-move-file-to-trash' is defined, use it.
6398 ;; Otherwise, use the freedesktop.org method, as specified at
6399 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6410 ;; Check if we have permissions to delete.
6414 ;; The trashed file cannot be the trash dir or its parent.
6417 trash-files-dir filename))
6420 trash-info-dir filename))
6422 ;; Ensure that the trash directory exists; otherwise, create it.
6431 ;; Try to move to trash with .trashinfo undo information
6436 ;; Perform url-encoding on FN. For compatibility with
6437 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6438 ;; for path separators.
6443 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6444 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6457 fn))
6462 ;; Attempt to make .trashinfo file, trying up to 5
6463 ;; times. The .trashinfo file is opened with O_EXCL,
6464 ;; as per trash-spec 0.7, even if that can be a problem
6465 ;; on old NFS versions...
6469 trash-files-dir))
6471 success info-fn)
6476 trash-info-dir))
6484 ;; Uniqify new-fn. (Some file managers do not
6485 ;; like Emacs-style backup file names---e.g. bug
6486 ;; 170956 in Konqueror bug tracker.)
6491 ;; Finally, try to move the file to the trashcan.
6495 \f
6520 ;;; files.el ends here