| blob | f15c523400dc74460106ce7f6182930e7e5d20d3 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985-1987, 1992-2012 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Package: emacs
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Defines most of Emacs's file- and directory-handling functions,
26 ;; including basic file visiting, backup generation, link handling,
27 ;; ITS-id version control, load- and write-hook handling, and the like.
29 ;;; Code:
36 "Backups of edited data files."
40 "Finding files."
45 "Non-nil means delete auto-save file when a buffer is saved or killed.
47 Note that the auto-save file will not be deleted if the buffer is killed
48 when it has unsaved changes."
53 nil
54 "Alist of abbreviations for file directories.
55 A list of elements of the form (FROM . TO), each meaning to replace
56 FROM with TO when it appears in a directory name. This replacement is
57 done when setting up the default directory of a newly visited file.
59 FROM is matched against directory names anchored at the first
63 FROM and TO should be equivalent names, which refer to the
64 same directory. Do not use `~' in the TO strings;
65 they should be ordinary absolute directory names.
67 Use this feature when you have directories which you normally refer to
68 via absolute symbolic links. Make TO the name of the link, and FROM
69 the name it is linked to."
78 "Non-nil means make a backup of a file the first time it is saved.
79 This can be done by renaming the file or by copying.
81 Renaming means that Emacs renames the existing file so that it is a
82 backup file, then writes the buffer into a new file. Any other names
83 that the old file had will now refer to the backup file. The new file
84 is owned by you and its group is defaulted.
86 Copying means that Emacs copies the existing file into the backup
87 file, then writes the buffer on top of the existing file. Any other
88 names that the old file had will now refer to the new (edited) file.
89 The file's owner and group are unchanged.
91 The choice of renaming or copying is controlled by the variables
92 `backup-by-copying', `backup-by-copying-when-linked',
93 `backup-by-copying-when-mismatch' and
94 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
98 ;; Do this so that local variables based on the file name
99 ;; are not overridden by the major mode.
101 "Non-nil means don't make a backup, regardless of the other parameters.
102 This variable is intended for use by making it local to a buffer.
107 "Non-nil means always use copying to create backup files.
108 See documentation of variable `make-backup-files'."
113 "Non-nil means use copying to create backups for files with multiple names.
114 This causes the alternate names to refer to the latest version as edited.
115 This variable is relevant only if `backup-by-copying' is nil."
120 "Non-nil means create backups by copying if this preserves owner or group.
121 Renaming may still be used (subject to control of other variables)
122 when it would not result in changing the owner or group of the file;
123 that is, for files which are owned by you and whose group matches
124 the default for a new file created there by you.
125 This variable is relevant only if `backup-by-copying' is nil."
132 "Non-nil means create backups by copying to preserve a privileged owner.
133 Renaming may still be used (subject to control of other variables)
134 when it would not result in changing the owner of the file or if the owner
135 has a user id greater than the value of this variable. This is useful
136 when low-numbered uid's are used for special system users (such as root)
137 that must maintain ownership of certain files.
138 This variable is relevant only if `backup-by-copying' and
139 `backup-by-copying-when-mismatch' are nil."
144 "Predicate that looks at a file name and decides whether to make backups.
148 "Non-nil in a buffer means always offer to save buffer on exit.
149 Do so even if the buffer is not visiting a file.
150 Automatically local in all buffers."
157 "Non-nil means find a file under alternative names, in existing buffers.
158 This means if any existing buffer is visiting the file you want
159 under another name, you get the existing buffer instead of a new buffer."
164 "Non-nil means visit a file under its truename.
165 The truename of a file is found by chasing all links
166 both at the file level and at the levels of the containing directories."
172 "Specify which files should be reverted without query.
173 The value is a list of regular expressions.
174 If the file name matches one of these regular expressions,
175 then `revert-buffer' reverts the file without querying
176 if the file has changed on disk and you have not edited the buffer."
181 "The device number and file number of the file visited in the current buffer.
182 The value is a list of the form (FILENUM DEVNUM).
183 This pair of numbers uniquely identifies the file.
197 "The directory for writing small temporary files.
198 If non-nil, this directory is used instead of `temporary-file-directory'
199 by programs that create small temporary files. This is for systems that
200 have fast storage with limited space, such as a RAM disk."
205 ;; The system null device. (Should reference NULL_DEVICE from C.)
233 "Non-nil means protect against I/O errors while saving files.
234 Some modes set this non-nil in particular buffers.
236 This feature works by writing the new contents into a temporary file
237 and then renaming the temporary file to replace the original.
238 In this way, any I/O error in writing leaves the original untouched,
239 and there is never any instant where the file is nonexistent.
241 Note that this feature forces backups to be made by copying.
242 Yet, at the same time, saving a precious file
243 breaks any hard links between it and other files.
245 This feature is advisory: for example, if the directory in which the
246 file is being saved is not writable, Emacs may ignore a non-nil value
247 of `file-precious-flag' and write directly into the file.
249 See also: `break-hardlink-on-save'."
254 "Non-nil means when saving a file that exists under several names
255 \(i.e., has multiple hardlinks), break the hardlink associated with
256 `buffer-file-name' and write to a new file, so that the other
257 instances of the file are not affected by the save.
259 If `buffer-file-name' refers to a symlink, do not break the symlink.
261 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
262 For example, if the directory in which a file is being saved is not
263 itself writable, then error instead of saving in some
264 hardlink-nonbreaking way.
266 See also `backup-by-copying' and `backup-by-copying-when-linked'."
272 "Control use of version numbers for backup files.
273 When t, make numeric backup versions unconditionally.
274 When nil, make them for files that have some already.
275 The value `never' means do not make them."
285 "When cleaning directory, number of versions to keep."
291 "If t, delete excess backup versions silently.
292 If nil, ask confirmation. Any other value prevents any trimming."
299 "Number of oldest versions to keep when a new numbered backup is made."
305 "Number of newest versions to keep when a new numbered backup is made.
306 Includes the new backup. Must be > 0"
312 "Whether to add a newline automatically at the end of the file.
314 A value of t means do this only when the file is about to be saved.
315 A value of `visit' means do this right after the file is visited.
316 A value of `visit-save' means do it at both of those times.
317 Any other non-nil value means ask user whether to add a newline, when saving.
318 A value of nil means don't add newlines.
320 Certain major modes set this locally to the value obtained
321 from `mode-require-final-newline'."
330 "Whether to add a newline at end of file, in certain major modes.
331 Those modes set `require-final-newline' to this value when you enable them.
332 They do so because they are often used for files that are supposed
333 to end in newlines, and the question is how to arrange that.
335 A value of t means do this only when the file is about to be saved.
336 A value of `visit' means do this right after the file is visited.
337 A value of `visit-save' means do it at both of those times.
338 Any other non-nil value means ask user whether to add a newline, when saving.
340 A value of nil means do not add newlines. That is a risky choice in this
341 variable since this value is used for modes for files that ought to have
342 final newlines. So if you set this to nil, you must explicitly check and
343 add a final newline, whenever you save a file that really needs one."
353 "Non-nil says by default do auto-saving of every file-visiting buffer."
359 ;; Don't put "\\2" inside expand-file-name, since it will be
360 ;; transformed to "/2" on DOS/Windows.
362 "Transforms to apply to buffer file name before making auto-save file name.
363 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
364 REGEXP is a regular expression to match against the file name.
365 If it matches, `replace-match' is used to replace the
366 matching part with REPLACEMENT.
367 If the optional element UNIQUIFY is non-nil, the auto-save file name is
368 constructed by taking the directory part of the replaced file-name,
369 concatenated with the buffer file name with all directory separators
370 changed to `!' to prevent clashes. This will not work
371 correctly if your filesystem truncates the resulting name.
373 All the transforms in the list are tried, in the order they are listed.
374 When one transform applies, its result is final;
375 no further transforms are tried.
377 The default value is set up to put the auto-save file into the
378 temporary directory (see the variable `temporary-file-directory') for
379 editing a remote file.
381 On MS-DOS filesystems without long names this variable is always
382 ignored."
390 "Non-nil means save word abbrevs too when files are saved.
391 If `silently', don't ask the user before saving."
396 "Non-nil means allow `find-file' to visit directories.
397 To visit the directory, `find-file' runs `find-directory-functions'."
402 "List of functions to try in sequence to visit a directory.
403 Each function is called with the directory name as the sole argument
404 and should return either a buffer or nil."
408 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
410 "List of functions to try in sequence to get a file name at point.
411 Each function should return either nil or a file name found at the
412 location of point in the current buffer."
416 ;;;It is not useful to make this a local variable.
417 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
419 "List of functions to be called for `find-file' on nonexistent file.
420 These functions are called as soon as the error is detected.
421 Variable `buffer-file-name' is already set up.
426 ;;;It is not useful to make this a local variable.
427 ;;;(put 'find-file-hooks 'permanent-local t)
430 "List of functions to be called after a buffer is loaded from a file.
431 The buffer's local variables (if any) will have been processed before the
432 functions are called."
439 "List of functions to be called before writing out a buffer to a file.
440 If one of them returns non-nil, the file is considered already written
441 and the rest are not called.
442 These hooks are considered to pertain to the visited file.
443 So any buffer-local binding of this variable is discarded if you change
445 change the major mode.
447 This hook is not run if any of the functions in
448 `write-contents-functions' returns non-nil. Both hooks pertain
449 to how to save a buffer to file, for instance, choosing a suitable
450 coding system and setting mode bits. (See Info
451 node `(elisp)Saving Buffers'.) To perform various checks or
462 "List of functions to be called before writing out a buffer to a file.
463 If one of them returns non-nil, the file is considered already written
464 and the rest are not called and neither are the functions in
465 `write-file-functions'.
467 This variable is meant to be used for hooks that pertain to the
468 buffer's contents, not to the particular visited file; thus,
469 `set-visited-file-name' does not clear this variable; but changing the
470 major mode does clear it.
472 For hooks that _do_ pertain to the particular visited file, use
473 `write-file-functions'. Both this variable and
474 `write-file-functions' relate to how a buffer is saved to file.
475 To perform various checks or updates before the buffer is saved,
482 "Control use of local variables in files you visit.
483 The value can be t, nil, :safe, :all, or something else.
485 A value of t means file local variables specifications are obeyed
486 if all the specified variable values are safe; if any values are
487 not safe, Emacs queries you, once, whether to set them all.
488 \(When you say yes to certain values, they are remembered as safe.)
490 :safe means set the safe variables, and ignore the rest.
491 :all means set all variables, whether safe or not.
492 (Don't set it permanently to :all.)
493 A value of nil means always ignore the file local variables.
495 Any other value means always query you once whether to set them all.
496 \(When you say yes to certain values, they are remembered as safe, but
499 This variable also controls use of major modes specified in
500 a -*- line.
503 always obeys file local variable specifications and the -*- line,
504 and ignores this variable."
505 :risky t
514 "Like `enable-local-variables' but meant for buffer-local bindings.
515 The meaningful values are nil and non-nil. The default is non-nil.
516 If a major mode sets this to nil, buffer-locally, then any local
517 variables list in the file will be ignored.
519 This variable does not affect the use of major modes
524 The value can be t, nil or something else.
525 A value of t means obey `eval' variables.
526 A value of nil means ignore them; anything else means query."
527 :risky t
533 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
542 "Non-nil means buffers visiting files read-only do so in view mode.
543 In fact, this means that all read-only buffers normally have
544 View mode enabled, including buffers that are read-only because
545 you visit a file you cannot alter, and buffers you make read-only
551 "History list of file names entered in the minibuffer.
553 Maximum length of the history list is determined by the value
555 \f
558 "Provides support for ange-ftp host name completion.
559 Runs the usual ange-ftp hook, but only for completion operations."
560 ;; Having this here avoids the need to load ange-ftp when it's not
561 ;; really in use.
567 inhibit-file-name-handlers)))
575 "Convert a standard file's name to something suitable for the OS.
576 This means to guarantee valid names and perhaps to canonicalize
577 certain patterns.
579 FILENAME should be an absolute file name since the conversion rules
580 sometimes vary depending on the position in the file name. E.g. c:/foo
581 is a valid DOS file name, but c:/bar/c:/foo is not.
583 This function's standard definition is trivial; it just returns
584 the argument. However, on Windows and DOS, replace invalid
585 characters. On DOS, make sure to obey the 8.3 limitations.
586 In the native Windows build, turn Cygwin names into native names,
587 and also turn slashes into backslashes if the shell requires it (see
588 `w32-shell-dos-semantics').
590 See Info node `(elisp)Standard File Names' for more details."
595 ;; Replace invalid filename characters with !
599 name))
607 "Read directory name, prompting with PROMPT and completing in directory DIR.
608 Value is not expanded---you must call `expand-file-name' yourself.
609 Default name to DEFAULT-DIRNAME if user exits with the same
610 non-empty string that was inserted by this function.
611 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
612 or just DIR if INITIAL is nil.)
613 If the user exits with an empty minibuffer, this function returns
614 an empty string. (This can only happen if the user erased the
615 pre-inserted contents or if `insert-default-directory' is nil.)
616 Fourth arg MUSTMATCH non-nil means require existing directory's name.
617 Non-nil and non-t means also require confirmation after completion.
618 Fifth arg INITIAL specifies text to start with.
619 DIR should be an absolute directory name. It defaults to
620 the value of `default-directory'."
625 dir))
626 mustmatch initial
629 \f
631 "Show the current default directory."
636 "Value of the CDPATH environment variable, as a list.
640 "Explode a search path into a list of directory names.
641 Directories are separated by occurrences of `path-separator'
642 \(which is colon in GNU and GNU-like systems)."
643 ;; We could use split-string here.
651 nil
656 cd-list)))
659 "Change current directory to given absolute file name DIR."
660 ;; Put the name into directory syntax now,
661 ;; because otherwise expand-file-name may give some bad results.
663 ;; We used to additionally call abbreviate-file-name here, for an
664 ;; unknown reason. Problem is that most buffers are setup
665 ;; without going through cd-absolute and don't call
666 ;; abbreviate-file-name on their default-directory, so the few that
667 ;; do end up using a superficially different directory.
679 "Make DIR become the current buffer's default directory.
680 If your environment includes a `CDPATH' variable, try each one of
681 that list of directories (separated by occurrences of
682 `path-separator') when resolving a relative directory name.
683 The path separator is colon in GNU and GNU-like systems."
686 ;; FIXME: There's a subtle bug in the completion below. Seems linked
687 ;; to a fundamental difficulty of implementing `predicate' correctly.
688 ;; The manifestation is that TAB may list non-directories in the case where
689 ;; those files also correspond to valid directories (if your cd-path is (A/
690 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
691 ;; will be listed as valid completions).
692 ;; This is because `a' (listed because of A/a) is indeed a valid choice
693 ;; (which will lead to the use of B/a).
698 cd-path nil))
707 default-directory default-directory
708 t))))
718 "Load the Lisp file named FILE."
719 ;; This is a case where .elc makes a lot of sense.
726 "Search for FILENAME through PATH.
727 If found, return the absolute file name of FILENAME, with its suffixes;
728 otherwise return nil.
729 PATH should be a list of directories to look in, like the lists in
730 `exec-path' or `load-path'.
731 If SUFFIXES is non-nil, it should be a list of suffixes to append to
734 If non-nil, PREDICATE is used instead of `file-readable-p'.
736 This function will normally skip directories, so if you want it to find
737 directories, make sure the PREDICATE function returns `dir-ok' for them.
739 PREDICATE can also be an integer to pass to the `access' system call,
740 in which case file-name handlers are ignored. This usage is deprecated.
741 For compatibility, PREDICATE can also be one of the symbols
742 `executable', `readable', `writable', or `exists', or a list of
743 one or more of those symbols."
754 "Do completion for file names passed to `locate-file'."
757 ;; FIXME: maybe we should use completion-file-name-table instead,
758 ;; tho at least for `load', the arg is passed through
759 ;; substitute-in-file-name for historical reasons.
769 ;; If we have files like "foo.el" and "foo.elc", we could load one of
770 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
771 ;; preferred way. So if we list all 3, that gives a lot of redundant
772 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
773 ;; the user does want to pay attention to the extension. We try to
774 ;; diffuse this tension by stripping the suffix, except when the
775 ;; result is a single element (i.e. usually we only list "foo" unless
776 ;; it's the only remaining element in the list, in which case we do
777 ;; list "foo", "foo.elc" and "foo.el").
788 string-file dir))
793 ;; Switching from names to names+fullnames creates a non-monotonicity
794 ;; which can cause problems with things like partial-completion.
795 ;; To minimize the problem, filter out completion-regexp-list, so that
796 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
797 ;; from `names' which only matched `string' when they still had
798 ;; their suffix.
800 ;; Remove duplicates of the first element, so that we can easily check
801 ;; if `names' really only contains a single element.
804 ;; There's no more than one matching non-suffixed element, so expand
805 ;; the list by adding the suffixed elements as well.
808 string-dir names string-file pred action)))))
811 "Do completion for file names passed to `locate-file'.
812 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
815 string nil action))
820 "Regexp of directory names which stop the search in `locate-dominating-file'.
821 Any directory whose name matches this regexp will be treated like
822 a kind of root directory by `locate-dominating-file' which will stop its search
823 when it bumps into it.
824 The default regexp prevents fruitless and time-consuming attempts to find
825 special files in directories in which filenames are interpreted as hostnames,
828 ;; (defun locate-dominating-files (file regexp)
829 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
830 ;; Stop at the first parent where a matching file is found and return the list
831 ;; of files that that match in this directory."
832 ;; (catch 'found
833 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
834 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
835 ;; (let ((user nil)
836 ;; ;; Abbreviate, so as to stop when we cross ~/.
837 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
838 ;; files)
839 ;; (while (and dir
840 ;; ;; As a heuristic, we stop looking up the hierarchy of
841 ;; ;; directories as soon as we find a directory belonging to
842 ;; ;; another user. This should save us from looking in
843 ;; ;; things like /net and /afs. This assumes that all the
844 ;; ;; files inside a project belong to the same user.
845 ;; (let ((prev-user user))
846 ;; (setq user (nth 2 (file-attributes dir)))
847 ;; (or (null prev-user) (equal user prev-user))))
848 ;; (if (setq files (condition-case nil
849 ;; (directory-files dir 'full regexp 'nosort)
850 ;; (error nil)))
851 ;; (throw 'found files)
852 ;; (if (equal dir
853 ;; (setq dir (file-name-directory
854 ;; (directory-file-name dir))))
855 ;; (setq dir nil))))
856 ;; nil)))
859 "Look up the directory hierarchy from FILE for a file named NAME.
860 Stop at the first parent directory containing a file NAME,
861 and return the directory. Return nil if not found."
862 ;; We used to use the above locate-dominating-files code, but the
863 ;; directory-files call is very costly, so we're much better off doing
864 ;; multiple calls using the code in here.
865 ;;
866 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
867 ;; `name' in /home or in /.
870 ;; `user' is not initialized outside the loop because
871 ;; `file' may not exist, so we may have to walk up part of the
872 ;; hierarchy before we find the "initial UID". Note: currently unused
873 ;; (user nil)
874 try)
877 ;; FIXME: Disabled this heuristic because it is sometimes
878 ;; inappropriate.
879 ;; As a heuristic, we stop looking up the hierarchy of
880 ;; directories as soon as we find a directory belonging
881 ;; to another user. This should save us from looking in
882 ;; things like /net and /afs. This assumes that all the
883 ;; files inside a project belong to the same user.
884 ;; (let ((prev-user user))
885 ;; (setq user (nth 2 (file-attributes file)))
886 ;; (and prev-user (not (equal user prev-user))))
893 root))
897 "Search for COMMAND in `exec-path' and return the absolute file name.
898 Return nil if COMMAND is not found anywhere in `exec-path'."
899 ;; Use 1 rather than file-executable-p to better match the behavior of
900 ;; call-process.
904 "Load the Emacs Lisp library named LIBRARY.
905 This is an interface to the function `load'. LIBRARY is searched
906 for in `load-path', both with and without `load-suffixes' (as
907 well as `load-file-rep-suffixes').
909 See Info node `(emacs)Lisp Libraries' for more details.
910 See `load-file' for a different interface to `load'."
914 load-path
919 "Test whether FILE specifies a location on a remote system.
920 A file is considered remote if accessing it is likely to
921 be slower or less reliable than accessing local files.
923 `file-remote-p' never opens a new remote connection. It can
924 only reuse a connection that is already open.
926 Return nil or a string identifying the remote connection
927 \(ideally a prefix of FILE). Return nil if FILE is a relative
928 file name.
930 When IDENTIFICATION is nil, the returned string is a complete
931 remote identifier: with components method, user, and host. The
932 components are those present in FILE, with defaults filled in for
933 any that are missing.
935 IDENTIFICATION can specify which part of the identification to
936 return. IDENTIFICATION can be the symbol `method', `user',
937 `host', or `localname'. Any other value is handled like nil and
938 means to return the complete identification. The string returned
939 for IDENTIFICATION `localname' can differ depending on whether
940 there is an existing connection.
942 If CONNECTED is non-nil, return an identification only if FILE is
943 located on a remote system and a connection is established to
944 that remote system.
946 Tip: You can use this expansion of remote identifier components
947 to derive a new remote file name from an existing one. For
953 same remote identifier as FILE but expanded; a name such as
958 nil)))
961 "Whether to use the remote file-name cache for read access.
963 When `nil', always use the cached values.
964 When `t', never use them.
965 A number means use them for that amount of seconds since they were
966 cached.
968 File attributes of remote files are cached for better performance.
969 If they are changed out of Emacs' control, the cached values
970 become invalid, and must be invalidated.
972 In case a remote file is checked regularly, it might be
973 reasonable to let-bind this variable to a value less then the
974 time period between two checks.
975 Example:
977 (defun display-time-file-nonempty-p (file)
978 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
979 (and (file-exists-p file)
980 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
991 "Copy the file FILE into a temporary file on this machine.
992 Returns the name of the local copy, or nil, if FILE is directly
993 accessible."
994 ;; This formerly had an optional BUFFER argument that wasn't used by
995 ;; anything.
999 nil)))
1002 "Return the truename of FILENAME.
1003 If FILENAME is not absolute, first expands it against `default-directory'.
1004 The truename of a file name is found by chasing symbolic links
1005 both at the level of the file and at the level of the directories
1006 containing it, until no links are left at any level.
1009 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1010 ;; COUNTER can be a cons cell whose car is the count of how many
1011 ;; more links to chase before getting an error.
1012 ;; PREV-DIRS can be a cons cell whose car is an alist
1013 ;; of truenames we've just recently computed.
1027 ;; For speed, remove the ange-ftp completion handler from the list.
1028 ;; We know it's not needed here.
1029 ;; For even more speed, do this only on the outermost call.
1036 ;; andrewi@harlequin.co.uk - none of the following code (except for
1037 ;; invoking the file-name handler) currently applies on Windows
1038 ;; (ie. there are no native symlinks), but there is an issue with
1039 ;; case differences being ignored by the OS, and short "8.3 DOS"
1040 ;; name aliases existing for all files. (The short names are not
1041 ;; reported by directory-files, but can be used to refer to files.)
1042 ;; It seems appropriate for file-truename to resolve these issues in
1043 ;; the most natural way, which on Windows is to call the function
1044 ;; `w32-long-file-name' - this returns the exact name of a file as
1045 ;; it is stored on disk (expanding short name aliases with the full
1046 ;; name in the process).
1049 ;; For file name that has a special handler, call handler.
1050 ;; This is so that ange-ftp can save time by doing a no-op.
1053 ;; If filename contains a wildcard, newname will be the old name.
1055 ;; If filename exists, use the long name. If it doesn't exist,
1056 ;; drill down until we find a directory that exists, and use
1057 ;; the long name of that, with the extra non-existent path
1058 ;; components concatenated.
1060 missing rest)
1063 ;; Include the preceding directory separator in the missing
1064 ;; part so subsequent recursion on the rest works.
1069 ""
1074 ;; If this file directly leads to a link, process that iteratively
1075 ;; so that we don't use lots of stack.
1081 ;; For file name that has a special handler, call handler.
1082 ;; This is so that ange-ftp can save time by doing a no-op.
1085 done t)
1087 target dirfile)
1088 ;; Get the truename of the directory.
1090 ;; If these are equal, we have the (or a) root directory.
1092 ;; If this is the same dir we last got the truename for,
1093 ;; save time--don't recalculate.
1103 done t)
1106 done t)
1107 ;; Put it back on the file name.
1109 ;; Is the file name the name of a link?
1112 ;; Yes => chase that link, then start all over
1113 ;; since the link may point to a directory name that uses links.
1114 ;; We can't safely use expand-file-name here
1115 ;; since target might look like foo/../bar where foo
1116 ;; is itself a link. Instead, we handle . and .. above.
1119 target
1121 done nil)
1122 ;; No, we are done!
1124 filename))
1127 "Chase links in FILENAME until a name that is not a link.
1128 Unlike `file-truename', this does not check whether a parent
1129 directory name is a symbolic link.
1130 If the optional argument LIMIT is a number,
1131 it means chase no more than that many links and then stop."
1139 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1142 ;; Handle `..' by hand, since it needs to work in the
1143 ;; target of any directory symlink.
1144 ;; This code is not quite complete; it does not handle
1145 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1149 ;; Chase links in the default dir of the symlink.
1153 ;; Now find the parent of that dir.
1157 newname))
1159 ;; A handy function to display file sizes in human-readable form.
1160 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1162 "Produce a string showing FILE-SIZE in human-readable form.
1164 Optional second argument FLAVOR controls the units and the display format:
1166 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1168 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1170 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1173 1024.0
1176 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1182 "%.1f%s%s"
1184 file-size
1186 "K"
1191 "Create a temporary file.
1192 The returned file name (created by appending some random characters at the end
1193 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1194 is guaranteed to point to a newly created empty file.
1195 You can then use `write-region' to write new data into the file.
1197 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1199 If SUFFIX is non-nil, add that at the end of the file name."
1201 file)
1204 ;; Create temp files with strict access rights. It's easy to
1205 ;; loosen them later, whereas it's impossible to close the
1206 ;; time-window of loose permissions otherwise.
1214 temporary-file-directory)
1216 temporary-file-directory))))
1222 nil)
1224 ;; the file was somehow created by someone else between
1225 ;; `make-temp-name' and `write-region', let's try again.
1226 nil)
1227 file)
1228 ;; Reset the umask.
1232 "Change the encoding of FILE's name from CODING to NEW-CODING.
1233 The value is a new name of FILE.
1234 Signals a `file-already-exists' error if a file of the new name
1235 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1236 is non-nil. A number as fourth arg means request confirmation if
1237 the new name already exists. This is what happens in interactive
1238 use with M-x."
1241 default-file-name-coding-system))
1243 from-coding to-coding)
1245 ;; We provide the default coding only when it seems that
1246 ;; the filename is correctly decoded by the default
1247 ;; coding.
1253 filename default-coding)
1254 default-coding))
1258 ;; We provide the default coding only when a user is going to
1259 ;; change the encoding not from the default coding.
1263 filename from-coding)))
1266 filename from-coding default-coding)
1267 default-coding)))
1271 default-file-name-coding-system))
1272 ;; FILE should have been decoded by DEFAULT-CODING.
1276 ;; Suppress further encoding.
1281 newname))
1282 \f
1284 "Whether confirmation is requested before visiting a new file or buffer.
1285 If nil, confirmation is not requested.
1286 If the value is `after-completion', confirmation is only
1287 requested if the user called `minibuffer-complete' right before
1288 `minibuffer-complete-and-exit'.
1289 Any other non-nil value means to request confirmation.
1291 This affects commands like `switch-to-buffer' and `find-file'."
1299 "Whether to request confirmation before visiting a new file or buffer.
1300 The variable `confirm-nonexistent-file-or-buffer' determines the
1301 return value, which may be passed as the REQUIRE-MATCH arg to
1302 `read-buffer' or `find-file-read-args'."
1310 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1311 BODY should use the minibuffer at most once.
1312 Recursive uses of the minibuffer are unaffected (FUN is not
1313 called additional times).
1315 This macro actually adds an auxiliary function that calls FUN,
1316 rather than FUN itself, to `minibuffer-setup-hook'."
1322 ;; Clear out this hook so it does not interfere
1323 ;; with any recursive minibuffer usage.
1334 t))
1337 "Edit file FILENAME.
1338 Switch to a buffer visiting file FILENAME,
1339 creating one if none already exists.
1340 Interactively, the default if you just type RET is the current directory,
1341 but the visited file name is available through the minibuffer history:
1342 type M-n to pull it into the minibuffer.
1344 You can visit files on remote machines by specifying something
1345 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1346 also visit local files as a different user by specifying
1347 /sudo::FILE for the file name.
1348 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1349 manual, for more about this.
1351 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1352 expand wildcards (if any) and visit multiple files. You can
1353 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1355 To visit a file without any kind of conversion and without
1366 "Edit file FILENAME, in another window.
1369 an existing one. See the function `display-buffer'.
1371 Interactively, the default if you just type RET is the current directory,
1372 but the visited file name is available through the minibuffer history:
1373 type M-n to pull it into the minibuffer.
1375 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1376 expand wildcards (if any) and visit multiple files."
1389 "Edit file FILENAME, in another frame.
1392 an existing one. See the function `display-buffer'.
1394 Interactively, the default if you just type RET is the current directory,
1395 but the visited file name is available through the minibuffer history:
1396 type M-n to pull it into the minibuffer.
1398 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1399 expand wildcards (if any) and visit multiple files."
1412 "Edit the existing file FILENAME.
1414 file names with wildcards."
1423 "Edit file FILENAME but don't allow changes.
1437 value))
1440 "Edit file FILENAME in another window but don't allow changes.
1454 value))
1457 "Edit file FILENAME in another frame but don't allow changes.
1471 value))
1474 "Find file FILENAME as a replacement for the file in the next window.
1475 This command does not select that window.
1479 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1480 expand wildcards (if any) and replace the file with multiple files."
1491 "Find alternate file: " file-dir nil
1493 t))))
1503 "Find file FILENAME, select its buffer, kill previous buffer.
1504 If the current buffer now contains an empty file that you just visited
1505 \(presumably by mistake), use this command to visit the file you really want.
1509 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1510 expand wildcards (if any) and replace the file with multiple files.
1512 If the current buffer is an indirect buffer, or the base buffer
1513 for one or more indirect buffers, the other buffer(s) are not
1514 killed."
1523 "Find alternate file: " file-dir nil
1525 t)))
1540 ;; Run `kill-buffer-hook' here. It needs to happen before
1541 ;; variables like `buffer-file-name' etc are set to nil below,
1542 ;; because some of the hooks that could be invoked
1543 ;; (e.g., `save-place-to-alist') depend on those variables.
1544 ;;
1545 ;; Note that `kill-buffer-hook' is not what queries whether to
1546 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1547 ;; asks that itself. Thus, there's no need to temporarily do
1548 ;; `(set-buffer-modified-p nil)' before running this hook.
1550 ;; Okay, now we can end-of-life the old buffer.
1557 ;; This prevents us from finding the same buffer
1558 ;; if we specified the same file again.
1562 ;; Likewise for dired buffers.
1566 ;; This executes if find-file gets an error
1567 ;; and does not really find anything.
1568 ;; We put things back as they were.
1569 ;; If find-file actually finds something, we kill obuf below.
1578 ;; We already ran these; don't run them again.
1581 \f
1583 "Create a suitably named buffer for visiting FILENAME, and return it.
1584 FILENAME (sans directory) is used unchanged if that name is free;
1585 otherwise a string <2> or <3> or ... is appended to get an unused name.
1586 Spaces at the start of FILENAME (sans directory) are removed."
1595 "Create and return a buffer with a name based on NAME.
1596 Choose the buffer's name using `generate-new-buffer-name'."
1600 "Regexp to match the automounter prefix in a directory name."
1608 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1610 home directory is a root directory) and removes automounter prefixes
1611 \(see the variable `automount-dir-prefix')."
1612 ;; Get rid of the prefixes added by the automounter.
1619 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1620 ;; To fix this right, we need a `file-name-case-sensitive-p'
1621 ;; function, but we don't have that yet, so just guess.
1624 ;; If any elt of directory-abbrev-alist matches this name,
1625 ;; abbreviate accordingly.
1631 ;; Compute and save the abbreviated homedir name.
1632 ;; We defer computing this until the first time it's needed, to
1633 ;; give time for directory-abbrev-alist to be set properly.
1634 ;; We include a slash at the end, to avoid spurious matches
1635 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1642 ;; If FILENAME starts with the abbreviated homedir,
1643 ;; make it start with `~' instead.
1645 ;; If the home dir is just /, don't change it.
1648 ;; MS-DOS root directories can come with a drive letter;
1649 ;; Novell Netware allows drive letters beyond `Z:'.
1657 filename)))
1660 "Return the buffer visiting file FILENAME (a string).
1661 This is like `get-file-buffer', except that it checks for any buffer
1662 visiting the same file, possibly under a different name.
1663 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1664 and others are ignored.
1665 If there is no such live buffer, return nil."
1678 found)
1688 ;; Verify this buffer's file number
1689 ;; still belongs to its file.
1692 attributes)
1696 found))))
1697 \f
1699 "Non-nil means file-visiting commands should handle wildcards.
1700 For example, if you specify `*.c', that would visit all the files
1701 whose names match the pattern."
1707 "Non-nil means suppress warning messages for symlinked files.
1708 When nil, Emacs prints a warning when visiting a file that is already
1709 visited, but with a different name. Setting this option to t
1710 suppresses this warning."
1716 "Maximum size of file above which a confirmation is requested.
1717 When nil, never request confirmation."
1724 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1725 OP-TYPE specifies the file operation being performed (for message to user)."
1734 "Read file FILENAME into a buffer and return the buffer.
1735 If a buffer exists visiting FILENAME, return that one, but
1736 verify that the file has not changed since visited or saved.
1737 The buffer is not selected, just returned to the caller.
1738 Optional second arg NOWARN non-nil means suppress any warning messages.
1739 Optional third arg RAWFILE non-nil means the file is read literally.
1740 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1741 and visit all the matching files. When wildcards are actually
1742 used and expanded, return a list of buffers that are visiting
1743 the various files."
1750 'find-directory-functions
1753 filename)))
1756 find-file-wildcards
1770 ;; Find any buffer for a file which has same truename.
1772 ;; Let user know if there is a buffer with the same truename.
1776 find-file-suppress-same-file-warnings
1780 ;; Optionally also find that buffer.
1783 ;; Check to see if the file looks uncommonly large.
1787 ;; We are using an existing buffer.
1794 ;; Certain files should be reverted automatically
1795 ;; if they have changed on disk and not in the buffer.
1803 found))
1813 "File %s changed on disk. Discard your edits? "
1818 "File %s changed on disk. Discard your edits in %s? "
1826 ;; Check if a formerly read-only file has become
1827 ;; writable and vice versa, but if the buffer agrees
1828 ;; with the new state of the file, that is ok too.
1836 buffer-file-name
1845 ;; It is confusing to ask whether to visit
1846 ;; non-literally if they have the file in
1847 ;; hexl-mode or image-mode.
1853 "The file %s is already visited normally,
1854 and you have edited the buffer. Now you have asked to visit it literally,
1855 meaning no coding system handling, format conversion, or local variables.
1856 Emacs can only visit a file in one way at a time.
1858 Do you want to save the file, and visit it literally instead? "
1859 "The file %s is already visited literally,
1860 meaning no coding system handling, format conversion, or local variables.
1861 You have edited the buffer. Now you have asked to visit the file normally,
1862 but Emacs can only visit a file in one way at a time.
1869 rawfile truename number))
1873 "\
1874 Do you want to discard your changes, and visit the file literally now? "
1875 "\
1878 rawfile truename number)
1884 "The file %s is already visited normally.
1885 You have asked to visit it literally,
1886 meaning no coding system decoding, format conversion, or local variables.
1887 But Emacs can only visit a file in one way at a time.
1889 Do you want to revisit the file literally now? "
1890 "The file %s is already visited literally,
1891 meaning no coding system decoding, format conversion, or local variables.
1892 You have asked to visit it normally,
1893 but Emacs can only visit a file in one way at a time.
1898 rawfile truename number)
1901 ;; Return the buffer we are using.
1902 buf)
1903 ;; Create a new buffer.
1905 ;; find-file-noselect-1 may use a different buffer.
1907 rawfile truename number))))))
1913 ;; Needed in case we are re-visiting the file with a different
1914 ;; text representation.
1931 filename)))
1932 ;; Unconditionally set error
1942 filename)))
1943 ;; Run find-file-not-found-functions until one returns non-nil.
1945 ;; If they fail too, set error.
1947 ;; Record the file's truename, and maybe use that as visited name.
1955 ;; Set buffer's default directory to that of the file.
1957 ;; Turn off backup files for certain file names. Since
1958 ;; this is a permanent local, the major mode won't eliminate it.
1973 \f
1975 "Like `insert-file-contents', but only reads in the file literally.
1976 A buffer may be modified in several ways after reading into the buffer,
1977 to Emacs features such as format decoding, character code
1978 conversion, `find-file-hook', automatic uncompression, etc.
1980 This function ensures that none of these modifications will take place."
1988 nil))
1991 inhibit-file-name-handlers))
2004 filename)))
2005 ;; Check whether the file is uncommonly large
2016 "Insert contents of file FILENAME into buffer after point with no conversion.
2018 This function is meant for the user to run interactively.
2019 Don't call it from programs! Use `insert-file-contents-literally' instead.
2020 \(Its calling sequence is different; see its documentation)."
2025 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2026 This has the `permanent-local' property, which takes effect if you
2031 "Visit file FILENAME with no conversion of any kind.
2032 Format conversion and character code conversion are both disabled,
2033 and multibyte characters are disabled in the resulting buffer.
2034 The major mode used is Fundamental mode regardless of the file name,
2035 and local variable specifications in the file are ignored.
2036 Automatic uncompression and adding a newline at the end of the
2037 file due to `require-final-newline' is also disabled.
2039 You cannot absolutely rely on this function to result in
2040 visiting the file literally. If Emacs already has a buffer
2041 which is visiting the file, you get the existing buffer,
2042 regardless of whether it was created literally or not.
2044 In a Lisp program, if you want to be sure of accessing a file's
2045 contents literally, you should create a temporary buffer and then read
2046 the file contents into it using `insert-file-contents-literally'."
2049 "Find file literally: " nil default-directory
2052 \f
2054 _after-find-file-from-revert-buffer
2055 nomodes)
2056 "Called after finding a file and by the default revert function.
2057 Sets buffer mode, parses local variables.
2058 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2059 error in reading the file. WARN non-nil means warn if there
2060 exists an auto-save file more recent than the visited file.
2061 NOAUTO means don't mess with auto-save mode.
2062 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2063 \(see `revert-buffer-in-progress-p' for similar functionality).
2064 Fifth arg NOMODES non-nil means don't alter the file's modes.
2065 Finishes by calling the functions in `find-file-hook'
2066 unless NOMODES is non-nil."
2069 nil
2079 "Symbolic link that points to nonexistent file"
2083 ;; No need to warn if buffer is auto-saved
2084 ;; under the name of the visited file.
2086 auto-save-visited-file-name))
2089 buffer-file-name))
2109 ;; Make people do a little extra work (C-x C-q)
2110 ;; before altering a backup file.
2113 ;; When a file is marked read-only,
2114 ;; make the buffer read-only even if root is looking at it.
2122 ;; If requested, add a newline at the end of the file.
2132 view-read-only
2138 "Eval BODY and turn any error into a FORMAT message.
2139 FORMAT can have a %s escape which will be replaced with the actual error.
2140 If `debug-on-error' is set, errors are not caught, so that you can
2141 debug them.
2142 Avoid using a large BODY since it is duplicated."
2151 "Choose the major mode for this buffer automatically.
2152 Also sets up any specified local variables of the file.
2153 Uses the visited file name, the -*- line, and the local variables spec.
2155 This function is called automatically from `find-file'. In that case,
2156 we may set up the file-specified mode and local variables,
2157 depending on the value of `enable-local-variables'.
2158 In addition, if `local-enable-local-variables' is nil, we do
2159 not set local variables (though we do notice a mode specified with -*-.)
2161 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2162 or from Lisp without specifying the optional argument FIND-FILE;
2163 in that case, this function acts as if `enable-local-variables' were t."
2167 ;; FIXME this is less efficient than it could be, since both
2168 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2173 ;; Turn font lock off and on, to make sure it takes account of
2174 ;; whatever file local variables are relevant to it.
2176 ;; Font-lock-mode (now in font-core.el) can be ON when
2177 ;; font-lock.el still hasn't been loaded.
2187 "Non-nil means to try second pass through `auto-mode-alist'.
2188 This means that if the first case-sensitive search through the alist fails
2189 to find a matching major mode, a second case-insensitive search is made.
2190 On systems with case-insensitive file names, this variable is ignored,
2191 since only a single case-insensitive search through the alist is made."
2197 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2198 ;; c++-mode, java-mode and more) are added through autoload
2199 ;; directives in that file. That way is discouraged since it
2200 ;; spreads out the definition of the initial value.
2244 ;; Less common extensions come here
2245 ;; so more common ones above are found faster.
2253 ;; Besides .gdbinit, gdb documents other names to be usable for init
2254 ;; files, cross-debuggers can use something like
2255 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2256 ;; don't interfere with each other.
2288 ;; The Fortran standard does not say anything about file extensions.
2289 ;; .f90 was widely used for F90, now we seem to be trapped into
2290 ;; using a different extension for each language revision.
2291 ;; Anyway, the following extensions are supported by gfortran.
2299 ;; The list of archive file extensions should be in sync with
2300 ;; `auto-coding-alist' with `no-conversion' coding system.
2306 ;; Mailer puts message to be edited in
2307 ;; /tmp/Re.... or Message
2310 ;; some news reader is reported to use this
2321 ;; .emacs or .gnus or .viper following a directory delimiter in
2322 ;; Unix, MSDOG or VMS syntax.
2325 ;; _emacs following a directory delimiter
2326 ;; in MsDos syntax
2330 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2331 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2332 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2335 ;; .xs is also used for ld scripts, but seems to be more commonly
2336 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2338 ;; Explained in binutils ld/genscripts.sh. Eg:
2339 ;; A .x script file is the default script.
2340 ;; A .xr script is for linking without relocation (-r flag). Etc.
2344 ;; Common Lisp ASDF package system.
2351 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2363 ;; Windows candidates may be opened case sensitively on Unix
2369 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2370 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2371 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2372 ;; this has lower priority to avoid matching changelog.sgml etc.
2374 ;; either user's dot-files or under /etc or some such
2376 ;; alas not all ~/.*rc files are like this
2377 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2382 ;; this contains everything twice, with space and with colon :-(
2384 ;; Get rid of any trailing .n.m and try again.
2385 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2386 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2387 ;; Using mode nil rather than `ignore' would let the search continue
2388 ;; through this list (with the shortened name) rather than start over.
2391 ;; This should come after "in" stripping (e.g. config.h.in).
2392 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2394 ;; The following should come after the ChangeLog pattern
2395 ;; for the sake of ChangeLog.1, etc.
2396 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2398 "Alist of filename patterns vs corresponding major mode functions.
2399 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2400 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2401 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2402 mode function to use. FUNCTION will be called, unless it is nil.
2404 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2405 calling FUNCTION (if it's not nil), we delete the suffix that matched
2406 REGEXP and search the list again for another match.
2408 If the file name matches `inhibit-first-line-modes-regexps',
2409 then `auto-mode-alist' is not processed.
2411 The extensions whose FUNCTION is `archive-mode' should also
2412 appear in `auto-coding-alist' with `no-conversion' coding system.
2414 See also `interpreter-mode-alist', which detects executable script modes
2415 based on the interpreters they specify to run,
2420 "Select Conf mode or XML mode according to start of file."
2430 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2431 ;; and pike-mode) are added through autoload directives in that
2432 ;; file. That way is discouraged since it spreads out the
2433 ;; definition of the initial value.
2473 "Alist mapping interpreter names to major modes.
2474 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2475 Each element looks like (INTERPRETER . MODE).
2476 If INTERPRETER matches the name of the interpreter specified in the first line
2477 of a script, mode MODE is enabled.
2487 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2488 When checking `inhibit-first-line-modes-regexps', we first discard
2494 "Regexp matching interpreters, for file mode determination.
2495 This regular expression is matched against the first line of a file
2496 to determine the file's mode in `set-auto-mode'. If it matches, the file
2497 is assumed to be interpreted by the interpreter matched by the second group
2498 of the regular expression. The mode is then determined as the mode
2502 "Alist of buffer beginnings vs. corresponding major mode functions.
2503 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2504 After visiting a file, if REGEXP matches the text at the beginning of the
2505 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2506 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2507 major mode.
2509 If FUNCTION is nil, then it is not called. (That is a way of saying
2517 ;; The < comes before the groups (but the first) to reduce backtracking.
2518 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2519 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2523 comment-re "*"
2526 . html-mode)
2528 ;; These two must come after html, because they are more general:
2533 . sgml-mode)
2536 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2537 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2538 After visiting a file, if REGEXP matches the text at the beginning of the
2539 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2540 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2541 have not specified a mode for this file.
2547 "Upper limit on `magic-mode-alist' regexp matches.
2551 "Select major mode appropriate for current buffer.
2553 To find the right major mode, this function checks for a -*- mode tag,
2554 checks for a `mode:' entry in the Local Variables section of the file,
2555 checks if it uses an interpreter listed in `interpreter-mode-alist',
2556 matches the buffer beginning against `magic-mode-alist',
2557 compares the filename against the entries in `auto-mode-alist',
2558 then matches the buffer beginning against `magic-fallback-mode-alist'.
2560 If `enable-local-variables' is nil, this function does not check for
2561 any mode: tag anywhere in the file.
2563 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2564 set the major mode only if that would change it. In other words
2565 we don't actually set it to the same mode the buffer already has."
2566 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2568 ;; Once we drop the deprecated feature where mode: is also allowed to
2569 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2570 ;; remove this section and just let (hack-local-variables t) handle it.
2571 ;; Find a -*- mode tag.
2578 ;; Find all specifications for the `mode:' variable
2579 ;; and execute them left to right.
2591 modes)))
2592 ;; Simple -*-MODE-*- case.
2595 modes))))
2596 ;; If we found modes to use, invoke them now, outside the save-excursion.
2604 ;; continuing would call minor modes again, toggling them off
2607 enable-local-variables
2614 ;; If we didn't, look for an interpreter specified in the first line.
2615 ;; As a special case, allow for things like "#!/bin/env perl", which
2616 ;; finds the interpreter anywhere in $PATH.
2623 ;; Map interpreter name to a mode, signaling we're done at the
2624 ;; same time.
2626 interpreter-mode-alist))
2627 ;; If we found an interpreter mode to use, invoke it now.
2630 ;; Next try matching the buffer beginning against magic-mode-alist.
2644 ;; Next compare the filename against the entries in auto-mode-alist.
2649 ;; Remove backup-suffixes from file name.
2651 ;; Remove remote file name identification.
2656 ;; Find first matching alist entry.
2659 ;; System is case-insensitive.
2663 ;; System is case-sensitive.
2665 ;; First match case-sensitively.
2669 ;; Fallback to case-insensitive match.
2683 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2698 ;; When `keep-mode-if-same' is set, we are working on behalf of
2699 ;; set-visited-file-name. In that case, if the major mode specified is the
2700 ;; same one we already have, don't actually reset it. We don't want to lose
2701 ;; minor modes such as Font Lock.
2703 "Apply MODE and return it.
2704 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2705 any aliases and compared to current major mode. If they are the
2706 same, do nothing and return nil."
2712 mode)))
2715 "Find the -*- spec in the buffer.
2716 Call with point at the place to start searching from.
2717 If one is found, set point to the beginning
2718 and return the position of the end.
2719 Otherwise, return nil; point may be changed."
2722 ;; Don't look for -*- if this file name matches any
2723 ;; of the regexps in inhibit-first-line-modes-regexps.
2731 sufs)
2739 ;; If the file begins with "#!"
2740 ;; (exec interpreter magic), look
2741 ;; for mode frobs in the first two
2742 ;; lines. You cannot necessarily
2743 ;; put them in the first line of
2744 ;; such a file without screwing up
2745 ;; the interpreter invocation.
2746 ;; The same holds for
2747 ;; '\"
2748 ;; in man pages (preprocessor
2749 ;; magic for the `man' program).
2760 end))))
2761 \f
2762 ;;; Handling file local variables
2766 file-local-variables-alist dir-local-variables-alist)
2771 "Normal hook run after processing a file's local variables specs.
2772 Major modes can use this to examine user-specified local variables
2776 "List variable-value pairs that are considered safe.
2777 Each element is a cons cell (VAR . VAL), where VAR is a variable
2778 symbol and VAL is a value that is considered safe."
2779 :risky t
2784 ;; This should be here at least as long as Emacs supports write-file-hooks.
2788 "Expressions that are considered safe in an `eval:' local variable.
2789 Add expressions to this list if you want Emacs to evaluate them, when
2790 they appear in an `eval' local variable specification, without first
2791 asking you for confirmation."
2792 :risky t
2797 ;; Risky local variables:
2800 buffer-auto-save-file-name
2801 buffer-file-name
2802 buffer-file-truename
2803 buffer-undo-list
2804 debugger
2805 default-text-properties
2806 eval
2807 exec-directory
2808 exec-path
2809 file-name-handler-alist
2810 frame-title-format
2811 global-mode-string
2812 header-line-format
2813 icon-title-format
2814 inhibit-quit
2815 load-path
2816 max-lisp-eval-depth
2817 max-specpdl-size
2818 minor-mode-map-alist
2819 minor-mode-overriding-map-alist
2820 mode-line-format
2821 mode-name
2822 overriding-local-map
2823 overriding-terminal-local-map
2824 process-environment
2825 standard-input
2826 standard-output
2827 unread-command-events))
2829 ;; Safe local variables:
2830 ;;
2831 ;; For variables defined by major modes, the safety declarations can go into
2832 ;; the major mode's file, since that will be loaded before file variables are
2833 ;; processed.
2834 ;;
2835 ;; For variables defined by minor modes, put the safety declarations in the
2836 ;; file defining the minor mode after the defcustom/defvar using an autoload
2837 ;; cookie, e.g.:
2838 ;;
2839 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2840 ;;
2841 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2842 ;; minor mode file may not be loaded yet.
2843 ;;
2844 ;; For variables defined in the C source code the declaration should go here:
2866 "Alist of file-local variable settings in the current buffer.
2867 Each element in this list has the form (VAR . VALUE), where VAR
2868 is a file-local variable (a symbol) and VALUE is the value
2869 specified. The actual value in the buffer may differ from VALUE,
2875 "Alist of directory-local variable settings in the current buffer.
2876 Each element in this list has the form (VAR . VALUE), where VAR
2877 is a directory-local variable (a symbol) and VALUE is the value
2878 specified in .dir-locals.el. The actual value in the buffer
2879 may differ from VALUE, if it is changed by the major or minor modes,
2884 "Normal hook run before setting file-local variables.
2885 It is called after checking for unsafe/risky variables and
2886 setting `file-local-variables-alist', and before applying the
2887 variables stored in `file-local-variables-alist'. A hook
2888 function is allowed to change the contents of this alist.
2890 This hook is called only if there is at least one file-local
2894 "Get confirmation before setting up local variable values.
2895 ALL-VARS is the list of all variables to be set up.
2896 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2897 RISKY-VARS is the list of those that are marked as risky.
2898 If these settings come from directory-local variables, then
2899 DIR-NAME is the name of the associated directory. Otherwise it is nil."
2901 nil
2908 unsafe-vars))
2912 prompt char)
2920 ", and variables that are risky (**)."
2928 y -- to apply the local variables list.
2932 ! -- to apply the local variables list, and permanently mark these
2944 ;; Make strings with embedded whitespace easier to read.
2952 ""
2969 "Return local variables specified in the -*- line.
2970 Returns an alist of elements (VAR . VAL), where VAR is a variable
2971 and VAL is the specified value. Ignores any specification for
2972 `mode:' and `coding:' (which should have already been handled
2973 by `set-auto-mode' and `set-auto-coding', respectively).
2974 Return nil if the -*- line is malformed.
2976 If MODE-ONLY is non-nil, just returns the symbol specifying the
2977 mode, if there is one, otherwise nil."
2982 result)
2984 nil)
2986 ;; Simple form: "-*- MODENAME -*-".
2990 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2991 ;; (last ";" is optional).
2992 ;; If MODE-ONLY, just check for `mode'.
2993 ;; Otherwise, parse the -*- line into the RESULT alist.
3001 ;; There used to be a downcase here,
3002 ;; but the manual didn't say so,
3003 ;; and people want to set var names that aren't all lc.
3009 ;; It is traditional to ignore
3010 ;; case when checking for `mode' in set-auto-mode,
3011 ;; so we must do that here as well.
3012 ;; That is inconsistent, but we're stuck with it.
3013 ;; The same can be said for `coding' in set-auto-coding.
3023 ;; Downcase "Mode:".
3029 result))))))
3032 "Filter local variable settings, querying the user if necessary.
3033 VARIABLES is the alist of variable-value settings. This alist is
3034 filtered based on the values of `ignored-local-variables',
3035 `enable-local-eval', `enable-local-variables', and (if necessary)
3036 user interaction. The results are added to
3037 `file-local-variables-alist', without applying them.
3038 If these settings come from directory-local variables, then
3039 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3040 ;; Find those variables that we may want to save to
3041 ;; `safe-local-variable-values'.
3047 ;; Ignore any variable in `ignored-local-variables'.
3048 nil)
3049 ;; Obey `enable-local-eval'.
3057 ;; Ignore duplicates (except `mode') in the present list.
3059 ;; Accept known-safe variables.
3063 ;; The variable is either risky or unsafe:
3070 ;; Query, unless all vars are safe or user wants no querying.
3076 risky-vars dir-name))
3087 "Parse and put into effect this buffer's local variables spec.
3088 Uses `hack-local-variables-apply' to apply the variables.
3091 is specified, and return the corresponding mode symbol, or nil.
3092 In this case, we try to ignore minor-modes, and only return a
3093 major-mode."
3096 result)
3102 ;; If MODE-ONLY is non-nil, and the prop line specifies a mode,
3103 ;; then we're done, and have no need to scan further.
3105 mode-only)
3106 ;; Look for "Local variables:" line in last page.
3114 ;; suffix is what comes after "local variables:" in its line.
3115 ;; prefix is what comes before "local variables:" in its line.
3125 beg)
3129 endpos
3135 nil t))
3136 ;; This used to be an error, but really all it means is
3137 ;; that this may simply not be a local-variables section,
3138 ;; so just ignore it.
3148 ;; Discard the prefix.
3153 ;; Discard the suffix.
3163 ;; Find the variable name; strip whitespace.
3172 val val2)
3175 ;; Read the variable value.
3182 ;; Specifying minor-modes via mode: is
3183 ;; deprecated, but try to reject them anyway.
3191 'eval
3196 ;; Now we've read all the local variables.
3197 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3199 ;; Otherwise, set the variables.
3205 "Apply the elements of `file-local-variables-alist'.
3206 If there are any elements, runs `before-hack-local-variables-hook',
3207 then calls `hack-one-local-variable' to apply the alist elements one by one.
3208 Finishes by running `hack-local-variables-hook', regardless of whether
3209 the alist is empty or not.
3211 Note that this function ignores a `mode' entry if it specifies the same
3212 major mode as the buffer already has."
3214 ;; Any 'evals must run in the Right sequence.
3223 "Non-nil if SYM is safe as a file-local variable with value VAL.
3224 It is safe if any of these conditions are met:
3226 * There is a matching entry (SYM . VAL) in the
3227 `safe-local-variable-values' user option.
3229 * The `safe-local-variable' property of SYM is a function that
3230 evaluates to a non-nil value with VAL as an argument."
3234 ;; If the function signals an error, that means it
3235 ;; can't assure us that the value is safe.
3239 "Non-nil if SYM could be dangerous as a file-local variable.
3240 It is dangerous if either of these conditions are met:
3242 * Its `risky-local-variable' property is non-nil.
3248 ;; If this is an alias, check the base name.
3268 "Return t if it is safe to eval EXP when it is found in a file."
3270 ;; Detect certain `put' expressions.
3277 lisp-indent-function
3278 scheme-indent-function))
3279 ;; Only allow safe values (not functions).
3284 ;; Only allow indirect form specs.
3285 ;; During bootstrapping, edebug-basic-spec might not be
3286 ;; defined yet.
3290 ;; Allow expressions that the user requested.
3292 ;; Certain functions can be allowed with safe arguments
3293 ;; or can specify verification functions to try.
3295 ;; Allow (minor)-modes calls with no arguments.
3296 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3305 ok))
3313 ok))))))))
3316 "Set local variable VAR with value VAL.
3317 If VAR is `mode', call `VAL-mode' as a function unless it's
3318 already the major mode."
3325 ;; A minor mode must be passed an argument.
3326 ;; Otherwise, if the user enables the minor mode in a
3327 ;; major mode hook, this would toggle it off.
3333 ;; Make sure the string has no text properties.
3334 ;; Some text properties can get evaluated in various ways,
3335 ;; so it is risky to put them on with a local variable list.
3339 \f
3340 ;;; Handling directory-local variables, aka project settings.
3346 "List of cached directory roots for directory-local variable classes.
3347 Each element in this list has the form (DIR CLASS MTIME).
3348 DIR is the name of the directory.
3349 CLASS is the name of a variable class (a symbol).
3350 MTIME is the recorded modification time of the directory-local
3351 variables file associated with this entry. This time is a list
3352 of two integers (the same format as `file-attributes'), and is
3353 used to test whether the cache entry is still valid.
3354 Alternatively, MTIME can be nil, which means the entry is always
3358 "Return the variable list for CLASS."
3362 "Collect directory-local variables from MODE-VARIABLES.
3363 VARIABLES is the initial list of variables.
3364 Returns the new list."
3369 ;; If variables are specified more than once, only use the last. (Why?)
3370 ;; The pseudo-variables mode and eval are different (bug#3430).
3373 ;; Need a new cons in case we setcdr later.
3377 "Collect entries from CLASS-VARIABLES into VARIABLES.
3378 ROOT is the root directory of the project.
3379 Return the new variables list."
3382 ;; FIXME: Why not use file-relative-name?
3389 ;; Don't include this in the previous condition, because we
3390 ;; want to filter all strings before the next condition.
3404 ;; TODO someone might want to extend this to allow
3405 ;; integer values for subdir, where N means
3406 ;; variables apply to this directory and N levels
3407 ;; below it (0 == nil).
3410 alist variables))))))))
3412 ;; The file's content might be invalid (e.g. have a merge conflict), but
3413 ;; that shouldn't prevent the user from opening the file.
3415 nil))))
3418 "Declare that the DIRECTORY root is an instance of CLASS.
3419 DIRECTORY is the name of a directory, a string.
3420 CLASS is the name of a project class, a symbol.
3421 MTIME is either the modification time of the directory-local
3422 variables file that defined this class, or nil.
3424 When a file beneath DIRECTORY is visited, the mode-specific
3425 variables from CLASS are applied to the buffer. The variables
3426 for a class are defined using `dir-locals-set-class-variables'."
3433 "Map the type CLASS to a list of variable settings.
3434 CLASS is the project class, a symbol. VARIABLES is a list
3435 that declares directory-local variables for the class.
3436 An element in VARIABLES is either of the form:
3437 (MAJOR-MODE . ALIST)
3438 or
3439 (DIRECTORY . LIST)
3441 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3442 whose elements are of the form (VARIABLE . VALUE).
3444 In the second form, DIRECTORY is a directory name (a string), and
3445 LIST is a list of the form accepted by the function.
3447 When a file is visited, the file's class is found. A directory
3448 may be assigned a class using `dir-locals-set-directory-class'.
3449 Then variables are set in the file's buffer according to the
3450 class' LIST. The list is processed in order.
3452 * If the element is of the form (MAJOR-MODE . ALIST), and the
3453 buffer's major mode is derived from MAJOR-MODE (as determined
3454 by `derived-mode-p'), then all the variables in ALIST are
3455 applied. A MAJOR-MODE of nil may be used to match any buffer.
3456 `make-local-variable' is called for each variable before it is
3457 set.
3459 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3460 is an initial substring of the file's directory, then LIST is
3461 applied by recursively following these rules."
3468 "File that contains directory-local variables.
3469 It has to be constant to enforce uniform values
3473 "Find the directory-local variables for FILE.
3474 This searches upward in the directory tree from FILE.
3475 It stops at the first directory that has been registered in
3476 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3477 If it finds an entry in the cache, it checks that it is valid.
3478 A cache entry with no modification time element (normally, one that
3479 has been assigned directly using `dir-locals-set-directory-class', not
3480 set from a file) is always valid.
3481 A cache entry based on a `dir-locals-file' is valid if the modification
3482 time stored in the cache matches the current file modification time.
3483 If not, the cache entry is cleared so that the file will be re-read.
3485 This function returns either nil (no directory local variables found),
3486 or the matching entry from `dir-locals-directory-cache' (a list),
3487 or the full path to the `dir-locals-file' (a string) in the case
3488 of no valid cache entry."
3493 dir-locals-file))
3496 ;; `locate-dominating-file' may have abbreviated the name.
3499 ;; Find the best cached value in `dir-locals-directory-cache'.
3511 ;; Found a potential cache entry. Check validity.
3512 ;; A cache entry with no MTIME is assumed to always be valid
3513 ;; (ie, set directly, not from a dir-locals file).
3514 ;; Note, we don't bother to check that there is a matching class
3515 ;; element in dir-locals-class-alist, since that's done by
3516 ;; dir-locals-set-directory-class.
3523 ;; This cache entry is OK.
3524 dir-elt
3525 ;; This cache entry is invalid; clear it.
3528 ;; Return the first existing dir-locals file. Might be the same
3529 ;; as dir-elt's, might not (eg latter might have been deleted).
3530 locals-file)
3531 ;; No cache entry.
3532 locals-file)))
3535 "Load a variables FILE and register a new class and instance.
3536 FILE is the name of the file holding the variables to apply.
3537 The new class name is the same as the directory in which FILE
3538 is found. Returns the new class name."
3548 class-name)))
3551 "Read per-directory local variables for the current buffer.
3552 Store the directory-local variables in `dir-local-variables-alist'
3553 and `file-local-variables-alist', without applying them."
3556 ;; Find the variables file.
3580 "Apply directory-local variables to a non-file buffer.
3581 For non-file buffers, such as Dired buffers, directory-local
3582 variables are looked for in `default-directory' and its parent
3583 directories."
3587 \f
3590 However, the mode will not be changed if
3591 \(1) a local variables list or the `-*-' line specifies a major mode, or
3593 \ not suitable for ordinary files, or
3594 \(3) the new file name does not particularly specify any mode."
3599 "Change name of file visited in current buffer to FILENAME.
3600 This also renames the buffer to correspond to the new file.
3601 The next time the buffer is saved it will go in the newly specified file.
3602 FILENAME nil or an empty string means mark buffer as not visiting any file.
3603 Remember to delete the initial contents of the minibuffer
3604 if you wish to pass an empty string as the argument.
3606 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3607 confirmation in the case where another buffer is already visiting FILENAME.
3609 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3610 the old visited file has been renamed to the new name FILENAME."
3618 nil
3633 filename)))
3643 ;; If new-name == old-name, renaming would add a spurious <2>
3644 ;; and it's considered as a feature in rename-buffer.
3650 ;; Abbreviate the file names of the buffer.
3659 nil)))
3660 ;; write-file-functions is normally used for things like ftp-find-file
3661 ;; that visit things that are not local files as if they were files.
3662 ;; Changing to visit an ordinary local file instead should flush the hook.
3667 ;; If buffer was read-only because of version control,
3668 ;; that reason is gone now, so make it writable.
3672 ;; Turn off backup files for certain file names.
3673 ;; Since this is a permanent local, the major mode won't eliminate it.
3675 backup-enable-predicate
3681 ;; If auto-save was not already on, turn it on if appropriate.
3685 ;; If auto save is on, start using a new name.
3686 ;; We deliberately don't rename or delete the old auto save
3687 ;; for the old visited file name. This is because perhaps
3688 ;; the user wants to save the new state and then compare with the
3689 ;; previous state from the auto save file.
3692 ;; Rename the old auto save file if any.
3699 ;; Update the major mode, if the file name determines it.
3701 ;; Don't change the mode if it is special.
3704 ;; Don't change the mode if the local variable list specifies it.
3706 ;; TODO consider making normal-mode handle this case.
3714 "Write current buffer into file FILENAME.
3715 This makes the buffer visit that file, and marks it as not modified.
3717 If you specify just a directory name as FILENAME, that means to use
3718 the default file name but in that directory. You can also yank
3719 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3721 If the buffer is not already visiting a file, the default file name
3722 for the output file is the buffer name.
3724 If optional second arg CONFIRM is non-nil, this function
3725 asks for confirmation before overwriting an existing file.
3726 Interactively, confirmation is required unless you supply a prefix argument."
3727 ;; (interactive "FWrite file: ")
3731 nil nil nil nil)
3735 default-directory)
3736 nil nil))
3740 ;; If arg is just a directory,
3741 ;; use the default file name, but in that directory.
3752 ;; Make buffer writable if file is writable.
3757 ;; It's likely that the VC status at the new location is different from
3758 ;; the one at the old location.
3760 \f
3762 "Make a backup of the disk file visited by the current buffer, if appropriate.
3763 This is normally done before saving the buffer the first time.
3765 A backup may be done by renaming or by copying; see documentation of
3766 variable `make-backup-files'. If it's done by renaming, then the file is
3767 no longer accessible under its old name.
3769 The value is non-nil after a backup was made by renaming.
3770 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3771 MODES is the result of `file-modes' on the original
3772 file; this means that the caller, after saving the buffer, should change
3773 the modes of the new file to agree with the old modes.
3774 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3775 file; this means that the caller, after saving the buffer, should change
3776 the SELinux context of the new file to agree with the old context.
3777 BACKUPNAME is the backup file name, which is the old file renamed."
3784 backup-info backupname targets setmodes)
3785 ;; If specified name is a symbolic link, chase it to the target.
3786 ;; Thus we make the backups in the directory where the real file is.
3791 ;; (if (file-directory-p buffer-file-name)
3792 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3796 ;; If have old versions to maybe delete,
3797 ;; ask the user to confirm now, before doing anything.
3798 ;; But don't actually delete til later.
3803 real-file-name)))))
3806 ;; Actually write the back up file.
3809 ; (file-symlink-p buffer-file-name)
3810 backup-by-copying
3811 ;; Don't rename a suid or sgid file.
3826 ;; rename-file should delete old backup.
3830 ;; If trouble writing the backup, write it in
3831 ;; .emacs.d/%backup%.
3834 backupname)
3838 ;; Now delete the old versions, if desired.
3845 setmodes)
3852 ;; Create temp files with strict access rights. It's easy to
3853 ;; loosen them later, whereas it's impossible to close the
3854 ;; time-window of loose permissions otherwise.
3857 ;; Try to overwrite old backup first.
3865 nil)
3867 ;; The file was somehow created by someone else between
3868 ;; `delete-file' and `copy-file', so let's try again.
3869 ;; rms says "I think there is also a possible race
3870 ;; condition for making backup files" (emacs-devel 20070821).
3871 nil)))
3872 ;; Reset the umask.
3881 ;; The last ~[[:digit]]+ matches relative versions in git,
3882 ;; e.g. `foo.js.~HEAD~1~'.
3883 "Regular expression matching the backup/version part of a file name.
3887 "Return file NAME sans backup versions or strings.
3888 This is a separate procedure so your site-init or startup file can
3889 redefine it.
3890 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3891 we do not remove backup version numbers, only true file version numbers.
3892 See also `file-name-version-regexp'."
3899 name))))))
3902 "Return t if deleting FILE and rewriting it would preserve the owner."
3907 ;; Return t if the file doesn't exist, since it's true that no
3908 ;; information would be lost by an (attempted) delete and create.
3911 ;; Files created on Windows by Administrator (RID=500)
3912 ;; have the Administrators group (RID=544) recorded as
3913 ;; their owner. Rewriting them will still preserve the
3914 ;; owner.
3920 The extension, in a file name, is the part that follows the last `.',
3921 except that a leading `.', if any, doesn't count."
3924 directory)
3928 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3929 ;; we don't want to expand it.
3932 filename))))
3936 The extension, in a file name, is the part that follows the last `.',
3937 excluding version numbers and backup suffixes,
3938 except that a leading `.', if any, doesn't count.
3939 Return nil for extensionless file names such as `foo'.
3940 Return the empty string for file names such as `foo.'.
3942 If PERIOD is non-nil, then the returned value includes the period
3943 that delimits the extension, and if FILENAME has no extension,
3954 "A function to use instead of the default `make-backup-file-name'.
3955 A value of nil gives the default `make-backup-file-name' behavior.
3957 This could be buffer-local to do something special for specific
3958 files. If you define it, you may need to change `backup-file-name-p'
3959 and `file-name-sans-versions' too.
3961 See also `backup-directory-alist'."
3967 "Alist of filename patterns and backup directory names.
3968 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3969 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3970 relative or absolute. If it is absolute, so that all matching files
3971 are backed up into the same directory, the file names in this
3972 directory will be the full name of the file backed up with all
3973 directory separators changed to `!' to prevent clashes. This will not
3974 work correctly if your filesystem truncates the resulting name.
3976 For the common case of all backups going into one directory, the alist
3978 directory name.
3980 If this variable is nil, or it fails to match a filename, the backup
3981 is made in the original file's directory.
3983 On MS-DOS filesystems without long names this variable is always
3984 ignored."
3990 "Default `backup-enable-predicate' function.
3991 Checks for files in `temporary-file-directory',
3992 `small-temporary-file-directory', and /tmp."
3995 ;; Directory is under temporary-file-directory.
4000 ;; Directory is under /tmp.
4005 0 nil
4007 ;; Directory is under small-temporary-file-directory.
4012 "Create the non-numeric backup file name for FILE.
4013 Normally this will just be the file's name with `~' appended.
4014 Customization hooks are provided as follows.
4016 If the variable `make-backup-file-name-function' is non-nil, its value
4017 should be a function which will be called with FILE as its argument;
4018 the resulting name is used.
4020 Otherwise a match for FILE is sought in `backup-directory-alist'; see
4021 the documentation of that variable. If the directory for the backup
4022 doesn't exist, it is created."
4036 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
4038 elt backup-directory abs-backup-directory)
4043 alist nil)))
4044 ;; If backup-directory is relative, it should be relative to the
4045 ;; file's directory. By expanding explicitly here, we avoid
4046 ;; depending on default-directory.
4055 abs-backup-directory nil))))
4057 file
4061 ;; Normalize DOSish file names: downcase the drive
4062 ;; letter, if any, and replace the leading "x:" with
4063 ;; "/drive_x".
4066 ;; Replace any invalid file-name characters (for the
4067 ;; case of backing up remote files).
4071 "drive_"
4074 ""
4077 ;; Make the name unique by substituting directory
4078 ;; separators. It may not really be worth bothering about
4079 ;; doubling `!'s in the original name...
4084 backup-directory))
4089 "Return non-nil if FILE is a backup file name (numeric or not).
4090 This is a separate function so you can redefine it for customization.
4091 You may need to redefine `file-name-sans-versions' as well."
4096 ;; This is used in various files.
4097 ;; The usage of backup-extract-version-start is not very clean,
4098 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4100 "Given the name of a numeric backup file, FN, return the backup number.
4101 Uses the free variable `backup-extract-version-start', whose value should be
4102 the index in the name where the version number begins."
4109 "Find a file name for a backup file FN, and suggestions for deletions.
4110 Value is a list whose car is the name for the backup file
4111 and whose cdr is a list of old versions to consider deleting now.
4112 If the value is nil, don't make a backup.
4113 Uses `backup-directory-alist' in the same way as does
4114 `make-backup-file-name'."
4116 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4120 ;; We don't support numbered backups on plain MS-DOS
4121 ;; when long file names are unavailable.
4131 possibilities deserve-versions-p versions)
4134 base-versions
4137 possibilities)
4138 #'<)
4143 kept-old-versions
4144 kept-new-versions
4151 ;; Delete nothing if there is overflow
4152 ;; in the number of versions to keep.
4158 v))))))))))
4161 "Return number of names file FILENAME has."
4164 ;; (defun file-relative-name (filename &optional directory)
4165 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4166 ;; This function returns a relative file name which is equivalent to FILENAME
4167 ;; when used with that default directory as the default.
4168 ;; If this is impossible (which can happen on MSDOS and Windows
4169 ;; when the file name and directory use different drive names)
4170 ;; then it returns FILENAME."
4171 ;; (save-match-data
4172 ;; (let ((fname (expand-file-name filename)))
4173 ;; (setq directory (file-name-as-directory
4174 ;; (expand-file-name (or directory default-directory))))
4175 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4176 ;; ;; drive names, they can't be relative, so return the absolute name.
4177 ;; (if (and (or (eq system-type 'ms-dos)
4178 ;; (eq system-type 'cygwin)
4179 ;; (eq system-type 'windows-nt))
4180 ;; (not (string-equal (substring fname 0 2)
4181 ;; (substring directory 0 2))))
4182 ;; filename
4183 ;; (let ((ancestor ".")
4184 ;; (fname-dir (file-name-as-directory fname)))
4185 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4186 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4187 ;; (setq directory (file-name-directory (substring directory 0 -1))
4188 ;; ancestor (if (equal ancestor ".")
4189 ;; ".."
4190 ;; (concat "../" ancestor))))
4191 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4192 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4193 ;; ;; We matched within FNAME's directory part.
4194 ;; ;; Add the rest of FNAME onto ANCESTOR.
4195 ;; (let ((rest (substring fname (match-end 0))))
4196 ;; (if (and (equal ancestor ".")
4197 ;; (not (equal rest "")))
4198 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4199 ;; rest
4200 ;; (concat (file-name-as-directory ancestor) rest)))
4201 ;; ;; We matched FNAME's directory equivalent.
4202 ;; ancestor))))))
4205 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4206 This function returns a relative file name which is equivalent to FILENAME
4207 when used with that default directory as the default.
4208 If FILENAME and DIRECTORY lie on different machines or on different drives
4209 on a DOS/Windows machine, it returns FILENAME in expanded form."
4213 default-directory))))
4219 ;; Test for different filesystems on DOS/Windows
4221 ;; Should `cygwin' really be included here? --stef
4224 ;; Test for different drive letters
4226 ;; Test for UNCs on different servers
4231 ;; Windows file names cannot have ? in
4232 ;; them, so use that to detect when
4233 ;; neither FILENAME nor DIRECTORY is a
4234 ;; UNC.
4236 0 nil
4242 ;; Test for different remote file system identification
4244 filename
4250 directory nil nil case-fold-search))
4252 directory nil nil case-fold-search))))
4255 ".."
4257 ;; Now ancestor is empty, or .., or ../.., etc.
4259 directory nil nil case-fold-search))
4260 ;; We matched within FILENAME's directory part.
4261 ;; Add the rest of FILENAME onto ANCESTOR.
4264 ;; But don't bother with ANCESTOR if it would give us `./'.
4265 rest
4267 ;; We matched FILENAME's directory equivalent.
4268 ancestor))))))
4269 \f
4271 "Save current buffer in visited file if modified.
4272 Variations are described below.
4274 By default, makes the previous version into a backup file
4275 if previously requested or if this is the first save.
4277 to become a backup when the next save is done.
4279 unconditionally makes the previous version into a backup file.
4281 to become a backup when the next save is done,
4282 and unconditionally makes the previous version into a backup file.
4284 With a numeric argument of 0, never make the previous version
4285 into a backup file.
4287 If a file's name is FOO, the names of its numbered backup versions are
4288 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4289 Numeric backups (rather than FOO~) will be made if value of
4290 `version-control' is not the atom `never' and either there are already
4291 numeric versions of the file being backed up, or `version-control' is
4292 non-nil.
4293 We don't want excessive versions piling up, so there are variables
4294 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4295 and `kept-new-versions', which tells how many newest versions to keep.
4296 Defaults are 2 old versions and 2 new.
4297 `dired-kept-versions' controls dired's clean-directory (.) command.
4298 If `delete-old-versions' is nil, system will query user
4299 before trimming versions. Otherwise it does it silently.
4301 If `vc-make-backup-files' is nil, which is the default,
4302 no backup files are made for files managed by version control.
4303 (This is because the version control system itself records previous versions.)
4305 See the subroutine `basic-save-buffer' for more information."
4311 ;; We used to display the message below only for files > 50KB, but
4312 ;; then Rmail-mbox never displays it due to buffer swapping. If
4313 ;; the test is ever re-introduced, be sure to handle saving of
4314 ;; Rmail files.
4321 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4322 Normally delete only if the file was written by this Emacs since
4323 the last real save, but optional arg FORCE non-nil means delete anyway."
4337 "Normal hook that is run before a buffer is saved to its file."
4343 "Normal hook that is run after a buffer is saved to its file."
4349 "If non-nil, use this coding system for saving the buffer.
4350 More precisely, use this coding system in place of the
4351 value of `buffer-file-coding-system', when saving the buffer.
4352 Calling `write-region' for any purpose other than saving the buffer
4353 will still use `buffer-file-coding-system'; this variable has no effect
4360 "Save the current buffer in its visited file, if it has been modified.
4361 The hooks `write-contents-functions' and `write-file-functions' get a chance
4362 to do the job of saving; if they do not, then the buffer is saved in
4363 the visited file in the usual way.
4364 Before and after saving the buffer, this function runs
4365 `before-save-hook' and `after-save-hook', respectively."
4368 ;; In an indirect buffer, save its base buffer instead.
4372 ;; handle the case when no modification has been made but
4373 ;; the file disappeared since visited
4377 setmodes)
4378 ;; If buffer has no file name, ask user for one.
4385 ;; Signal an error if the user specified the name of an
4386 ;; existing directory.
4389 filename))
4391 ;; Signal an error if the specified name refers to a
4392 ;; non-existing directory.
4403 "%s has changed since visited or saved. Save anyway? "
4423 ;; Support VC version backups.
4429 ;; If a hook returned t, file is already "written".
4430 ;; Otherwise, write it the usual way now.
4432 ;; Now we have saved the current buffer. Let's make sure
4433 ;; that buffer-file-coding-system is fixed to what
4434 ;; actually used for saving by binding it locally.
4446 ;; If the auto-save file was recent before this command,
4447 ;; delete it now.
4449 ;; Support VC `implicit' locking.
4454 ;; This does the "real job" of writing a buffer into its visited file
4455 ;; and making a backup file. This is what is normally done
4456 ;; but inhibited if one of write-file-functions returns non-nil.
4457 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4469 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4482 "File %s is write-protected; try to save anyway? "
4484 buffer-file-name)))
4499 ;; Write temp name, then rename it.
4500 ;; This requires write access to the containing dir,
4501 ;; which is why we don't try it if we don't have that access.
4503 tempname succeed
4506 ;; Create temp files with strict access rights. It's easy to
4507 ;; loosen them later, whereas it's impossible to close the
4508 ;; time-window of loose permissions otherwise.
4513 ;; Try various temporary names.
4514 ;; This code follows the example of make-temp-file,
4515 ;; but it calls write-region in the appropriate way
4516 ;; for saving the buffer.
4522 ;; Pass in nil&nil rather than point-min&max
4523 ;; cause we're saving the whole buffer.
4524 ;; write-region-annotate-functions may use it.
4526 tempname nil realname
4528 nil)
4530 ;; The file was somehow created by someone else between
4531 ;; `make-temp-name' and `write-region', let's try again.
4532 nil)
4534 ;; Reset the umask.
4536 ;; If we failed, restore the buffer's modtime.
4539 ;; Since we have created an entirely new file,
4540 ;; make sure it gets the right permission bits set.
4545 buffer-file-name)))
4546 ;; We succeeded in writing the temp file,
4547 ;; so rename it.
4549 ;; If file not writable, see if we can make it writable
4550 ;; temporarily while we write it.
4551 ;; But no need to do so if we have just backed it up
4552 ;; (setmodes is set) because that says we're superseding.
4554 ;; Change the mode back, after writing.
4557 buffer-file-name))
4563 ;; Pass in nil&nil rather than point-min&max to indicate
4564 ;; we're saving the buffer rather than just a region.
4565 ;; write-region-annotate-functions may make us of it.
4567 buffer-file-name nil t buffer-file-truename)
4569 ;; If we get an error writing the new file, and we made
4570 ;; the backup by renaming, undo the backing-up.
4575 setmodes))
4581 `((?\C-r
4588 ;; Return nil to ask about BUF again.
4589 nil)
4602 ;; Return nil to ask about BUF again.
4603 nil)
4613 "Save some modified file-visiting buffers. Asks user about each one.
4614 You can answer `y' to save, `n' not to save, `C-r' to look at the
4615 buffer in question with `view-buffer' before deciding or `d' to
4616 view the differences using `diff-buffer-with-file'.
4618 This command first saves any buffers where `buffer-save-without-query' is
4619 non-nil, without asking.
4621 Optional argument (the prefix) non-nil means save all with no questions.
4622 Optional second argument PRED determines which buffers are considered:
4623 If PRED is nil, all the file-visiting buffers are considered.
4624 If PRED is t, then certain non-file buffers will also be considered.
4625 If PRED is a zero-argument function, it indicates for each buffer whether
4626 to consider it or not when called with that buffer current.
4628 See `save-some-buffers-action-alist' if you want to
4629 change the additional actions you can take on files."
4633 files-done abbrevs-done)
4635 ;; First save any buffers that we're supposed to save unconditionally.
4636 ;; That way the following code won't ask about them.
4641 ;; Ask about those buffers that merit it,
4642 ;; and record the number thus saved.
4646 ;; Note that killing some buffers may kill others via
4647 ;; hooks (e.g. Rmail and its viewing buffer).
4660 t
4672 save-some-buffers-action-alist))
4673 ;; Maybe to save abbrevs, and record whether
4674 ;; we either saved them or asked to.
4681 ;; Don't keep bothering user if he says no.
4694 \f
4696 "Mark current buffer as unmodified, not needing to be saved.
4699 It is not a good idea to use this function in Lisp programs, because it
4700 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4707 "Change whether this buffer is read-only.
4708 With prefix argument ARG, make the buffer read-only if ARG is
4709 positive, otherwise make it writable. If buffer is read-only
4710 and `view-read-only' is non-nil, enter view mode.
4712 This function is usually the wrong thing to use in a Lisp program.
4713 It can have side-effects beyond changing the read-only status of a buffer
4714 \(e.g., enabling view mode), and does not affect read-only regions that
4715 are caused by text properties. To make a buffer read-only in Lisp code,
4716 set `buffer-read-only'. To ignore read-only status (whether due to text
4717 properties or buffer state) and make changes, temporarily bind
4718 `inhibit-read-only'."
4723 nil ; do nothing.
4724 ;; Toggle.
4731 ;; If view-mode is already active, `view-mode-enter' is a nop.
4739 "Insert contents of file FILENAME into buffer after point.
4740 Set mark after the inserted text.
4742 This function is meant for the user to run interactively.
4743 Don't call it from programs! Use `insert-file-contents' instead.
4744 \(Its calling sequence is different; see its documentation)."
4749 "Append the contents of the region to the end of file FILENAME.
4750 When called from a function, expects three arguments,
4751 START, END and FILENAME. START and END are normally buffer positions
4752 specifying the part of the buffer to write.
4753 If START is nil, that means to use the entire buffer contents.
4754 If START is a string, then output that string to the file
4755 instead of any buffer contents; END is ignored.
4757 This does character code conversion and applies annotations
4758 like `write-region' does."
4763 "Return most recent backup file for FILENAME or nil if no backups exist."
4764 ;; `make-backup-file-name' will get us the right directory for
4765 ;; ordinary or numeric backups. It might create a directory for
4766 ;; backups as a side-effect, according to `backup-directory-alist'.
4773 tem)
4782 newest))
4785 "Rename current buffer to a similar name not already taken.
4786 This function is useful for creating multiple shell process buffers
4787 or multiple mail buffers, etc."
4795 ;; If the existing buffer name has a <NNN>,
4796 ;; which isn't part of the file name (if any),
4797 ;; then get rid of that.
4803 "Create the directory DIR and optionally any nonexistent parent dirs.
4804 If DIR already exists as a directory, signal an error, unless
4805 PARENTS is non-nil.
4807 Interactively, the default choice of directory to create is the
4808 current buffer's default directory. That is useful when you have
4809 visited a file in a nonexistent directory.
4811 Noninteractively, the second (optional) argument PARENTS, if
4812 non-nil, says whether to create parent directories that don't
4813 exist. Interactively, this happens by default.
4815 If creating the directory or directories fail, an error will be
4816 raised."
4819 nil nil)
4820 t))
4821 ;; If default-directory is a remote directory,
4822 ;; make sure we find its make-directory handler.
4830 create-list)
4832 ;; If directory is its own parent, then we can't
4833 ;; keep looping forever
4848 "Delete the directory named DIRECTORY. Does not follow symlinks.
4849 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4850 TRASH non-nil means to trash the directory instead, provided
4851 `delete-by-moving-to-trash' is non-nil.
4853 When called interactively, TRASH is t if no prefix argument is
4854 given. With a prefix argument, TRASH is nil."
4861 "Move directory to trash: "
4863 default-directory default-directory nil nil))))
4869 nil)
4871 ;; If default-directory is a remote directory, make sure we find its
4872 ;; delete-directory handler.
4879 ;; Only move non-empty dir to trash if recursive deletion was
4880 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4881 ;; case, where the operation fails in delete-directory-internal.
4882 ;; As `move-file-to-trash' trashes directories (empty or
4883 ;; otherwise) as a unit, we do not need to recurse here.
4885 ;; Check if directory is empty apart from "." and "..".
4890 ;; Otherwise, call ourselves recursively if needed.
4894 ;; This test is equivalent to
4895 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4896 ;; but more efficient
4900 ;; We do not want to delete "." and "..".
4906 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4907 This function always sets the file modes of the output files to match
4908 the corresponding input file.
4910 The third arg KEEP-TIME non-nil means give the output files the same
4911 last-modified time as the old ones. (This works on only some systems.)
4913 A prefix arg makes KEEP-TIME non-nil.
4915 Noninteractively, the last argument PARENTS says whether to
4916 create parent directories if they don't exist. Interactively,
4917 this happens by default.
4919 If NEWNAME names an existing directory, copy DIRECTORY as a
4920 subdirectory there. However, if called from Lisp with a non-nil
4921 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
4922 directly into NEWNAME instead."
4929 default-directory default-directory nil nil)
4930 current-prefix-arg t nil)))
4931 ;; If default-directory is a remote directory, make sure we find its
4932 ;; copy-directory handler.
4938 ;; Compute target name.
4943 ;; If NEWNAME is not an existing directory, create it;
4944 ;; that is where we will copy the files of DIRECTORY.
4946 ;; If NEWNAME is an existing directory and COPY-CONTENTS
4947 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
4952 newname))
4956 newname))
4959 ;; Copy recursively.
4961 ;; We do not want to copy "." and "..".
4963 directory-files-no-dot-files-regexp))
4972 ;; Set directory attributes.
4977 \f
4980 "Function to use to revert this buffer, or nil to do the default.
4981 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4986 "Function to use to insert contents when reverting this buffer.
4987 Gets two args, first the nominal file name to use,
4988 and second, t if reading the auto-save file.
4993 "Function to check whether a non-file buffer needs reverting.
4994 This should be a function with one optional argument NOCONFIRM.
4995 Auto Revert Mode passes t for NOCONFIRM. The function should return
4996 non-nil if the buffer should be reverted. A return value of
4997 `fast' means that the need for reverting was not checked, but
4998 that reverting the buffer is fast. The buffer is current when
4999 this function is called.
5001 The idea behind the NOCONFIRM argument is that it should be
5002 non-nil if the buffer is going to be reverted without asking the
5003 user. In such situations, one has to be careful with potentially
5004 time consuming operations.
5006 For more information on how this variable is used by Auto Revert mode,
5010 "Normal hook for `revert-buffer' to run before reverting.
5011 If `revert-buffer-function' is used to override the normal revert
5015 "Normal hook for `revert-buffer' to run after reverting.
5016 Note that the hook value that it runs is the value that was in effect
5017 before reverting; that makes a difference if you have buffer-local
5018 hook functions.
5020 If `revert-buffer-function' is used to override the normal revert
5024 "Non-nil if a `revert-buffer' operation is in progress, nil otherwise.
5030 "Replace current buffer text with the text of the visited file on disk.
5031 This undoes all changes since the file was visited or saved.
5032 With a prefix argument, offer to revert from latest auto-save file, if
5033 that is more recent than the visited file.
5035 This command also implements an interface for special buffers
5036 that contain text which doesn't come from a file, but reflects
5037 some other data instead (e.g. Dired buffers, `buffer-list'
5038 buffers). This is done via the variable `revert-buffer-function'.
5039 In these cases, it should reconstruct the buffer contents from the
5040 appropriate data.
5042 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5043 to revert from the auto-save file when this is nil. Note that the
5044 sense of this argument is the reverse of the prefix argument, for the
5045 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5046 to nil.
5048 Optional second argument NOCONFIRM means don't ask for confirmation
5049 at all. (The variable `revert-without-query' offers another way to
5050 revert buffers without querying for confirmation.)
5052 Optional third argument PRESERVE-MODES non-nil means don't alter
5053 the files modes. Normally we reinitialize them using `normal-mode'.
5055 If the value of `revert-buffer-function' is non-nil, it is called to
5056 do all the work for this command. Otherwise, the hooks
5057 `before-revert-hook' and `after-revert-hook' are run at the beginning
5058 and the end, and if `revert-buffer-insert-file-contents-function' is
5059 non-nil, it is called instead of rereading visited file contents."
5061 ;; I admit it's odd to reverse the sense of the prefix argument, but
5062 ;; there is a lot of code out there which assumes that the first
5063 ;; argument should be t to avoid consulting the auto-save file, and
5064 ;; there's no straightforward way to encourage authors to notice a
5065 ;; reversal of the argument sense. So I'm just changing the user
5066 ;; interface, but leaving the programmatic interface the same.
5076 buffer-auto-save-file-name
5081 buffer-auto-save-file-name
5082 buffer-file-name)))
5092 file-name)))
5094 ;; If file was backed up but has changed since,
5095 ;; we should make another backup.
5099 ;; Effectively copy the after-revert-hook status,
5100 ;; since after-find-file will clobber it.
5103 after-revert-hook))
5108 ;; Get rid of all undo records for this buffer.
5110 ;; Don't make undo records for the reversion.
5113 file-name auto-save-p)))
5116 "File %s no longer exists!"
5118 file-name))
5121 "File %s no longer readable!"
5123 file-name))
5125 ;; Bind buffer-file-name to nil
5126 ;; so that we don't try to lock the file.
5132 ;; Auto-saved file should be read by Emacs'
5133 ;; internal coding.
5137 buffer-file-coding-system-explicit
5140 coding-system-for-read
5142 coding-system-for-read)
5144 ;; As a coding system suitable for multibyte
5145 ;; buffer is specified, make the current
5146 ;; buffer multibyte.
5149 ;; This force after-insert-file-set-coding
5150 ;; (called from insert-file-contents) to set
5151 ;; buffer-file-coding-system to a proper value.
5154 ;; Note that this preserves point in an intelligent way.
5158 nil nil t))
5160 nil nil t)))))
5161 ;; Recompute the truename in case changes in symlinks
5162 ;; have changed the truename.
5166 ;; Run after-revert-hook as it was before we reverted.
5170 local-hook)
5173 t))))))
5176 "Recover the visited file--get contents from its last auto-save file."
5181 "Visit file FILE, but get contents from its last auto-save file."
5182 ;; Actually putting the file name in the minibuffer should be used
5183 ;; only rarely.
5184 ;; Not just because users often use the default.
5204 ;; Use insert-directory-safely, not insert-directory,
5205 ;; because these files might not exist. In particular,
5206 ;; FILE might not exist if the auto-save file was for
5207 ;; a buffer that didn't visit a file, such as "*mail*".
5208 ;; The code in v20.x called `ls' directly, so we need
5209 ;; to emulate what `ls' did in that case.
5215 ;; Keep the current buffer-file-coding-system.
5217 ;; Auto-saved file should be read with special coding.
5226 "Recover auto save files from a previous Emacs session.
5227 This command first displays a Dired buffer showing you the
5228 previous sessions that you could recover from.
5229 To choose one, move point to the proper line and then type C-c C-c.
5230 Then you'll be asked about a number of files to recover."
5240 auto-save-list-file-prefix)))
5241 t)
5250 ;; Each line starts with a space
5251 ;; so that Font Lock mode won't highlight the first character.
5260 "Choose one saved session to recover auto-save files from.
5261 This command is used in the special Dired buffer created by
5264 ;; Get the name of the session file to recover from.
5266 files
5272 ;; Read in the auto-save-list file.
5275 ;; Loop thru the text of that file
5276 ;; and get out the names of the files to recover.
5280 ;; This is a pair of lines for a non-file-visiting buffer.
5281 ;; Get the auto-save file name and manufacture
5282 ;; a "visited file name" from that.
5285 ;; If there is no auto-save file name, the
5286 ;; auto-save-list file is probably corrupted.
5299 ;; This pair of lines is a file-visiting
5300 ;; buffer. Use the visited file name.
5310 ;; Ignore a file if its auto-save file does not exist now.
5314 ;; The file contains a pair of line for each auto-saved buffer.
5315 ;; The first line of the pair contains the visited file name
5316 ;; or is empty if the buffer was not visiting a file.
5317 ;; The second line is the auto-save file name.
5325 files
5331 "Kill BUFFER if confirmed."
5339 "Kill some buffers. Asks the user whether to kill each one of them.
5340 Non-interactively, if optional argument LIST is non-nil, it
5341 specifies the list of buffers to kill, asking for approval for each one."
5349 ; if we killed the base buffer.
5356 "Kill buffers whose name matches the specified REGEXP.
5357 The optional second argument indicates whether to kill internal buffers too."
5366 \f
5368 "Adjust current buffer's auto save file name for current conditions.
5369 Also rename any existing auto save file, if it was made in this session."
5381 "Return file name to use for auto-saves of current buffer.
5382 Does not consider `auto-save-visited-file-name' as that variable is checked
5383 before calling this function. You can redefine this for customization.
5384 See also `auto-save-file-name-p'."
5392 result uniq)
5393 ;; Apply user-specified translations
5394 ;; to the file name.
5398 filename)
5408 filename))))
5413 ;; We truncate the file name to DOS 8+3 limits
5414 ;; before doing anything else, because the regexp
5415 ;; passed to string-match below cannot handle
5416 ;; extensions longer than 3 characters, multiple
5417 ;; dots, and other atrocities.
5422 fn)
5427 "#"
5430 ;; Make sure auto-save file names don't contain characters
5431 ;; invalid for the underlying filesystem.
5433 ;; Don't modify remote (ange-ftp) filenames
5436 result))))
5438 ;; Deal with buffers that don't have any associated files. (Mail
5439 ;; mode tends to create a good number of these.)
5443 file-name)
5444 ;; Restrict the characters used in the file name to those which
5445 ;; are known to be safe on all filesystems, url-encoding the
5446 ;; rest.
5447 ;; We do this on all platforms, because even if we are not
5448 ;; running on DOS/Windows, the current directory may be on a
5449 ;; mounted VFAT filesystem, such as a USB memory stick.
5453 ;; For multibyte characters, this will produce more than
5454 ;; 2 hex digits, so is not true URL encoding.
5458 ;; Generate the file name.
5464 ;; Try a few alternative directories, to get one we can
5465 ;; write it.
5471 ;; Don't modify remote (ange-ftp) filenames
5473 ;; The call to convert-standard-filename is in case
5474 ;; buffer-name includes characters not allowed by the
5475 ;; DOS/Windows filesystems. make-temp-file writes to the
5476 ;; file it creates, so we must fix the file name _before_
5477 ;; make-temp-file is called.
5479 fname))
5481 ;; make-temp-file creates the file,
5482 ;; but we don't want it to exist until we do an auto-save.
5486 file-name)))
5489 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5490 FILENAME should lack slashes. You can redefine this for customization."
5492 \f
5494 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5495 The generated regexp will match a filename only if the filename
5496 matches that wildcard according to shell rules. Only wildcards known
5497 by `sh' are supported."
5499 ;; Copy the initial run of non-special characters.
5502 ;; If no special characters, we're almost done.
5506 j)
5508 result
5529 ;; Found "[^". Insert a `\0' character
5530 ;; (which cannot happen in a filename)
5531 ;; into the character class, so that `^'
5532 ;; is not the first character after `[',
5533 ;; and thus non-special in a regexp.
5538 ;; I don't think `]' can appear in a
5539 ;; character class in a wildcard, but
5540 ;; let's be general here.
5547 i
5560 ;; Shell wildcards should match the entire filename,
5561 ;; not its part. Make the regexp say so.
5563 \f
5566 "Switches for `list-directory' to pass to `ls' for brief listing."
5572 "Switches for `list-directory' to pass to `ls' for verbose listing."
5577 "Expand wildcard pattern PATTERN.
5578 This returns a list of file names which match the pattern.
5580 If PATTERN is written as an absolute file name,
5581 the values are absolute also.
5583 If PATTERN is written as a relative file name, it is interpreted
5584 relative to the current default directory, `default-directory'.
5585 The file names returned are normally also relative to the current
5586 default directory. However, if FULL is non-nil, they are absolute."
5590 ;; A list of all dirs that DIRPART specifies.
5591 ;; This can be more than one dir
5592 ;; if DIRPART contains wildcards.
5596 dirpart)))
5600 contents)
5606 ;; Filter out "." and ".."
5611 name))
5618 this-dir-contents)
5619 this-dir-contents)
5620 contents))))
5622 contents)))
5624 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5628 "Display a list of files in or matching DIRNAME, a la `ls'.
5629 DIRNAME is globbed by the shell if necessary.
5630 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5631 Actions controlled by variables `list-directory-brief-switches'
5632 and `list-directory-verbose-switches'."
5636 nil default-directory nil)
5637 pfx)))
5639 list-directory-brief-switches))
5640 buffer)
5652 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5660 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5662 PATTERN is assumed to represent a file-name wildcard suitable for the
5663 underlying filesystem. For Unix and GNU/Linux, each character from the
5665 the parts of the pattern which don't include wildcard characters are
5666 quoted with double quotes.
5669 on Windows), so PATTERN can use them to quote wildcard characters that
5670 need to be passed verbatim to shell commands."
5674 ;; DOS/Windows don't allow `"' in file names. So if the
5675 ;; argument has quotes, we can safely assume it is already
5676 ;; quoted by the caller.
5678 ;; We quote [&()#$'] in case their shell is a port of a
5679 ;; Unixy shell. We quote [,=+] because stock DOS and
5680 ;; Windows shells require that in some cases, such as
5681 ;; passing arguments to batch files that use positional
5682 ;; arguments like %1.
5684 pattern
5687 end)
5704 pattern))))
5711 "Program to get the amount of free space on a file system.
5712 We assume the output has the format of `df'.
5713 The value of this variable must be just a command name or file name;
5714 if you want to specify options, use `directory-free-space-args'.
5716 A value of nil disables this feature.
5718 If the function `file-system-info' is defined, it is always used in
5719 preference to the program given by this variable."
5725 "Options to use when running `directory-free-space-program'."
5730 "Return the amount of free space on directory DIR's file system.
5731 The return value is a string describing the amount of free
5732 space (normally, the number of free 1KB blocks).
5734 This function calls `file-system-info' if it is available, or
5735 invokes the program specified by `directory-free-space-program'
5736 and `directory-free-space-args'. If the system call or program
5737 is unsuccessful, or if DIR is a remote directory, this function
5738 returns nil."
5740 ;; Try to find the number of free blocks. Non-Posix systems don't
5741 ;; always have df, but might have an equivalent system call.
5750 ;; Avoid failure if the default directory does
5751 ;; not exist (Bug#2631, Bug#3911).
5754 nil t nil
5755 directory-free-space-args
5756 dir)
5758 ;; Assume that the "available" column is before the
5759 ;; "capacity" column. Find the "%" and scan backward.
5763 "[[:space:]]+[^[:space:]]+%[^%]*$"
5770 ;; The following expression replaces `dired-move-to-filename-regexp'.
5774 ;; In some locales, month abbreviations are as short as 2 letters,
5775 ;; and they can be followed by ".".
5776 ;; In Breton, a month name can include a quote character.
5789 s "+"
5792 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5793 ;; omits the Kanji characters after month and day-of-month.
5794 ;; On Mac OS X 10.3, the date format in East Asian locales is
5795 ;; day-of-month digits followed by month digits.
5801 ;; The "[0-9]" below requires the previous column to end in a digit.
5802 ;; This avoids recognizing `1 may 1997' as a date in the line:
5803 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5805 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5807 ;; For non-iso date formats, we add the ".*" in order to find
5808 ;; the last possible match. This avoids recognizing
5809 ;; `jservice 10 1024' as a date in the line:
5810 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5812 ;; vc dired listings provide the state or blanks between file
5813 ;; permissions and date. The state is always surrounded by
5814 ;; parentheses:
5815 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5816 ;; This is not supported yet.
5821 "Regular expression to match up to the file name in a directory listing.
5822 The default value is designed to recognize dates and times
5827 ;; insert-directory
5828 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5829 ;; FULL-DIRECTORY-P is nil.
5830 ;; The single line of output must display FILE's name as it was
5831 ;; given, namely, an absolute path name.
5832 ;; - must insert exactly one line for each file if WILDCARD or
5833 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5834 ;; before the file lines, plus optional text after the file lines.
5835 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5836 ;; allowed.
5837 ;; File lines should display the basename.
5838 ;; - must be consistent with
5839 ;; - functions dired-move-to-filename, (these two define what a file line is)
5840 ;; dired-move-to-end-of-filename,
5841 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5842 ;; dired-insert-headerline
5843 ;; dired-after-subdir-garbage (defines what a "total" line is)
5844 ;; - variable dired-subdir-regexp
5845 ;; - may be passed "--dired" as the first argument in SWITCHES.
5846 ;; Filename handlers might have to remove this switch if their
5847 ;; "ls" command does not support it.
5849 "Insert directory listing for FILE, formatted according to SWITCHES.
5850 Leaves point after the inserted text.
5851 SWITCHES may be a string of options, or a list of strings
5852 representing individual options.
5853 Optional third arg WILDCARD means treat FILE as shell wildcard.
5854 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5855 switches do not contain `d', so that a full listing is expected.
5857 This works by running a directory listing program
5858 whose name is in the variable `insert-directory-program'.
5859 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5861 When SWITCHES contains the long `--dired' option, this function
5862 treats it specially, for the sake of dired. However, the
5863 normally equivalent short `-D' option is just passed on to
5864 `insert-directory-program', as any other option."
5865 ;; We need the directory in order to find the right handler.
5870 wildcard full-directory-p)
5873 ;; Read the actual directory using `insert-directory-program'.
5874 ;; RESULT gets the status code.
5876 ;; putting text property `dired-filename, decode one
5877 ;; bunch by one to preserve that property.
5879 ;; This is to control encoding the arguments in call-process.
5883 default-file-name-coding-system))))
5886 ;; Run ls in the directory part of the file pattern
5887 ;; using the last component as argument.
5893 ;; NB since switches is passed to the shell, be
5894 ;; careful of malicious values, eg "-l;reboot".
5895 ;; See eg dired-safe-switches-p.
5897 shell-file-name nil t nil
5898 "-c"
5900 ""
5902 insert-directory-program
5903 " -d "
5905 switches
5907 " -- "
5908 ;; Quote some characters that have
5909 ;; special meanings in shells; but
5910 ;; don't quote the wildcards--we want
5911 ;; them to be special. We also
5912 ;; currently don't quote the quoting
5913 ;; characters in case people want to
5914 ;; use them explicitly to quote
5915 ;; wildcard characters.
5917 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5918 ;; directory if FILE is a symbolic link.
5925 insert-directory-program nil t nil
5929 ;; Split the switches at any spaces so we can
5930 ;; pass separate options as separate args.
5932 ;; Avoid lossage if FILE starts with `-'.
5940 file))))))))
5942 ;; If we got "//DIRED//" in the output, it means we got a real
5943 ;; directory listing, even if `ls' returned nonzero.
5944 ;; So ignore any errors.
5957 ;; The first time ls returns an error,
5958 ;; find the version numbers of ls,
5959 ;; and set insert-directory-ls-version
5960 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5961 ;; is equal or if the info cannot be obtained.
5962 ;; (That can mean it isn't GNU ls.)
5972 comparison)
5988 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5992 ;; If `insert-directory-program' failed, signal an error.
5994 ;; Delete the error message it may have output.
5996 ;; On non-Posix systems, we cannot open a directory, so
5997 ;; don't even try, because that will always result in
5998 ;; the ubiquitous "Access denied". Instead, show the
5999 ;; command line so the user can try to guess what went wrong.
6004 insert-directory-program
6006 file result)
6007 ;; Unix. Access the file to get a suitable error.
6014 ;; The following overshoots by one line for an empty
6015 ;; directory listed with "--dired", but without "-a"
6016 ;; switch, where the ls output contains a
6017 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6018 ;; We take care of that case later.
6026 error-lines)
6027 ;; Find all the lines that are error messages,
6028 ;; and record the bounds of each one.
6035 ;; Now read the numeric positions of file names.
6042 error-lines))
6045 error-lines)))
6047 ;; End is followed by \n or by " -> ".
6049 ;; It seems that we can't trust ls's output as to
6050 ;; byte positions of filenames.
6056 ;; Take care of the case where the ls output contains a
6057 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6058 ;; and we went one line too far back (see above).
6063 ;; Now decode what read if necessary.
6065 file-name-coding-system
6066 default-file-name-coding-system
6068 coding-no-eol
6069 val pos)
6073 ;; If no coding system is specified or detection is
6074 ;; requested, detect the coding.
6088 ;; Force no eol conversion on a file name, so
6089 ;; that CR is preserved.
6097 ;; Try to insert the amount of free space.
6100 ;; First find the line to put it on.
6104 ;; Replace "total" with "used", to avoid confusion.
6110 "Convert `ls --dired' file name position value POS to a buffer position.
6111 File name position values returned in ls --dired output
6112 count only stdout; they don't count the error messages sent to stderr.
6113 So this function converts to them to real buffer positions.
6114 ERROR-LINES is a list of buffer positions of error message lines,
6115 of the form (START END)."
6119 pos)
6123 "Insert directory listing for FILE, formatted according to SWITCHES.
6125 Like `insert-directory', but if FILE does not exist, it inserts a
6126 message to that effect instead of signaling an error."
6129 ;; Simulate the message printed by `ls'.
6133 "Functions to call with no arguments to query about killing Emacs.
6134 If any of these functions returns nil, killing Emacs is canceled.
6135 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6139 "How to ask for confirmation when leaving Emacs.
6140 If nil, the default, don't ask at all. If the value is non-nil, it should
6141 be a predicate function such as `yes-or-no-p'."
6149 "Offer to save each buffer, then kill this Emacs process.
6150 With prefix ARG, silently save all file-visiting buffers, then kill."
6159 ;; process-list is not defined on MSDOS.
6161 active)
6170 ;; Query the user for other things, perhaps.
6177 "Offer to save each buffer, then kill the current connection.
6178 If the current frame has no client, kill Emacs itself.
6180 With prefix ARG, silently save all file-visiting buffers, then kill.
6182 If emacsclient was started with a list of filenames to edit, then
6183 only these files will be asked to be saved."
6188 \f
6189 ;; We use /: as a prefix to "quote" a file name
6190 ;; so that magic file name handlers will not apply to it.
6194 file-name-handler-alist))
6196 ;; We depend on being the last handler on the list,
6197 ;; so that anything else which does need handling
6198 ;; has been handled already.
6199 ;; So it is safe for us to inhibit *all* magic file name handlers.
6208 default-directory))
6209 ;; Get a list of the indices of the args which are file names.
6212 ;; The first six are special because they
6213 ;; return a file name. We want to include the /:
6214 ;; in the return value.
6215 ;; So just avoid stripping it in the first place.
6222 ;; `identity' means just return the first arg
6223 ;; not stripped of its quoting.
6225 ;; `add' means add "/:" to the result.
6228 ;; `unquote-then-quote' means set buffer-file-name
6229 ;; temporarily to unquoted filename.
6231 ;; List the arguments which are filenames.
6239 ;; For all other operations, treat the first argument only
6240 ;; as the file name.
6242 method
6243 ;; Copy ARGUMENTS so we can replace elements in it.
6247 ;; Strip off the /: from the file names that have it.
6255 "/"
6272 \f
6273 ;; Symbolic modes and read-file-modes.
6276 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6277 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6278 Others, or All) for whom to produce the mask.
6279 The bit-mask that is returned extracts from mode bits the access rights
6280 for the specified category of users."
6288 "Convert CHAR to a numeric value of mode bits.
6289 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6290 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6297 ;; Rights relative to the previous file modes.
6308 "Convert a symbolic mode string specification to an equivalent number.
6310 WHO-MASK is the bit-mask specifying the category of users to which to
6311 apply the access permissions. See `file-modes-char-to-who'.
6312 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6313 RIGHTS request to add, remove, or set permissions based on existing ones,
6320 char-right)
6327 num-rights
6331 op char-right)))
6332 num-rights))
6335 "Convert symbolic file modes to numeric file modes.
6336 MODES is the string to convert, it should match
6338 See Info node `(coreutils)File permissions' for more information on this
6339 notation.
6340 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6341 MODES request to add, remove, or set permissions based on existing ones,
6355 num-who num-modes)
6358 num-modes)))
6361 "Read file modes in octal or symbolic notation and return its numeric value.
6362 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6363 ORIG-FILE is the name of a file on whose mode bits to base returned
6364 permissions if what user types requests to add, remove, or set permissions
6380 nil nil default)))
6386 \f
6387 ;; Trashcan handling.
6389 "Directory for `move-file-to-trash' to move files and directories to.
6390 This directory is only used when the function `system-move-file-to-trash'
6391 is not defined.
6392 Relative paths are interpreted relative to `default-directory'.
6393 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6403 "Move the file (or directory) named FILENAME to the trash.
6404 When `delete-by-moving-to-trash' is non-nil, this function is
6405 called by `delete-file' and `delete-directory' instead of
6406 deleting files outright.
6408 If the function `system-move-file-to-trash' is defined, call it
6409 with FILENAME as an argument.
6410 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6411 directory.
6412 Otherwise, trash FILENAME using the freedesktop.org conventions,
6413 like the GNOME, KDE and XFCE desktop environments. Emacs only
6417 ;; If `trash-directory' is non-nil, move the file there.
6421 trash-dir)))
6422 ;; We can't trash a parent directory of trash-directory.
6425 trash-dir filename))
6428 ;; Ensure that the trashed file-name is unique.
6435 ;; If `system-move-file-to-trash' is defined, use it.
6438 ;; Otherwise, use the freedesktop.org method, as specified at
6439 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6450 ;; Check if we have permissions to delete.
6454 ;; The trashed file cannot be the trash dir or its parent.
6457 trash-files-dir filename))
6460 trash-info-dir filename))
6462 ;; Ensure that the trash directory exists; otherwise, create it.
6473 ;; Try to move to trash with .trashinfo undo information
6478 ;; Perform url-encoding on FN. For compatibility with
6479 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6480 ;; for path separators.
6485 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6486 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6499 fn))
6504 ;; Attempt to make .trashinfo file, trying up to 5
6505 ;; times. The .trashinfo file is opened with O_EXCL,
6506 ;; as per trash-spec 0.7, even if that can be a problem
6507 ;; on old NFS versions...
6511 trash-files-dir))
6513 success info-fn)
6518 trash-info-dir))
6526 ;; Uniquify new-fn. (Some file managers do not
6527 ;; like Emacs-style backup file names---e.g. bug
6528 ;; 170956 in Konqueror bug tracker.)
6533 ;; Finally, try to move the file to the trashcan.
6537 \f
6562 ;;; files.el ends here