| blob | d9a3e4b0f796eabb65c0176efbc8d479acd13ddd |
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'ss 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
513 ;; This is an odd variable IMO.
514 ;; You might wonder why it is needed, when we could just do:
515 ;; (set (make-local-variable 'enable-local-variables) nil)
516 ;; These two are not precisely the same.
517 ;; Setting this variable does not cause -*- mode settings to be
518 ;; ignored, whereas setting enable-local-variables does.
519 ;; Only three places in Emacs use this variable: tar and arc modes,
520 ;; and rmail. The first two don't need it. They already use
521 ;; inhibit-local-variables-regexps, which is probably enough, and
522 ;; could also just set enable-local-variables locally to nil.
523 ;; Them setting it has the side-effect that dir-locals cannot apply to
524 ;; eg tar files (?). FIXME Is this appropriate?
525 ;; AFAICS, rmail is the only thing that needs this, and the only
526 ;; reason it uses it is for BABYL files (which are obsolete).
527 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
528 ;; to respect, so that find-file on a BABYL file will switch to
529 ;; rmail-mode automatically (this is nice, but hardly essential,
530 ;; since most people are used to explicitly running a command to
531 ;; access their mail; M-x gnus etc). Rmail files may happen to
532 ;; contain Local Variables sections in messages, which Rmail wants to
533 ;; ignore. So AFAICS the only reason this variable exists is for a
534 ;; minor convenience feature for handling of an obsolete Rmail file format.
536 "Like `enable-local-variables' but meant for buffer-local bindings.
537 The meaningful values are nil and non-nil. The default is non-nil.
538 If a major mode sets this to nil, buffer-locally, then any local
539 variables list in a file visited in that mode will be ignored.
541 This variable does not affect the use of major modes specified
546 The value can be t, nil or something else.
547 A value of t means obey `eval' variables.
548 A value of nil means ignore them; anything else means query."
549 :risky t
555 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
564 "Non-nil means buffers visiting files read-only do so in view mode.
565 In fact, this means that all read-only buffers normally have
566 View mode enabled, including buffers that are read-only because
567 you visit a file you cannot alter, and buffers you make read-only
573 "History list of file names entered in the minibuffer.
575 Maximum length of the history list is determined by the value
577 \f
580 "Provides support for ange-ftp host name completion.
581 Runs the usual ange-ftp hook, but only for completion operations."
582 ;; Having this here avoids the need to load ange-ftp when it's not
583 ;; really in use.
589 inhibit-file-name-handlers)))
597 "Convert a standard file's name to something suitable for the OS.
598 This means to guarantee valid names and perhaps to canonicalize
599 certain patterns.
601 FILENAME should be an absolute file name since the conversion rules
602 sometimes vary depending on the position in the file name. E.g. c:/foo
603 is a valid DOS file name, but c:/bar/c:/foo is not.
605 This function's standard definition is trivial; it just returns
606 the argument. However, on Windows and DOS, replace invalid
607 characters. On DOS, make sure to obey the 8.3 limitations.
608 In the native Windows build, turn Cygwin names into native names,
609 and also turn slashes into backslashes if the shell requires it (see
610 `w32-shell-dos-semantics').
612 See Info node `(elisp)Standard File Names' for more details."
617 ;; Replace invalid filename characters with !
621 name))
629 "Read directory name, prompting with PROMPT and completing in directory DIR.
630 Value is not expanded---you must call `expand-file-name' yourself.
631 Default name to DEFAULT-DIRNAME if user exits with the same
632 non-empty string that was inserted by this function.
633 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
634 or just DIR if INITIAL is nil.)
635 If the user exits with an empty minibuffer, this function returns
636 an empty string. (This can only happen if the user erased the
637 pre-inserted contents or if `insert-default-directory' is nil.)
638 Fourth arg MUSTMATCH non-nil means require existing directory's name.
639 Non-nil and non-t means also require confirmation after completion.
640 Fifth arg INITIAL specifies text to start with.
641 DIR should be an absolute directory name. It defaults to
642 the value of `default-directory'."
647 dir))
648 mustmatch initial
651 \f
653 "Show the current default directory."
658 "Value of the CDPATH environment variable, as a list.
662 "Explode a search path into a list of directory names.
663 Directories are separated by occurrences of `path-separator'
664 \(which is colon in GNU and GNU-like systems)."
665 ;; We could use split-string here.
673 nil
678 cd-list)))
681 "Change current directory to given absolute file name DIR."
682 ;; Put the name into directory syntax now,
683 ;; because otherwise expand-file-name may give some bad results.
685 ;; We used to additionally call abbreviate-file-name here, for an
686 ;; unknown reason. Problem is that most buffers are setup
687 ;; without going through cd-absolute and don't call
688 ;; abbreviate-file-name on their default-directory, so the few that
689 ;; do end up using a superficially different directory.
701 "Make DIR become the current buffer's default directory.
702 If your environment includes a `CDPATH' variable, try each one of
703 that list of directories (separated by occurrences of
704 `path-separator') when resolving a relative directory name.
705 The path separator is colon in GNU and GNU-like systems."
708 ;; FIXME: There's a subtle bug in the completion below. Seems linked
709 ;; to a fundamental difficulty of implementing `predicate' correctly.
710 ;; The manifestation is that TAB may list non-directories in the case where
711 ;; those files also correspond to valid directories (if your cd-path is (A/
712 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
713 ;; will be listed as valid completions).
714 ;; This is because `a' (listed because of A/a) is indeed a valid choice
715 ;; (which will lead to the use of B/a).
720 cd-path nil))
729 default-directory default-directory
730 t))))
740 "Load the Lisp file named FILE."
741 ;; This is a case where .elc makes a lot of sense.
748 "Search for FILENAME through PATH.
749 If found, return the absolute file name of FILENAME, with its suffixes;
750 otherwise return nil.
751 PATH should be a list of directories to look in, like the lists in
752 `exec-path' or `load-path'.
753 If SUFFIXES is non-nil, it should be a list of suffixes to append to
756 If non-nil, PREDICATE is used instead of `file-readable-p'.
758 This function will normally skip directories, so if you want it to find
759 directories, make sure the PREDICATE function returns `dir-ok' for them.
761 PREDICATE can also be an integer to pass to the `access' system call,
762 in which case file-name handlers are ignored. This usage is deprecated.
763 For compatibility, PREDICATE can also be one of the symbols
764 `executable', `readable', `writable', or `exists', or a list of
765 one or more of those symbols."
776 "Do completion for file names passed to `locate-file'."
779 ;; FIXME: maybe we should use completion-file-name-table instead,
780 ;; tho at least for `load', the arg is passed through
781 ;; substitute-in-file-name for historical reasons.
791 ;; If we have files like "foo.el" and "foo.elc", we could load one of
792 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
793 ;; preferred way. So if we list all 3, that gives a lot of redundant
794 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
795 ;; the user does want to pay attention to the extension. We try to
796 ;; diffuse this tension by stripping the suffix, except when the
797 ;; result is a single element (i.e. usually we only list "foo" unless
798 ;; it's the only remaining element in the list, in which case we do
799 ;; list "foo", "foo.elc" and "foo.el").
810 string-file dir))
815 ;; Switching from names to names+fullnames creates a non-monotonicity
816 ;; which can cause problems with things like partial-completion.
817 ;; To minimize the problem, filter out completion-regexp-list, so that
818 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
819 ;; from `names' which only matched `string' when they still had
820 ;; their suffix.
822 ;; Remove duplicates of the first element, so that we can easily check
823 ;; if `names' really only contains a single element.
826 ;; There's no more than one matching non-suffixed element, so expand
827 ;; the list by adding the suffixed elements as well.
830 string-dir names string-file pred action)))))
833 "Do completion for file names passed to `locate-file'.
834 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
837 string nil action))
842 "Regexp of directory names which stop the search in `locate-dominating-file'.
843 Any directory whose name matches this regexp will be treated like
844 a kind of root directory by `locate-dominating-file' which will stop its search
845 when it bumps into it.
846 The default regexp prevents fruitless and time-consuming attempts to find
847 special files in directories in which filenames are interpreted as hostnames,
850 ;; (defun locate-dominating-files (file regexp)
851 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
852 ;; Stop at the first parent where a matching file is found and return the list
853 ;; of files that that match in this directory."
854 ;; (catch 'found
855 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
856 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
857 ;; (let ((user nil)
858 ;; ;; Abbreviate, so as to stop when we cross ~/.
859 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
860 ;; files)
861 ;; (while (and dir
862 ;; ;; As a heuristic, we stop looking up the hierarchy of
863 ;; ;; directories as soon as we find a directory belonging to
864 ;; ;; another user. This should save us from looking in
865 ;; ;; things like /net and /afs. This assumes that all the
866 ;; ;; files inside a project belong to the same user.
867 ;; (let ((prev-user user))
868 ;; (setq user (nth 2 (file-attributes dir)))
869 ;; (or (null prev-user) (equal user prev-user))))
870 ;; (if (setq files (condition-case nil
871 ;; (directory-files dir 'full regexp 'nosort)
872 ;; (error nil)))
873 ;; (throw 'found files)
874 ;; (if (equal dir
875 ;; (setq dir (file-name-directory
876 ;; (directory-file-name dir))))
877 ;; (setq dir nil))))
878 ;; nil)))
881 "Look up the directory hierarchy from FILE for a file named NAME.
882 Stop at the first parent directory containing a file NAME,
883 and return the directory. Return nil if not found.
885 This function only tests if FILE exists. If you care about whether
886 it is readable, regular, etc., you should test the result."
887 ;; We used to use the above locate-dominating-files code, but the
888 ;; directory-files call is very costly, so we're much better off doing
889 ;; multiple calls using the code in here.
890 ;;
891 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
892 ;; `name' in /home or in /.
895 ;; `user' is not initialized outside the loop because
896 ;; `file' may not exist, so we may have to walk up part of the
897 ;; hierarchy before we find the "initial UID". Note: currently unused
898 ;; (user nil)
899 try)
902 ;; FIXME: Disabled this heuristic because it is sometimes
903 ;; inappropriate.
904 ;; As a heuristic, we stop looking up the hierarchy of
905 ;; directories as soon as we find a directory belonging
906 ;; to another user. This should save us from looking in
907 ;; things like /net and /afs. This assumes that all the
908 ;; files inside a project belong to the same user.
909 ;; (let ((prev-user user))
910 ;; (setq user (nth 2 (file-attributes file)))
911 ;; (and prev-user (not (equal user prev-user))))
918 root))
922 "Search for COMMAND in `exec-path' and return the absolute file name.
923 Return nil if COMMAND is not found anywhere in `exec-path'."
924 ;; Use 1 rather than file-executable-p to better match the behavior of
925 ;; call-process.
929 "Load the Emacs Lisp library named LIBRARY.
930 This is an interface to the function `load'. LIBRARY is searched
931 for in `load-path', both with and without `load-suffixes' (as
932 well as `load-file-rep-suffixes').
934 See Info node `(emacs)Lisp Libraries' for more details.
935 See `load-file' for a different interface to `load'."
939 load-path
944 "Test whether FILE specifies a location on a remote system.
945 A file is considered remote if accessing it is likely to
946 be slower or less reliable than accessing local files.
948 `file-remote-p' never opens a new remote connection. It can
949 only reuse a connection that is already open.
951 Return nil or a string identifying the remote connection
952 \(ideally a prefix of FILE). Return nil if FILE is a relative
953 file name.
955 When IDENTIFICATION is nil, the returned string is a complete
956 remote identifier: with components method, user, and host. The
957 components are those present in FILE, with defaults filled in for
958 any that are missing.
960 IDENTIFICATION can specify which part of the identification to
961 return. IDENTIFICATION can be the symbol `method', `user',
962 `host', or `localname'. Any other value is handled like nil and
963 means to return the complete identification. The string returned
964 for IDENTIFICATION `localname' can differ depending on whether
965 there is an existing connection.
967 If CONNECTED is non-nil, return an identification only if FILE is
968 located on a remote system and a connection is established to
969 that remote system.
971 Tip: You can use this expansion of remote identifier components
972 to derive a new remote file name from an existing one. For
978 same remote identifier as FILE but expanded; a name such as
983 nil)))
986 "Whether to use the remote file-name cache for read access.
987 When `nil', never expire cached values (caution)
988 When `t', never use the cache (safe, but may be slow)
989 A number means use cached values for that amount of seconds since caching.
991 The attributes of remote files are cached for better performance.
992 If they are changed outside of Emacs's control, the cached values
993 become invalid, and must be reread. If you are sure that nothing
994 other than Emacs changes the files, you can set this variable to `nil'.
996 If a remote file is checked regularly, it might be a good idea to
997 let-bind this variable to a value less than the interval between
998 consecutive checks. For example:
1000 (defun display-time-file-nonempty-p (file)
1001 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1002 (and (file-exists-p file)
1003 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1014 "Copy the file FILE into a temporary file on this machine.
1015 Returns the name of the local copy, or nil, if FILE is directly
1016 accessible."
1017 ;; This formerly had an optional BUFFER argument that wasn't used by
1018 ;; anything.
1022 nil)))
1025 "Return the truename of FILENAME.
1026 If FILENAME is not absolute, first expands it against `default-directory'.
1027 The truename of a file name is found by chasing symbolic links
1028 both at the level of the file and at the level of the directories
1029 containing it, until no links are left at any level.
1032 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1033 ;; COUNTER can be a cons cell whose car is the count of how many
1034 ;; more links to chase before getting an error.
1035 ;; PREV-DIRS can be a cons cell whose car is an alist
1036 ;; of truenames we've just recently computed.
1050 ;; For speed, remove the ange-ftp completion handler from the list.
1051 ;; We know it's not needed here.
1052 ;; For even more speed, do this only on the outermost call.
1059 ;; andrewi@harlequin.co.uk - none of the following code (except for
1060 ;; invoking the file-name handler) currently applies on Windows
1061 ;; (ie. there are no native symlinks), but there is an issue with
1062 ;; case differences being ignored by the OS, and short "8.3 DOS"
1063 ;; name aliases existing for all files. (The short names are not
1064 ;; reported by directory-files, but can be used to refer to files.)
1065 ;; It seems appropriate for file-truename to resolve these issues in
1066 ;; the most natural way, which on Windows is to call the function
1067 ;; `w32-long-file-name' - this returns the exact name of a file as
1068 ;; it is stored on disk (expanding short name aliases with the full
1069 ;; name in the process).
1072 ;; For file name that has a special handler, call handler.
1073 ;; This is so that ange-ftp can save time by doing a no-op.
1076 ;; If filename contains a wildcard, newname will be the old name.
1078 ;; If filename exists, use the long name. If it doesn't exist,
1079 ;; drill down until we find a directory that exists, and use
1080 ;; the long name of that, with the extra non-existent path
1081 ;; components concatenated.
1083 missing rest)
1086 ;; Include the preceding directory separator in the missing
1087 ;; part so subsequent recursion on the rest works.
1092 ""
1097 ;; If this file directly leads to a link, process that iteratively
1098 ;; so that we don't use lots of stack.
1104 ;; For file name that has a special handler, call handler.
1105 ;; This is so that ange-ftp can save time by doing a no-op.
1108 done t)
1110 target dirfile)
1111 ;; Get the truename of the directory.
1113 ;; If these are equal, we have the (or a) root directory.
1115 ;; If this is the same dir we last got the truename for,
1116 ;; save time--don't recalculate.
1126 done t)
1129 done t)
1130 ;; Put it back on the file name.
1132 ;; Is the file name the name of a link?
1135 ;; Yes => chase that link, then start all over
1136 ;; since the link may point to a directory name that uses links.
1137 ;; We can't safely use expand-file-name here
1138 ;; since target might look like foo/../bar where foo
1139 ;; is itself a link. Instead, we handle . and .. above.
1142 target
1144 done nil)
1145 ;; No, we are done!
1147 filename))
1150 "Chase links in FILENAME until a name that is not a link.
1151 Unlike `file-truename', this does not check whether a parent
1152 directory name is a symbolic link.
1153 If the optional argument LIMIT is a number,
1154 it means chase no more than that many links and then stop."
1162 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1165 ;; Handle `..' by hand, since it needs to work in the
1166 ;; target of any directory symlink.
1167 ;; This code is not quite complete; it does not handle
1168 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1172 ;; Chase links in the default dir of the symlink.
1176 ;; Now find the parent of that dir.
1180 newname))
1182 ;; A handy function to display file sizes in human-readable form.
1183 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1185 "Produce a string showing FILE-SIZE in human-readable form.
1187 Optional second argument FLAVOR controls the units and the display format:
1189 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1191 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1193 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1196 1024.0
1199 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1205 "%.1f%s%s"
1207 file-size
1209 "K"
1214 "Create a temporary file.
1215 The returned file name (created by appending some random characters at the end
1216 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1217 is guaranteed to point to a newly created empty file.
1218 You can then use `write-region' to write new data into the file.
1220 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1222 If SUFFIX is non-nil, add that at the end of the file name."
1224 file)
1227 ;; Create temp files with strict access rights. It's easy to
1228 ;; loosen them later, whereas it's impossible to close the
1229 ;; time-window of loose permissions otherwise.
1237 temporary-file-directory)
1239 temporary-file-directory))))
1245 nil)
1247 ;; the file was somehow created by someone else between
1248 ;; `make-temp-name' and `write-region', let's try again.
1249 nil)
1250 file)
1251 ;; Reset the umask.
1255 "Change the encoding of FILE's name from CODING to NEW-CODING.
1256 The value is a new name of FILE.
1257 Signals a `file-already-exists' error if a file of the new name
1258 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1259 is non-nil. A number as fourth arg means request confirmation if
1260 the new name already exists. This is what happens in interactive
1261 use with M-x."
1264 default-file-name-coding-system))
1266 from-coding to-coding)
1268 ;; We provide the default coding only when it seems that
1269 ;; the filename is correctly decoded by the default
1270 ;; coding.
1276 filename default-coding)
1277 default-coding))
1281 ;; We provide the default coding only when a user is going to
1282 ;; change the encoding not from the default coding.
1286 filename from-coding)))
1289 filename from-coding default-coding)
1290 default-coding)))
1294 default-file-name-coding-system))
1295 ;; FILE should have been decoded by DEFAULT-CODING.
1299 ;; Suppress further encoding.
1304 newname))
1305 \f
1307 "Whether confirmation is requested before visiting a new file or buffer.
1308 If nil, confirmation is not requested.
1309 If the value is `after-completion', confirmation is only
1310 requested if the user called `minibuffer-complete' right before
1311 `minibuffer-complete-and-exit'.
1312 Any other non-nil value means to request confirmation.
1314 This affects commands like `switch-to-buffer' and `find-file'."
1322 "Whether to request confirmation before visiting a new file or buffer.
1323 The variable `confirm-nonexistent-file-or-buffer' determines the
1324 return value, which may be passed as the REQUIRE-MATCH arg to
1325 `read-buffer' or `find-file-read-args'."
1333 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1334 BODY should use the minibuffer at most once.
1335 Recursive uses of the minibuffer are unaffected (FUN is not
1336 called additional times).
1338 This macro actually adds an auxiliary function that calls FUN,
1339 rather than FUN itself, to `minibuffer-setup-hook'."
1345 ;; Clear out this hook so it does not interfere
1346 ;; with any recursive minibuffer usage.
1357 t))
1360 "Edit file FILENAME.
1361 Switch to a buffer visiting file FILENAME,
1362 creating one if none already exists.
1363 Interactively, the default if you just type RET is the current directory,
1364 but the visited file name is available through the minibuffer history:
1365 type M-n to pull it into the minibuffer.
1367 You can visit files on remote machines by specifying something
1368 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1369 also visit local files as a different user by specifying
1370 /sudo::FILE for the file name.
1371 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1372 manual, for more about this.
1374 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1375 expand wildcards (if any) and visit multiple files. You can
1376 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1378 To visit a file without any kind of conversion and without
1389 "Edit file FILENAME, in another window.
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 file FILENAME, in another frame.
1415 an existing one. See the function `display-buffer'.
1417 Interactively, the default if you just type RET is the current directory,
1418 but the visited file name is available through the minibuffer history:
1419 type M-n to pull it into the minibuffer.
1421 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1422 expand wildcards (if any) and visit multiple files."
1435 "Edit the existing file FILENAME.
1437 file names with wildcards."
1446 "Edit file FILENAME but don't allow changes.
1460 value))
1463 "Edit file FILENAME in another window but don't allow changes.
1477 value))
1480 "Edit file FILENAME in another frame but don't allow changes.
1494 value))
1497 "Find file FILENAME as a replacement for the file in the next window.
1498 This command does not select that window.
1502 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1503 expand wildcards (if any) and replace the file with multiple files."
1514 "Find alternate file: " file-dir nil
1516 t))))
1526 "Find file FILENAME, select its buffer, kill previous buffer.
1527 If the current buffer now contains an empty file that you just visited
1528 \(presumably by mistake), use this command to visit the file you really want.
1532 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1533 expand wildcards (if any) and replace the file with multiple files.
1535 If the current buffer is an indirect buffer, or the base buffer
1536 for one or more indirect buffers, the other buffer(s) are not
1537 killed."
1546 "Find alternate file: " file-dir nil
1548 t)))
1563 ;; Run `kill-buffer-hook' here. It needs to happen before
1564 ;; variables like `buffer-file-name' etc are set to nil below,
1565 ;; because some of the hooks that could be invoked
1566 ;; (e.g., `save-place-to-alist') depend on those variables.
1567 ;;
1568 ;; Note that `kill-buffer-hook' is not what queries whether to
1569 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1570 ;; asks that itself. Thus, there's no need to temporarily do
1571 ;; `(set-buffer-modified-p nil)' before running this hook.
1573 ;; Okay, now we can end-of-life the old buffer.
1580 ;; This prevents us from finding the same buffer
1581 ;; if we specified the same file again.
1585 ;; Likewise for dired buffers.
1589 ;; This executes if find-file gets an error
1590 ;; and does not really find anything.
1591 ;; We put things back as they were.
1592 ;; If find-file actually finds something, we kill obuf below.
1601 ;; We already ran these; don't run them again.
1604 \f
1606 "Create a suitably named buffer for visiting FILENAME, and return it.
1607 FILENAME (sans directory) is used unchanged if that name is free;
1608 otherwise a string <2> or <3> or ... is appended to get an unused name.
1609 Spaces at the start of FILENAME (sans directory) are removed."
1618 "Create and return a buffer with a name based on NAME.
1619 Choose the buffer's name using `generate-new-buffer-name'."
1623 "Regexp to match the automounter prefix in a directory name."
1631 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1633 home directory is a root directory) and removes automounter prefixes
1634 \(see the variable `automount-dir-prefix')."
1635 ;; Get rid of the prefixes added by the automounter.
1642 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1643 ;; To fix this right, we need a `file-name-case-sensitive-p'
1644 ;; function, but we don't have that yet, so just guess.
1647 ;; If any elt of directory-abbrev-alist matches this name,
1648 ;; abbreviate accordingly.
1654 ;; Compute and save the abbreviated homedir name.
1655 ;; We defer computing this until the first time it's needed, to
1656 ;; give time for directory-abbrev-alist to be set properly.
1657 ;; We include a slash at the end, to avoid spurious matches
1658 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1665 ;; If FILENAME starts with the abbreviated homedir,
1666 ;; make it start with `~' instead.
1668 ;; If the home dir is just /, don't change it.
1671 ;; MS-DOS root directories can come with a drive letter;
1672 ;; Novell Netware allows drive letters beyond `Z:'.
1680 filename)))
1683 "Return the buffer visiting file FILENAME (a string).
1684 This is like `get-file-buffer', except that it checks for any buffer
1685 visiting the same file, possibly under a different name.
1686 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1687 and others are ignored.
1688 If there is no such live buffer, return nil."
1701 found)
1711 ;; Verify this buffer's file number
1712 ;; still belongs to its file.
1715 attributes)
1719 found))))
1720 \f
1722 "Non-nil means file-visiting commands should handle wildcards.
1723 For example, if you specify `*.c', that would visit all the files
1724 whose names match the pattern."
1730 "Non-nil means suppress warning messages for symlinked files.
1731 When nil, Emacs prints a warning when visiting a file that is already
1732 visited, but with a different name. Setting this option to t
1733 suppresses this warning."
1739 "Maximum size of file above which a confirmation is requested.
1740 When nil, never request confirmation."
1747 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1748 OP-TYPE specifies the file operation being performed (for message to user)."
1757 "Read file FILENAME into a buffer and return the buffer.
1758 If a buffer exists visiting FILENAME, return that one, but
1759 verify that the file has not changed since visited or saved.
1760 The buffer is not selected, just returned to the caller.
1761 Optional second arg NOWARN non-nil means suppress any warning messages.
1762 Optional third arg RAWFILE non-nil means the file is read literally.
1763 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1764 and visit all the matching files. When wildcards are actually
1765 used and expanded, return a list of buffers that are visiting
1766 the various files."
1773 'find-directory-functions
1776 filename)))
1779 find-file-wildcards
1793 ;; Find any buffer for a file which has same truename.
1795 ;; Let user know if there is a buffer with the same truename.
1799 find-file-suppress-same-file-warnings
1803 ;; Optionally also find that buffer.
1806 ;; Check to see if the file looks uncommonly large.
1810 ;; We are using an existing buffer.
1817 ;; Certain files should be reverted automatically
1818 ;; if they have changed on disk and not in the buffer.
1826 found))
1836 "File %s changed on disk. Discard your edits? "
1841 "File %s changed on disk. Discard your edits in %s? "
1849 ;; Check if a formerly read-only file has become
1850 ;; writable and vice versa, but if the buffer agrees
1851 ;; with the new state of the file, that is ok too.
1859 buffer-file-name
1868 ;; It is confusing to ask whether to visit
1869 ;; non-literally if they have the file in
1870 ;; hexl-mode or image-mode.
1876 "The file %s is already visited normally,
1877 and you have edited the buffer. Now you have asked to visit it literally,
1878 meaning no coding system handling, format conversion, or local variables.
1879 Emacs can only visit a file in one way at a time.
1881 Do you want to save the file, and visit it literally instead? "
1882 "The file %s is already visited literally,
1883 meaning no coding system handling, format conversion, or local variables.
1884 You have edited the buffer. Now you have asked to visit the file normally,
1885 but Emacs can only visit a file in one way at a time.
1892 rawfile truename number))
1896 "\
1897 Do you want to discard your changes, and visit the file literally now? "
1898 "\
1901 rawfile truename number)
1907 "The file %s is already visited normally.
1908 You have asked to visit it literally,
1909 meaning no coding system decoding, format conversion, or local variables.
1910 But Emacs can only visit a file in one way at a time.
1912 Do you want to revisit the file literally now? "
1913 "The file %s is already visited literally,
1914 meaning no coding system decoding, format conversion, or local variables.
1915 You have asked to visit it normally,
1916 but Emacs can only visit a file in one way at a time.
1921 rawfile truename number)
1924 ;; Return the buffer we are using.
1925 buf)
1926 ;; Create a new buffer.
1928 ;; find-file-noselect-1 may use a different buffer.
1930 rawfile truename number))))))
1936 ;; Needed in case we are re-visiting the file with a different
1937 ;; text representation.
1954 filename)))
1955 ;; Unconditionally set error
1965 filename)))
1966 ;; Run find-file-not-found-functions until one returns non-nil.
1968 ;; If they fail too, set error.
1970 ;; Record the file's truename, and maybe use that as visited name.
1978 ;; Set buffer's default directory to that of the file.
1980 ;; Turn off backup files for certain file names. Since
1981 ;; this is a permanent local, the major mode won't eliminate it.
1996 \f
1998 "Like `insert-file-contents', but only reads in the file literally.
1999 A buffer may be modified in several ways after reading into the buffer,
2000 to Emacs features such as format decoding, character code
2001 conversion, `find-file-hook', automatic uncompression, etc.
2003 This function ensures that none of these modifications will take place."
2011 nil))
2014 inhibit-file-name-handlers))
2027 filename)))
2028 ;; Check whether the file is uncommonly large
2039 "Insert contents of file FILENAME into buffer after point with no conversion.
2041 This function is meant for the user to run interactively.
2042 Don't call it from programs! Use `insert-file-contents-literally' instead.
2043 \(Its calling sequence is different; see its documentation)."
2048 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2049 This has the `permanent-local' property, which takes effect if you
2054 "Visit file FILENAME with no conversion of any kind.
2055 Format conversion and character code conversion are both disabled,
2056 and multibyte characters are disabled in the resulting buffer.
2057 The major mode used is Fundamental mode regardless of the file name,
2058 and local variable specifications in the file are ignored.
2059 Automatic uncompression and adding a newline at the end of the
2060 file due to `require-final-newline' is also disabled.
2062 You cannot absolutely rely on this function to result in
2063 visiting the file literally. If Emacs already has a buffer
2064 which is visiting the file, you get the existing buffer,
2065 regardless of whether it was created literally or not.
2067 In a Lisp program, if you want to be sure of accessing a file's
2068 contents literally, you should create a temporary buffer and then read
2069 the file contents into it using `insert-file-contents-literally'."
2072 "Find file literally: " nil default-directory
2075 \f
2077 _after-find-file-from-revert-buffer
2078 nomodes)
2079 "Called after finding a file and by the default revert function.
2080 Sets buffer mode, parses local variables.
2081 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2082 error in reading the file. WARN non-nil means warn if there
2083 exists an auto-save file more recent than the visited file.
2084 NOAUTO means don't mess with auto-save mode.
2085 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2086 \(see `revert-buffer-in-progress-p' for similar functionality).
2087 Fifth arg NOMODES non-nil means don't alter the file's modes.
2088 Finishes by calling the functions in `find-file-hook'
2089 unless NOMODES is non-nil."
2092 nil
2102 "Symbolic link that points to nonexistent file"
2106 ;; No need to warn if buffer is auto-saved
2107 ;; under the name of the visited file.
2109 auto-save-visited-file-name))
2112 buffer-file-name))
2132 ;; Make people do a little extra work (C-x C-q)
2133 ;; before altering a backup file.
2136 ;; When a file is marked read-only,
2137 ;; make the buffer read-only even if root is looking at it.
2145 ;; If requested, add a newline at the end of the file.
2155 view-read-only
2161 "Eval BODY and turn any error into a FORMAT message.
2162 FORMAT can have a %s escape which will be replaced with the actual error.
2163 If `debug-on-error' is set, errors are not caught, so that you can
2164 debug them.
2165 Avoid using a large BODY since it is duplicated."
2174 "Choose the major mode for this buffer automatically.
2175 Also sets up any specified local variables of the file.
2176 Uses the visited file name, the -*- line, and the local variables spec.
2178 This function is called automatically from `find-file'. In that case,
2179 we may set up the file-specified mode and local variables,
2180 depending on the value of `enable-local-variables'.
2181 In addition, if `local-enable-local-variables' is nil, we do
2182 not set local variables (though we do notice a mode specified with -*-.)
2184 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2185 or from Lisp without specifying the optional argument FIND-FILE;
2186 in that case, this function acts as if `enable-local-variables' were t."
2190 ;; FIXME this is less efficient than it could be, since both
2191 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2196 ;; Turn font lock off and on, to make sure it takes account of
2197 ;; whatever file local variables are relevant to it.
2199 ;; Font-lock-mode (now in font-core.el) can be ON when
2200 ;; font-lock.el still hasn't been loaded.
2210 "Non-nil means to try second pass through `auto-mode-alist'.
2211 This means that if the first case-sensitive search through the alist fails
2212 to find a matching major mode, a second case-insensitive search is made.
2213 On systems with case-insensitive file names, this variable is ignored,
2214 since only a single case-insensitive search through the alist is made."
2220 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2221 ;; c++-mode, java-mode and more) are added through autoload
2222 ;; directives in that file. That way is discouraged since it
2223 ;; spreads out the definition of the initial value.
2267 ;; Less common extensions come here
2268 ;; so more common ones above are found faster.
2276 ;; Besides .gdbinit, gdb documents other names to be usable for init
2277 ;; files, cross-debuggers can use something like
2278 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2279 ;; don't interfere with each other.
2311 ;; The Fortran standard does not say anything about file extensions.
2312 ;; .f90 was widely used for F90, now we seem to be trapped into
2313 ;; using a different extension for each language revision.
2314 ;; Anyway, the following extensions are supported by gfortran.
2322 ;; The list of archive file extensions should be in sync with
2323 ;; `auto-coding-alist' with `no-conversion' coding system.
2329 ;; Mailer puts message to be edited in
2330 ;; /tmp/Re.... or Message
2333 ;; some news reader is reported to use this
2344 ;; .emacs or .gnus or .viper following a directory delimiter in
2345 ;; Unix, MSDOG or VMS syntax.
2348 ;; _emacs following a directory delimiter
2349 ;; in MsDos syntax
2353 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2354 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2355 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2358 ;; .xs is also used for ld scripts, but seems to be more commonly
2359 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2361 ;; Explained in binutils ld/genscripts.sh. Eg:
2362 ;; A .x script file is the default script.
2363 ;; A .xr script is for linking without relocation (-r flag). Etc.
2367 ;; Common Lisp ASDF package system.
2374 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2386 ;; Windows candidates may be opened case sensitively on Unix
2392 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2393 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2394 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2395 ;; this has lower priority to avoid matching changelog.sgml etc.
2397 ;; either user's dot-files or under /etc or some such
2399 ;; alas not all ~/.*rc files are like this
2400 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2405 ;; this contains everything twice, with space and with colon :-(
2407 ;; Get rid of any trailing .n.m and try again.
2408 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2409 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2410 ;; Using mode nil rather than `ignore' would let the search continue
2411 ;; through this list (with the shortened name) rather than start over.
2414 ;; This should come after "in" stripping (e.g. config.h.in).
2415 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2417 ;; The following should come after the ChangeLog pattern
2418 ;; for the sake of ChangeLog.1, etc.
2419 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2421 "Alist of filename patterns vs corresponding major mode functions.
2422 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2423 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2424 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2425 mode function to use. FUNCTION will be called, unless it is nil.
2427 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2428 calling FUNCTION (if it's not nil), we delete the suffix that matched
2429 REGEXP and search the list again for another match.
2431 The extensions whose FUNCTION is `archive-mode' should also
2432 appear in `auto-coding-alist' with `no-conversion' coding system.
2434 See also `interpreter-mode-alist', which detects executable script modes
2435 based on the interpreters they specify to run,
2440 "Select Conf mode or XML mode according to start of file."
2450 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2451 ;; and pike-mode) are added through autoload directives in that
2452 ;; file. That way is discouraged since it spreads out the
2453 ;; definition of the initial value.
2493 "Alist mapping interpreter names to major modes.
2494 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2495 Each element looks like (INTERPRETER . MODE).
2496 If INTERPRETER matches the name of the interpreter specified in the first line
2497 of a script, mode MODE is enabled.
2504 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2505 ;; because we are duplicating info from auto-mode-alist.
2506 ;; TODO many elements of this list are also in auto-coding-alist.
2514 "List of regexps matching file names in which to ignore local variables.
2516 Files matching this list are typically binary file formats.
2517 They may happen to contain sequences that look like local variable
2518 specifications, but are not really, or they may be containers for
2519 member files with their own local variable sections, which are
2520 not appropriate for the containing file.
2527 "List of regexps matching suffixes to remove from file names.
2528 When checking `inhibit-local-variables-regexps', we first discard
2531 ;; TODO explicitly add case-fold-search t?
2533 "Return non-nil if file local variables should be ignored.
2534 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2535 and `inhibit-local-variables-suffixes'."
2543 sufs)
2548 temp))
2553 "Regexp matching interpreters, for file mode determination.
2554 This regular expression is matched against the first line of a file
2555 to determine the file's mode in `set-auto-mode'. If it matches, the file
2556 is assumed to be interpreted by the interpreter matched by the second group
2557 of the regular expression. The mode is then determined as the mode
2561 "Alist of buffer beginnings vs. corresponding major mode functions.
2562 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2563 After visiting a file, if REGEXP matches the text at the beginning of the
2564 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2565 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2566 major mode.
2568 If FUNCTION is nil, then it is not called. (That is a way of saying
2576 ;; The < comes before the groups (but the first) to reduce backtracking.
2577 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2578 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2582 comment-re "*"
2585 . html-mode)
2587 ;; These two must come after html, because they are more general:
2592 . sgml-mode)
2595 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2596 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2597 After visiting a file, if REGEXP matches the text at the beginning of the
2598 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2599 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2600 have not specified a mode for this file.
2606 "Upper limit on `magic-mode-alist' regexp matches.
2610 "Select major mode appropriate for current buffer.
2612 To find the right major mode, this function checks for a -*- mode tag
2613 checks for a `mode:' entry in the Local Variables section of the file,
2614 checks if it uses an interpreter listed in `interpreter-mode-alist',
2615 matches the buffer beginning against `magic-mode-alist',
2616 compares the filename against the entries in `auto-mode-alist',
2617 then matches the buffer beginning against `magic-fallback-mode-alist'.
2619 If `enable-local-variables' is nil, or if the file name matches
2620 `inhibit-local-variables-regexps', this function does not check
2621 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2622 is nil, then the only mode: tag that can be relevant is a -*- one.
2624 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2625 set the major mode only if that would change it. In other words
2626 we don't actually set it to the same mode the buffer already has."
2627 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2629 end done mode modes)
2630 ;; Once we drop the deprecated feature where mode: is also allowed to
2631 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2632 ;; remove this section and just let (hack-local-variables t) handle it.
2633 ;; Find a -*- mode tag.
2637 ;; Note by design local-enable-local-variables does not matter here.
2639 try-locals
2642 ;; Find all specifications for the `mode:' variable
2643 ;; and execute them left to right.
2655 modes)))
2656 ;; Simple -*-MODE-*- case.
2659 modes))))
2660 ;; If we found modes to use, invoke them now, outside the save-excursion.
2668 ;; continuing would call minor modes again, toggling them off
2670 ;; hack-local-variables checks local-enable-local-variables etc, but
2671 ;; we might as well be explicit here for the sake of clarity.
2673 enable-local-variables
2674 local-enable-local-variables
2675 try-locals
2682 ;; If we didn't, look for an interpreter specified in the first line.
2683 ;; As a special case, allow for things like "#!/bin/env perl", which
2684 ;; finds the interpreter anywhere in $PATH.
2691 ;; Map interpreter name to a mode, signaling we're done at the
2692 ;; same time.
2694 interpreter-mode-alist))
2695 ;; If we found an interpreter mode to use, invoke it now.
2698 ;; Next try matching the buffer beginning against magic-mode-alist.
2712 ;; Next compare the filename against the entries in auto-mode-alist.
2717 ;; Remove backup-suffixes from file name.
2719 ;; Remove remote file name identification.
2724 ;; Find first matching alist entry.
2727 ;; System is case-insensitive.
2731 ;; System is case-sensitive.
2733 ;; First match case-sensitively.
2737 ;; Fallback to case-insensitive match.
2751 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2766 ;; When `keep-mode-if-same' is set, we are working on behalf of
2767 ;; set-visited-file-name. In that case, if the major mode specified is the
2768 ;; same one we already have, don't actually reset it. We don't want to lose
2769 ;; minor modes such as Font Lock.
2771 "Apply MODE and return it.
2772 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2773 any aliases and compared to current major mode. If they are the
2774 same, do nothing and return nil."
2780 mode)))
2783 "Find the -*- spec in the buffer.
2784 Call with point at the place to start searching from.
2785 If one is found, set point to the beginning and return the position
2786 of the end. Otherwise, return nil; may change point.
2787 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
2788 be ignored; but `enable-local-variables' and `local-enable-local-variables'
2789 have no effect."
2792 ;; Don't look for -*- if this file name matches any
2793 ;; of the regexps in inhibit-local-variables-regexps.
2796 ;; If the file begins with "#!" (exec
2797 ;; interpreter magic), look for mode frobs
2798 ;; in the first two lines. You cannot
2799 ;; necessarily put them in the first line
2800 ;; of such a file without screwing up the
2801 ;; interpreter invocation. The same holds
2802 ;; for '\" in man pages (preprocessor
2803 ;; magic for the `man' program).
2814 end))))
2815 \f
2816 ;;; Handling file local variables
2820 file-local-variables-alist dir-local-variables-alist)
2825 "Normal hook run after processing a file's local variables specs.
2826 Major modes can use this to examine user-specified local variables
2830 "List variable-value pairs that are considered safe.
2831 Each element is a cons cell (VAR . VAL), where VAR is a variable
2832 symbol and VAL is a value that is considered safe."
2833 :risky t
2838 ;; This should be here at least as long as Emacs supports write-file-hooks.
2842 "Expressions that are considered safe in an `eval:' local variable.
2843 Add expressions to this list if you want Emacs to evaluate them, when
2844 they appear in an `eval' local variable specification, without first
2845 asking you for confirmation."
2846 :risky t
2851 ;; Risky local variables:
2854 buffer-auto-save-file-name
2855 buffer-file-name
2856 buffer-file-truename
2857 buffer-undo-list
2858 debugger
2859 default-text-properties
2860 eval
2861 exec-directory
2862 exec-path
2863 file-name-handler-alist
2864 frame-title-format
2865 global-mode-string
2866 header-line-format
2867 icon-title-format
2868 inhibit-quit
2869 load-path
2870 max-lisp-eval-depth
2871 max-specpdl-size
2872 minor-mode-map-alist
2873 minor-mode-overriding-map-alist
2874 mode-line-format
2875 mode-name
2876 overriding-local-map
2877 overriding-terminal-local-map
2878 process-environment
2879 standard-input
2880 standard-output
2881 unread-command-events))
2883 ;; Safe local variables:
2884 ;;
2885 ;; For variables defined by major modes, the safety declarations can go into
2886 ;; the major mode's file, since that will be loaded before file variables are
2887 ;; processed.
2888 ;;
2889 ;; For variables defined by minor modes, put the safety declarations in the
2890 ;; file defining the minor mode after the defcustom/defvar using an autoload
2891 ;; cookie, e.g.:
2892 ;;
2893 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2894 ;;
2895 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2896 ;; minor mode file may not be loaded yet.
2897 ;;
2898 ;; For variables defined in the C source code the declaration should go here:
2920 "Alist of file-local variable settings in the current buffer.
2921 Each element in this list has the form (VAR . VALUE), where VAR
2922 is a file-local variable (a symbol) and VALUE is the value
2923 specified. The actual value in the buffer may differ from VALUE,
2929 "Alist of directory-local variable settings in the current buffer.
2930 Each element in this list has the form (VAR . VALUE), where VAR
2931 is a directory-local variable (a symbol) and VALUE is the value
2932 specified in .dir-locals.el. The actual value in the buffer
2933 may differ from VALUE, if it is changed by the major or minor modes,
2938 "Normal hook run before setting file-local variables.
2939 It is called after checking for unsafe/risky variables and
2940 setting `file-local-variables-alist', and before applying the
2941 variables stored in `file-local-variables-alist'. A hook
2942 function is allowed to change the contents of this alist.
2944 This hook is called only if there is at least one file-local
2948 "Get confirmation before setting up local variable values.
2949 ALL-VARS is the list of all variables to be set up.
2950 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2951 RISKY-VARS is the list of those that are marked as risky.
2952 If these settings come from directory-local variables, then
2953 DIR-NAME is the name of the associated directory. Otherwise it is nil."
2955 nil
2962 unsafe-vars))
2966 prompt char)
2974 ", and variables that are risky (**)."
2982 y -- to apply the local variables list.
2986 ! -- to apply the local variables list, and permanently mark these
2998 ;; Make strings with embedded whitespace easier to read.
3006 ""
3023 "Return local variables specified in the -*- line.
3024 Returns an alist of elements (VAR . VAL), where VAR is a variable
3025 and VAL is the specified value. Ignores any specification for
3026 `mode:' and `coding:' (which should have already been handled
3027 by `set-auto-mode' and `set-auto-coding', respectively).
3028 Return nil if the -*- line is malformed.
3030 If MODE-ONLY is non-nil, just returns the symbol specifying the
3031 mode, if there is one, otherwise nil."
3036 result)
3038 nil)
3040 ;; Simple form: "-*- MODENAME -*-".
3044 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3045 ;; (last ";" is optional).
3046 ;; If MODE-ONLY, just check for `mode'.
3047 ;; Otherwise, parse the -*- line into the RESULT alist.
3055 ;; There used to be a downcase here,
3056 ;; but the manual didn't say so,
3057 ;; and people want to set var names that aren't all lc.
3063 ;; It is traditional to ignore
3064 ;; case when checking for `mode' in set-auto-mode,
3065 ;; so we must do that here as well.
3066 ;; That is inconsistent, but we're stuck with it.
3067 ;; The same can be said for `coding' in set-auto-coding.
3077 ;; Downcase "Mode:".
3083 result))))))
3086 "Filter local variable settings, querying the user if necessary.
3087 VARIABLES is the alist of variable-value settings. This alist is
3088 filtered based on the values of `ignored-local-variables',
3089 `enable-local-eval', `enable-local-variables', and (if necessary)
3090 user interaction. The results are added to
3091 `file-local-variables-alist', without applying them.
3092 If these settings come from directory-local variables, then
3093 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3094 ;; Find those variables that we may want to save to
3095 ;; `safe-local-variable-values'.
3101 ;; Ignore any variable in `ignored-local-variables'.
3102 nil)
3103 ;; Obey `enable-local-eval'.
3111 ;; Ignore duplicates (except `mode') in the present list.
3113 ;; Accept known-safe variables.
3117 ;; The variable is either risky or unsafe:
3124 ;; Query, unless all vars are safe or user wants no querying.
3130 risky-vars dir-name))
3141 "Parse and put into effect this buffer's local variables spec.
3142 Uses `hack-local-variables-apply' to apply the variables.
3145 is specified, and return the corresponding mode symbol, or nil.
3146 In this case, we try to ignore minor-modes, and only return a
3147 major-mode.
3149 If `enable-local-variables' or `local-enable-local-variables' is nil,
3150 this function does nothing. If `inhibit-local-variables-regexps'
3151 applies to the file in question, the file is not scanned for
3152 local variables, but directory-local variables may still be applied."
3153 ;; We don't let inhibit-local-variables-p influence the value of
3154 ;; enable-local-variables, because then it would affect dir-local
3155 ;; variables. We don't want to search eg tar files for file local
3156 ;; variable sections, but there is no reason dir-locals cannot apply
3157 ;; to them. The real meaning of inhibit-local-variables-p is "do
3158 ;; not scan this file for local variables".
3161 result)
3165 ;; Note this is a no-op if enable-local-variables is nil.
3167 ;; This entire function is basically a no-op if enable-local-variables
3168 ;; is nil. All it does is set file-local-variables-alist to nil.
3170 ;; This part used to ignore enable-local-variables when mode-only
3171 ;; was non-nil. That was inappropriate, eg consider the
3172 ;; (artificial) example of:
3173 ;; (setq local-enable-local-variables nil)
3174 ;; Open a file foo.txt that contains "mode: sh".
3175 ;; It correctly opens in text-mode.
3176 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3178 ;; If MODE-ONLY is non-nil, and the prop line specifies a
3179 ;; mode, then we're done, and have no need to scan further.
3181 mode-only))
3182 ;; Look for "Local variables:" line in last page.
3190 ;; suffix is what comes after "local variables:" in its line.
3191 ;; prefix is what comes before "local variables:" in its line.
3201 beg)
3205 endpos
3211 nil t))
3212 ;; This used to be an error, but really all it means is
3213 ;; that this may simply not be a local-variables section,
3214 ;; so just ignore it.
3224 ;; Discard the prefix.
3229 ;; Discard the suffix.
3239 ;; Find the variable name; strip whitespace.
3248 val val2)
3251 ;; Read the variable value.
3258 ;; Specifying minor-modes via mode: is
3259 ;; deprecated, but try to reject them anyway.
3267 'eval
3272 ;; Now we've read all the local variables.
3273 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3275 ;; Otherwise, set the variables.
3280 "Apply the elements of `file-local-variables-alist'.
3281 If there are any elements, runs `before-hack-local-variables-hook',
3282 then calls `hack-one-local-variable' to apply the alist elements one by one.
3283 Finishes by running `hack-local-variables-hook', regardless of whether
3284 the alist is empty or not.
3286 Note that this function ignores a `mode' entry if it specifies the same
3287 major mode as the buffer already has."
3289 ;; Any 'evals must run in the Right sequence.
3298 "Non-nil if SYM is safe as a file-local variable with value VAL.
3299 It is safe if any of these conditions are met:
3301 * There is a matching entry (SYM . VAL) in the
3302 `safe-local-variable-values' user option.
3304 * The `safe-local-variable' property of SYM is a function that
3305 evaluates to a non-nil value with VAL as an argument."
3309 ;; If the function signals an error, that means it
3310 ;; can't assure us that the value is safe.
3314 "Non-nil if SYM could be dangerous as a file-local variable.
3315 It is dangerous if either of these conditions are met:
3317 * Its `risky-local-variable' property is non-nil.
3323 ;; If this is an alias, check the base name.
3343 "Return t if it is safe to eval EXP when it is found in a file."
3345 ;; Detect certain `put' expressions.
3352 lisp-indent-function
3353 scheme-indent-function))
3354 ;; Only allow safe values (not functions).
3359 ;; Only allow indirect form specs.
3360 ;; During bootstrapping, edebug-basic-spec might not be
3361 ;; defined yet.
3365 ;; Allow expressions that the user requested.
3367 ;; Certain functions can be allowed with safe arguments
3368 ;; or can specify verification functions to try.
3370 ;; Allow (minor)-modes calls with no arguments.
3371 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3380 ok))
3388 ok))))))))
3391 "Set local variable VAR with value VAL.
3392 If VAR is `mode', call `VAL-mode' as a function unless it's
3393 already the major mode."
3400 ;; A minor mode must be passed an argument.
3401 ;; Otherwise, if the user enables the minor mode in a
3402 ;; major mode hook, this would toggle it off.
3408 ;; Make sure the string has no text properties.
3409 ;; Some text properties can get evaluated in various ways,
3410 ;; so it is risky to put them on with a local variable list.
3414 \f
3415 ;;; Handling directory-local variables, aka project settings.
3421 "List of cached directory roots for directory-local variable classes.
3422 Each element in this list has the form (DIR CLASS MTIME).
3423 DIR is the name of the directory.
3424 CLASS is the name of a variable class (a symbol).
3425 MTIME is the recorded modification time of the directory-local
3426 variables file associated with this entry. This time is a list
3427 of two integers (the same format as `file-attributes'), and is
3428 used to test whether the cache entry is still valid.
3429 Alternatively, MTIME can be nil, which means the entry is always
3433 "Return the variable list for CLASS."
3437 "Collect directory-local variables from MODE-VARIABLES.
3438 VARIABLES is the initial list of variables.
3439 Returns the new list."
3444 ;; If variables are specified more than once, only use the last. (Why?)
3445 ;; The pseudo-variables mode and eval are different (bug#3430).
3448 ;; Need a new cons in case we setcdr later.
3452 "Collect entries from CLASS-VARIABLES into VARIABLES.
3453 ROOT is the root directory of the project.
3454 Return the new variables list."
3457 ;; FIXME: Why not use file-relative-name?
3464 ;; Don't include this in the previous condition, because we
3465 ;; want to filter all strings before the next condition.
3479 ;; TODO someone might want to extend this to allow
3480 ;; integer values for subdir, where N means
3481 ;; variables apply to this directory and N levels
3482 ;; below it (0 == nil).
3485 alist variables))))))))
3487 ;; The file's content might be invalid (e.g. have a merge conflict), but
3488 ;; that shouldn't prevent the user from opening the file.
3490 nil))))
3493 "Declare that the DIRECTORY root is an instance of CLASS.
3494 DIRECTORY is the name of a directory, a string.
3495 CLASS is the name of a project class, a symbol.
3496 MTIME is either the modification time of the directory-local
3497 variables file that defined this class, or nil.
3499 When a file beneath DIRECTORY is visited, the mode-specific
3500 variables from CLASS are applied to the buffer. The variables
3501 for a class are defined using `dir-locals-set-class-variables'."
3508 "Map the type CLASS to a list of variable settings.
3509 CLASS is the project class, a symbol. VARIABLES is a list
3510 that declares directory-local variables for the class.
3511 An element in VARIABLES is either of the form:
3512 (MAJOR-MODE . ALIST)
3513 or
3514 (DIRECTORY . LIST)
3516 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3517 whose elements are of the form (VARIABLE . VALUE).
3519 In the second form, DIRECTORY is a directory name (a string), and
3520 LIST is a list of the form accepted by the function.
3522 When a file is visited, the file's class is found. A directory
3523 may be assigned a class using `dir-locals-set-directory-class'.
3524 Then variables are set in the file's buffer according to the
3525 class' LIST. The list is processed in order.
3527 * If the element is of the form (MAJOR-MODE . ALIST), and the
3528 buffer's major mode is derived from MAJOR-MODE (as determined
3529 by `derived-mode-p'), then all the variables in ALIST are
3530 applied. A MAJOR-MODE of nil may be used to match any buffer.
3531 `make-local-variable' is called for each variable before it is
3532 set.
3534 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3535 is an initial substring of the file's directory, then LIST is
3536 applied by recursively following these rules."
3543 "File that contains directory-local variables.
3544 It has to be constant to enforce uniform values
3548 "Find the directory-local variables for FILE.
3549 This searches upward in the directory tree from FILE.
3550 It stops at the first directory that has been registered in
3551 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3552 If it finds an entry in the cache, it checks that it is valid.
3553 A cache entry with no modification time element (normally, one that
3554 has been assigned directly using `dir-locals-set-directory-class', not
3555 set from a file) is always valid.
3556 A cache entry based on a `dir-locals-file' is valid if the modification
3557 time stored in the cache matches the current file modification time.
3558 If not, the cache entry is cleared so that the file will be re-read.
3560 This function returns either nil (no directory local variables found),
3561 or the matching entry from `dir-locals-directory-cache' (a list),
3562 or the full path to the `dir-locals-file' (a string) in the case
3563 of no valid cache entry."
3568 dir-locals-file))
3571 ;; `locate-dominating-file' may have abbreviated the name.
3574 ;; Find the best cached value in `dir-locals-directory-cache'.
3586 ;; Found a potential cache entry. Check validity.
3587 ;; A cache entry with no MTIME is assumed to always be valid
3588 ;; (ie, set directly, not from a dir-locals file).
3589 ;; Note, we don't bother to check that there is a matching class
3590 ;; element in dir-locals-class-alist, since that's done by
3591 ;; dir-locals-set-directory-class.
3598 ;; This cache entry is OK.
3599 dir-elt
3600 ;; This cache entry is invalid; clear it.
3603 ;; Return the first existing dir-locals file. Might be the same
3604 ;; as dir-elt's, might not (eg latter might have been deleted).
3605 locals-file)
3606 ;; No cache entry.
3607 locals-file)))
3610 "Load a variables FILE and register a new class and instance.
3611 FILE is the name of the file holding the variables to apply.
3612 The new class name is the same as the directory in which FILE
3613 is found. Returns the new class name."
3623 class-name)))
3626 "Read per-directory local variables for the current buffer.
3627 Store the directory-local variables in `dir-local-variables-alist'
3628 and `file-local-variables-alist', without applying them."
3631 ;; Find the variables file.
3655 "Apply directory-local variables to a non-file buffer.
3656 For non-file buffers, such as Dired buffers, directory-local
3657 variables are looked for in `default-directory' and its parent
3658 directories."
3662 \f
3665 However, the mode will not be changed if
3666 \(1) a local variables list or the `-*-' line specifies a major mode, or
3668 \ not suitable for ordinary files, or
3669 \(3) the new file name does not particularly specify any mode."
3674 "Change name of file visited in current buffer to FILENAME.
3675 This also renames the buffer to correspond to the new file.
3676 The next time the buffer is saved it will go in the newly specified file.
3677 FILENAME nil or an empty string means mark buffer as not visiting any file.
3678 Remember to delete the initial contents of the minibuffer
3679 if you wish to pass an empty string as the argument.
3681 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3682 confirmation in the case where another buffer is already visiting FILENAME.
3684 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3685 the old visited file has been renamed to the new name FILENAME."
3693 nil
3708 filename)))
3715 buffer-file-name filename)
3719 ;; If new-name == old-name, renaming would add a spurious <2>
3720 ;; and it's considered as a feature in rename-buffer.
3726 ;; Abbreviate the file names of the buffer.
3735 nil))
3736 ;; write-file-functions is normally used for things like ftp-find-file
3737 ;; that visit things that are not local files as if they were files.
3738 ;; Changing to visit an ordinary local file instead should flush the hook.
3743 ;; If buffer was read-only because of version control,
3744 ;; that reason is gone now, so make it writable.
3748 ;; Turn off backup files for certain file names.
3749 ;; Since this is a permanent local, the major mode won't eliminate it.
3751 backup-enable-predicate
3757 ;; If auto-save was not already on, turn it on if appropriate.
3761 ;; If auto save is on, start using a new name.
3762 ;; We deliberately don't rename or delete the old auto save
3763 ;; for the old visited file name. This is because perhaps
3764 ;; the user wants to save the new state and then compare with the
3765 ;; previous state from the auto save file.
3768 ;; Rename the old auto save file if any.
3775 ;; Update the major mode, if the file name determines it.
3777 ;; Don't change the mode if it is special.
3780 ;; Don't change the mode if the local variable list specifies it.
3781 ;; The file name can influence whether the local variables apply.
3783 ;; h-l-v also checks it, but might as well be explicit.
3786 ;; TODO consider making normal-mode handle this case.
3794 "Write current buffer into file FILENAME.
3795 This makes the buffer visit that file, and marks it as not modified.
3797 If you specify just a directory name as FILENAME, that means to use
3798 the default file name but in that directory. You can also yank
3799 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3801 If the buffer is not already visiting a file, the default file name
3802 for the output file is the buffer name.
3804 If optional second arg CONFIRM is non-nil, this function
3805 asks for confirmation before overwriting an existing file.
3806 Interactively, confirmation is required unless you supply a prefix argument."
3807 ;; (interactive "FWrite file: ")
3811 nil nil nil nil)
3815 default-directory)
3816 nil nil))
3820 ;; If arg is just a directory,
3821 ;; use the default file name, but in that directory.
3832 ;; Make buffer writable if file is writable.
3837 ;; It's likely that the VC status at the new location is different from
3838 ;; the one at the old location.
3840 \f
3842 "Make a backup of the disk file visited by the current buffer, if appropriate.
3843 This is normally done before saving the buffer the first time.
3845 A backup may be done by renaming or by copying; see documentation of
3846 variable `make-backup-files'. If it's done by renaming, then the file is
3847 no longer accessible under its old name.
3849 The value is non-nil after a backup was made by renaming.
3850 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3851 MODES is the result of `file-modes' on the original
3852 file; this means that the caller, after saving the buffer, should change
3853 the modes of the new file to agree with the old modes.
3854 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3855 file; this means that the caller, after saving the buffer, should change
3856 the SELinux context of the new file to agree with the old context.
3857 BACKUPNAME is the backup file name, which is the old file renamed."
3864 backup-info backupname targets setmodes)
3865 ;; If specified name is a symbolic link, chase it to the target.
3866 ;; Thus we make the backups in the directory where the real file is.
3871 ;; (if (file-directory-p buffer-file-name)
3872 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3876 ;; If have old versions to maybe delete,
3877 ;; ask the user to confirm now, before doing anything.
3878 ;; But don't actually delete til later.
3883 real-file-name)))))
3886 ;; Actually write the back up file.
3889 ; (file-symlink-p buffer-file-name)
3890 backup-by-copying
3891 ;; Don't rename a suid or sgid file.
3906 ;; rename-file should delete old backup.
3910 ;; If trouble writing the backup, write it in
3911 ;; .emacs.d/%backup%.
3914 backupname)
3918 ;; Now delete the old versions, if desired.
3925 setmodes)
3932 ;; Create temp files with strict access rights. It's easy to
3933 ;; loosen them later, whereas it's impossible to close the
3934 ;; time-window of loose permissions otherwise.
3937 ;; Try to overwrite old backup first.
3945 nil)
3947 ;; The file was somehow created by someone else between
3948 ;; `delete-file' and `copy-file', so let's try again.
3949 ;; rms says "I think there is also a possible race
3950 ;; condition for making backup files" (emacs-devel 20070821).
3951 nil)))
3952 ;; Reset the umask.
3961 ;; The last ~[[:digit]]+ matches relative versions in git,
3962 ;; e.g. `foo.js.~HEAD~1~'.
3963 "Regular expression matching the backup/version part of a file name.
3967 "Return file NAME sans backup versions or strings.
3968 This is a separate procedure so your site-init or startup file can
3969 redefine it.
3970 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3971 we do not remove backup version numbers, only true file version numbers.
3972 See also `file-name-version-regexp'."
3979 name))))))
3982 "Return t if deleting FILE and rewriting it would preserve the owner."
3987 ;; Return t if the file doesn't exist, since it's true that no
3988 ;; information would be lost by an (attempted) delete and create.
3991 ;; Files created on Windows by Administrator (RID=500)
3992 ;; have the Administrators group (RID=544) recorded as
3993 ;; their owner. Rewriting them will still preserve the
3994 ;; owner.
4000 The extension, in a file name, is the part that follows the last `.',
4001 except that a leading `.', if any, doesn't count."
4004 directory)
4008 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4009 ;; we don't want to expand it.
4012 filename))))
4016 The extension, in a file name, is the part that follows the last `.',
4017 excluding version numbers and backup suffixes,
4018 except that a leading `.', if any, doesn't count.
4019 Return nil for extensionless file names such as `foo'.
4020 Return the empty string for file names such as `foo.'.
4022 If PERIOD is non-nil, then the returned value includes the period
4023 that delimits the extension, and if FILENAME has no extension,
4034 "A function to use instead of the default `make-backup-file-name'.
4035 A value of nil gives the default `make-backup-file-name' behavior.
4037 This could be buffer-local to do something special for specific
4038 files. If you define it, you may need to change `backup-file-name-p'
4039 and `file-name-sans-versions' too.
4041 See also `backup-directory-alist'."
4047 "Alist of filename patterns and backup directory names.
4048 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4049 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4050 relative or absolute. If it is absolute, so that all matching files
4051 are backed up into the same directory, the file names in this
4052 directory will be the full name of the file backed up with all
4053 directory separators changed to `!' to prevent clashes. This will not
4054 work correctly if your filesystem truncates the resulting name.
4056 For the common case of all backups going into one directory, the alist
4058 directory name.
4060 If this variable is nil, or it fails to match a filename, the backup
4061 is made in the original file's directory.
4063 On MS-DOS filesystems without long names this variable is always
4064 ignored."
4070 "Default `backup-enable-predicate' function.
4071 Checks for files in `temporary-file-directory',
4072 `small-temporary-file-directory', and /tmp."
4075 ;; Directory is under temporary-file-directory.
4080 ;; Directory is under /tmp.
4085 0 nil
4087 ;; Directory is under small-temporary-file-directory.
4092 "Create the non-numeric backup file name for FILE.
4093 Normally this will just be the file's name with `~' appended.
4094 Customization hooks are provided as follows.
4096 If the variable `make-backup-file-name-function' is non-nil, its value
4097 should be a function which will be called with FILE as its argument;
4098 the resulting name is used.
4100 Otherwise a match for FILE is sought in `backup-directory-alist'; see
4101 the documentation of that variable. If the directory for the backup
4102 doesn't exist, it is created."
4116 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
4118 elt backup-directory abs-backup-directory)
4123 alist nil)))
4124 ;; If backup-directory is relative, it should be relative to the
4125 ;; file's directory. By expanding explicitly here, we avoid
4126 ;; depending on default-directory.
4135 abs-backup-directory nil))))
4137 file
4141 ;; Normalize DOSish file names: downcase the drive
4142 ;; letter, if any, and replace the leading "x:" with
4143 ;; "/drive_x".
4146 ;; Replace any invalid file-name characters (for the
4147 ;; case of backing up remote files).
4151 "drive_"
4154 ""
4157 ;; Make the name unique by substituting directory
4158 ;; separators. It may not really be worth bothering about
4159 ;; doubling `!'s in the original name...
4164 backup-directory))
4169 "Return non-nil if FILE is a backup file name (numeric or not).
4170 This is a separate function so you can redefine it for customization.
4171 You may need to redefine `file-name-sans-versions' as well."
4176 ;; This is used in various files.
4177 ;; The usage of backup-extract-version-start is not very clean,
4178 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4180 "Given the name of a numeric backup file, FN, return the backup number.
4181 Uses the free variable `backup-extract-version-start', whose value should be
4182 the index in the name where the version number begins."
4189 "Find a file name for a backup file FN, and suggestions for deletions.
4190 Value is a list whose car is the name for the backup file
4191 and whose cdr is a list of old versions to consider deleting now.
4192 If the value is nil, don't make a backup.
4193 Uses `backup-directory-alist' in the same way as does
4194 `make-backup-file-name'."
4196 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4200 ;; We don't support numbered backups on plain MS-DOS
4201 ;; when long file names are unavailable.
4211 possibilities deserve-versions-p versions)
4214 base-versions
4217 possibilities)
4218 #'<)
4223 kept-old-versions
4224 kept-new-versions
4231 ;; Delete nothing if there is overflow
4232 ;; in the number of versions to keep.
4238 v))))))))))
4241 "Return number of names file FILENAME has."
4244 ;; (defun file-relative-name (filename &optional directory)
4245 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4246 ;; This function returns a relative file name which is equivalent to FILENAME
4247 ;; when used with that default directory as the default.
4248 ;; If this is impossible (which can happen on MSDOS and Windows
4249 ;; when the file name and directory use different drive names)
4250 ;; then it returns FILENAME."
4251 ;; (save-match-data
4252 ;; (let ((fname (expand-file-name filename)))
4253 ;; (setq directory (file-name-as-directory
4254 ;; (expand-file-name (or directory default-directory))))
4255 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4256 ;; ;; drive names, they can't be relative, so return the absolute name.
4257 ;; (if (and (or (eq system-type 'ms-dos)
4258 ;; (eq system-type 'cygwin)
4259 ;; (eq system-type 'windows-nt))
4260 ;; (not (string-equal (substring fname 0 2)
4261 ;; (substring directory 0 2))))
4262 ;; filename
4263 ;; (let ((ancestor ".")
4264 ;; (fname-dir (file-name-as-directory fname)))
4265 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4266 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4267 ;; (setq directory (file-name-directory (substring directory 0 -1))
4268 ;; ancestor (if (equal ancestor ".")
4269 ;; ".."
4270 ;; (concat "../" ancestor))))
4271 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4272 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4273 ;; ;; We matched within FNAME's directory part.
4274 ;; ;; Add the rest of FNAME onto ANCESTOR.
4275 ;; (let ((rest (substring fname (match-end 0))))
4276 ;; (if (and (equal ancestor ".")
4277 ;; (not (equal rest "")))
4278 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4279 ;; rest
4280 ;; (concat (file-name-as-directory ancestor) rest)))
4281 ;; ;; We matched FNAME's directory equivalent.
4282 ;; ancestor))))))
4285 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4286 This function returns a relative file name which is equivalent to FILENAME
4287 when used with that default directory as the default.
4288 If FILENAME and DIRECTORY lie on different machines or on different drives
4289 on a DOS/Windows machine, it returns FILENAME in expanded form."
4293 default-directory))))
4299 ;; Test for different filesystems on DOS/Windows
4301 ;; Should `cygwin' really be included here? --stef
4304 ;; Test for different drive letters
4306 ;; Test for UNCs on different servers
4311 ;; Windows file names cannot have ? in
4312 ;; them, so use that to detect when
4313 ;; neither FILENAME nor DIRECTORY is a
4314 ;; UNC.
4316 0 nil
4322 ;; Test for different remote file system identification
4324 filename
4330 directory nil nil case-fold-search))
4332 directory nil nil case-fold-search))))
4335 ".."
4337 ;; Now ancestor is empty, or .., or ../.., etc.
4339 directory nil nil case-fold-search))
4340 ;; We matched within FILENAME's directory part.
4341 ;; Add the rest of FILENAME onto ANCESTOR.
4344 ;; But don't bother with ANCESTOR if it would give us `./'.
4345 rest
4347 ;; We matched FILENAME's directory equivalent.
4348 ancestor))))))
4349 \f
4351 "Save current buffer in visited file if modified.
4352 Variations are described below.
4354 By default, makes the previous version into a backup file
4355 if previously requested or if this is the first save.
4357 to become a backup when the next save is done.
4359 unconditionally makes the previous version into a backup file.
4361 to become a backup when the next save is done,
4362 and unconditionally makes the previous version into a backup file.
4364 With a numeric argument of 0, never make the previous version
4365 into a backup file.
4367 If a file's name is FOO, the names of its numbered backup versions are
4368 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4369 Numeric backups (rather than FOO~) will be made if value of
4370 `version-control' is not the atom `never' and either there are already
4371 numeric versions of the file being backed up, or `version-control' is
4372 non-nil.
4373 We don't want excessive versions piling up, so there are variables
4374 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4375 and `kept-new-versions', which tells how many newest versions to keep.
4376 Defaults are 2 old versions and 2 new.
4377 `dired-kept-versions' controls dired's clean-directory (.) command.
4378 If `delete-old-versions' is nil, system will query user
4379 before trimming versions. Otherwise it does it silently.
4381 If `vc-make-backup-files' is nil, which is the default,
4382 no backup files are made for files managed by version control.
4383 (This is because the version control system itself records previous versions.)
4385 See the subroutine `basic-save-buffer' for more information."
4391 ;; We used to display the message below only for files > 50KB, but
4392 ;; then Rmail-mbox never displays it due to buffer swapping. If
4393 ;; the test is ever re-introduced, be sure to handle saving of
4394 ;; Rmail files.
4401 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4402 Normally delete only if the file was written by this Emacs since
4403 the last real save, but optional arg FORCE non-nil means delete anyway."
4417 "Normal hook that is run before a buffer is saved to its file."
4423 "Normal hook that is run after a buffer is saved to its file."
4429 "If non-nil, use this coding system for saving the buffer.
4430 More precisely, use this coding system in place of the
4431 value of `buffer-file-coding-system', when saving the buffer.
4432 Calling `write-region' for any purpose other than saving the buffer
4433 will still use `buffer-file-coding-system'; this variable has no effect
4440 "Save the current buffer in its visited file, if it has been modified.
4441 The hooks `write-contents-functions' and `write-file-functions' get a chance
4442 to do the job of saving; if they do not, then the buffer is saved in
4443 the visited file in the usual way.
4444 Before and after saving the buffer, this function runs
4445 `before-save-hook' and `after-save-hook', respectively."
4448 ;; In an indirect buffer, save its base buffer instead.
4452 ;; handle the case when no modification has been made but
4453 ;; the file disappeared since visited
4457 setmodes)
4458 ;; If buffer has no file name, ask user for one.
4465 ;; Signal an error if the user specified the name of an
4466 ;; existing directory.
4469 filename))
4471 ;; Signal an error if the specified name refers to a
4472 ;; non-existing directory.
4483 "%s has changed since visited or saved. Save anyway? "
4503 ;; Support VC version backups.
4509 ;; If a hook returned t, file is already "written".
4510 ;; Otherwise, write it the usual way now.
4512 ;; Now we have saved the current buffer. Let's make sure
4513 ;; that buffer-file-coding-system is fixed to what
4514 ;; actually used for saving by binding it locally.
4526 ;; If the auto-save file was recent before this command,
4527 ;; delete it now.
4529 ;; Support VC `implicit' locking.
4534 ;; This does the "real job" of writing a buffer into its visited file
4535 ;; and making a backup file. This is what is normally done
4536 ;; but inhibited if one of write-file-functions returns non-nil.
4537 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4549 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4562 "File %s is write-protected; try to save anyway? "
4564 buffer-file-name)))
4579 ;; Write temp name, then rename it.
4580 ;; This requires write access to the containing dir,
4581 ;; which is why we don't try it if we don't have that access.
4583 tempname succeed
4586 ;; Create temp files with strict access rights. It's easy to
4587 ;; loosen them later, whereas it's impossible to close the
4588 ;; time-window of loose permissions otherwise.
4593 ;; Try various temporary names.
4594 ;; This code follows the example of make-temp-file,
4595 ;; but it calls write-region in the appropriate way
4596 ;; for saving the buffer.
4602 ;; Pass in nil&nil rather than point-min&max
4603 ;; cause we're saving the whole buffer.
4604 ;; write-region-annotate-functions may use it.
4606 tempname nil realname
4608 nil)
4610 ;; The file was somehow created by someone else between
4611 ;; `make-temp-name' and `write-region', let's try again.
4612 nil)
4614 ;; Reset the umask.
4616 ;; If we failed, restore the buffer's modtime.
4619 ;; Since we have created an entirely new file,
4620 ;; make sure it gets the right permission bits set.
4625 buffer-file-name)))
4626 ;; We succeeded in writing the temp file,
4627 ;; so rename it.
4629 ;; If file not writable, see if we can make it writable
4630 ;; temporarily while we write it.
4631 ;; But no need to do so if we have just backed it up
4632 ;; (setmodes is set) because that says we're superseding.
4634 ;; Change the mode back, after writing.
4637 buffer-file-name))
4643 ;; Pass in nil&nil rather than point-min&max to indicate
4644 ;; we're saving the buffer rather than just a region.
4645 ;; write-region-annotate-functions may make us of it.
4647 buffer-file-name nil t buffer-file-truename)
4649 ;; If we get an error writing the new file, and we made
4650 ;; the backup by renaming, undo the backing-up.
4655 setmodes))
4661 `((?\C-r
4668 ;; Return nil to ask about BUF again.
4669 nil)
4682 ;; Return nil to ask about BUF again.
4683 nil)
4693 "Save some modified file-visiting buffers. Asks user about each one.
4694 You can answer `y' to save, `n' not to save, `C-r' to look at the
4695 buffer in question with `view-buffer' before deciding or `d' to
4696 view the differences using `diff-buffer-with-file'.
4698 This command first saves any buffers where `buffer-save-without-query' is
4699 non-nil, without asking.
4701 Optional argument (the prefix) non-nil means save all with no questions.
4702 Optional second argument PRED determines which buffers are considered:
4703 If PRED is nil, all the file-visiting buffers are considered.
4704 If PRED is t, then certain non-file buffers will also be considered.
4705 If PRED is a zero-argument function, it indicates for each buffer whether
4706 to consider it or not when called with that buffer current.
4708 See `save-some-buffers-action-alist' if you want to
4709 change the additional actions you can take on files."
4713 files-done abbrevs-done)
4715 ;; First save any buffers that we're supposed to save unconditionally.
4716 ;; That way the following code won't ask about them.
4721 ;; Ask about those buffers that merit it,
4722 ;; and record the number thus saved.
4726 ;; Note that killing some buffers may kill others via
4727 ;; hooks (e.g. Rmail and its viewing buffer).
4740 t
4752 save-some-buffers-action-alist))
4753 ;; Maybe to save abbrevs, and record whether
4754 ;; we either saved them or asked to.
4761 ;; Don't keep bothering user if he says no.
4774 \f
4776 "Mark current buffer as unmodified, not needing to be saved.
4779 It is not a good idea to use this function in Lisp programs, because it
4780 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4787 "Change whether this buffer is read-only.
4788 With prefix argument ARG, make the buffer read-only if ARG is
4789 positive, otherwise make it writable. If buffer is read-only
4790 and `view-read-only' is non-nil, enter view mode.
4792 This function is usually the wrong thing to use in a Lisp program.
4793 It can have side-effects beyond changing the read-only status of a buffer
4794 \(e.g., enabling view mode), and does not affect read-only regions that
4795 are caused by text properties. To make a buffer read-only in Lisp code,
4796 set `buffer-read-only'. To ignore read-only status (whether due to text
4797 properties or buffer state) and make changes, temporarily bind
4798 `inhibit-read-only'."
4803 nil ; do nothing.
4804 ;; Toggle.
4811 ;; If view-mode is already active, `view-mode-enter' is a nop.
4819 "Insert contents of file FILENAME into buffer after point.
4820 Set mark after the inserted text.
4822 This function is meant for the user to run interactively.
4823 Don't call it from programs! Use `insert-file-contents' instead.
4824 \(Its calling sequence is different; see its documentation)."
4829 "Append the contents of the region to the end of file FILENAME.
4830 When called from a function, expects three arguments,
4831 START, END and FILENAME. START and END are normally buffer positions
4832 specifying the part of the buffer to write.
4833 If START is nil, that means to use the entire buffer contents.
4834 If START is a string, then output that string to the file
4835 instead of any buffer contents; END is ignored.
4837 This does character code conversion and applies annotations
4838 like `write-region' does."
4843 "Return most recent backup file for FILENAME or nil if no backups exist."
4844 ;; `make-backup-file-name' will get us the right directory for
4845 ;; ordinary or numeric backups. It might create a directory for
4846 ;; backups as a side-effect, according to `backup-directory-alist'.
4853 tem)
4862 newest))
4865 "Rename current buffer to a similar name not already taken.
4866 This function is useful for creating multiple shell process buffers
4867 or multiple mail buffers, etc.
4869 Note that some commands, in particular those based on `compilation-mode'
4870 \(`compile', `grep', etc.) will reuse the current buffer if it has the
4871 appropriate mode even if it has been renamed. So as well as renaming
4872 the buffer, you also need to switch buffers before running another
4873 instance of such commands."
4881 ;; If the existing buffer name has a <NNN>,
4882 ;; which isn't part of the file name (if any),
4883 ;; then get rid of that.
4889 "Create the directory DIR and optionally any nonexistent parent dirs.
4890 If DIR already exists as a directory, signal an error, unless
4891 PARENTS is non-nil.
4893 Interactively, the default choice of directory to create is the
4894 current buffer's default directory. That is useful when you have
4895 visited a file in a nonexistent directory.
4897 Noninteractively, the second (optional) argument PARENTS, if
4898 non-nil, says whether to create parent directories that don't
4899 exist. Interactively, this happens by default.
4901 If creating the directory or directories fail, an error will be
4902 raised."
4905 nil nil)
4906 t))
4907 ;; If default-directory is a remote directory,
4908 ;; make sure we find its make-directory handler.
4916 create-list)
4918 ;; If directory is its own parent, then we can't
4919 ;; keep looping forever
4934 "Delete the directory named DIRECTORY. Does not follow symlinks.
4935 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4936 TRASH non-nil means to trash the directory instead, provided
4937 `delete-by-moving-to-trash' is non-nil.
4939 When called interactively, TRASH is t if no prefix argument is
4940 given. With a prefix argument, TRASH is nil."
4947 "Move directory to trash: "
4949 default-directory default-directory nil nil))))
4955 nil)
4957 ;; If default-directory is a remote directory, make sure we find its
4958 ;; delete-directory handler.
4965 ;; Only move non-empty dir to trash if recursive deletion was
4966 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4967 ;; case, where the operation fails in delete-directory-internal.
4968 ;; As `move-file-to-trash' trashes directories (empty or
4969 ;; otherwise) as a unit, we do not need to recurse here.
4971 ;; Check if directory is empty apart from "." and "..".
4976 ;; Otherwise, call ourselves recursively if needed.
4980 ;; This test is equivalent to
4981 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4982 ;; but more efficient
4986 ;; We do not want to delete "." and "..".
4992 "Return non-nil if files FILE1 and FILE2 name the same file.
4993 If FILE1 or FILE2 does not exist, the return value is unspecified."
5004 "Return non-nil if DIR1 is a subdirectory of DIR2.
5005 A directory is considered to be a subdirectory of itself.
5006 Return nil if top directory DIR2 is not an existing directory."
5028 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5029 This function always sets the file modes of the output files to match
5030 the corresponding input file.
5032 The third arg KEEP-TIME non-nil means give the output files the same
5033 last-modified time as the old ones. (This works on only some systems.)
5035 A prefix arg makes KEEP-TIME non-nil.
5037 Noninteractively, the last argument PARENTS says whether to
5038 create parent directories if they don't exist. Interactively,
5039 this happens by default.
5041 If NEWNAME names an existing directory, copy DIRECTORY as a
5042 subdirectory there. However, if called from Lisp with a non-nil
5043 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5044 directly into NEWNAME instead."
5051 default-directory default-directory nil nil)
5052 current-prefix-arg t nil)))
5055 directory newname))
5056 ;; If default-directory is a remote directory, make sure we find its
5057 ;; copy-directory handler.
5062 newname keep-time parents copy-contents)
5064 ;; Compute target name.
5069 ;; If NEWNAME is not an existing directory, create it;
5070 ;; that is where we will copy the files of DIRECTORY.
5072 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5073 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5078 newname))
5082 newname))
5085 ;; Copy recursively.
5087 ;; We do not want to copy "." and "..".
5089 directory-files-no-dot-files-regexp))
5098 ;; Set directory attributes.
5103 \f
5106 "Function to use to revert this buffer, or nil to do the default.
5107 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5112 "Function to use to insert contents when reverting this buffer.
5113 Gets two args, first the nominal file name to use,
5114 and second, t if reading the auto-save file.
5119 "Function to check whether a non-file buffer needs reverting.
5120 This should be a function with one optional argument NOCONFIRM.
5121 Auto Revert Mode passes t for NOCONFIRM. The function should return
5122 non-nil if the buffer should be reverted. A return value of
5123 `fast' means that the need for reverting was not checked, but
5124 that reverting the buffer is fast. The buffer is current when
5125 this function is called.
5127 The idea behind the NOCONFIRM argument is that it should be
5128 non-nil if the buffer is going to be reverted without asking the
5129 user. In such situations, one has to be careful with potentially
5130 time consuming operations.
5132 For more information on how this variable is used by Auto Revert mode,
5136 "Normal hook for `revert-buffer' to run before reverting.
5137 If `revert-buffer-function' is used to override the normal revert
5141 "Normal hook for `revert-buffer' to run after reverting.
5142 Note that the hook value that it runs is the value that was in effect
5143 before reverting; that makes a difference if you have buffer-local
5144 hook functions.
5146 If `revert-buffer-function' is used to override the normal revert
5150 "Non-nil if a `revert-buffer' operation is in progress, nil otherwise.
5156 "Replace current buffer text with the text of the visited file on disk.
5157 This undoes all changes since the file was visited or saved.
5158 With a prefix argument, offer to revert from latest auto-save file, if
5159 that is more recent than the visited file.
5161 This command also implements an interface for special buffers
5162 that contain text which doesn't come from a file, but reflects
5163 some other data instead (e.g. Dired buffers, `buffer-list'
5164 buffers). This is done via the variable `revert-buffer-function'.
5165 In these cases, it should reconstruct the buffer contents from the
5166 appropriate data.
5168 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5169 to revert from the auto-save file when this is nil. Note that the
5170 sense of this argument is the reverse of the prefix argument, for the
5171 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5172 to nil.
5174 Optional second argument NOCONFIRM means don't ask for confirmation
5175 at all. (The variable `revert-without-query' offers another way to
5176 revert buffers without querying for confirmation.)
5178 Optional third argument PRESERVE-MODES non-nil means don't alter
5179 the files modes. Normally we reinitialize them using `normal-mode'.
5181 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5183 If the value of `revert-buffer-function' is non-nil, it is called to
5184 do all the work for this command. Otherwise, the hooks
5185 `before-revert-hook' and `after-revert-hook' are run at the beginning
5186 and the end, and if `revert-buffer-insert-file-contents-function' is
5187 non-nil, it is called instead of rereading visited file contents."
5189 ;; I admit it's odd to reverse the sense of the prefix argument, but
5190 ;; there is a lot of code out there which assumes that the first
5191 ;; argument should be t to avoid consulting the auto-save file, and
5192 ;; there's no straightforward way to encourage authors to notice a
5193 ;; reversal of the argument sense. So I'm just changing the user
5194 ;; interface, but leaving the programmatic interface the same.
5204 buffer-auto-save-file-name
5209 buffer-auto-save-file-name
5210 buffer-file-name)))
5220 file-name)))
5222 ;; If file was backed up but has changed since,
5223 ;; we should make another backup.
5227 ;; Effectively copy the after-revert-hook status,
5228 ;; since after-find-file will clobber it.
5231 after-revert-hook))
5236 ;; Get rid of all undo records for this buffer.
5238 ;; Don't make undo records for the reversion.
5241 file-name auto-save-p)))
5244 "File %s no longer exists!"
5246 file-name))
5249 "File %s no longer readable!"
5251 file-name))
5253 ;; Bind buffer-file-name to nil
5254 ;; so that we don't try to lock the file.
5260 ;; Auto-saved file should be read by Emacs's
5261 ;; internal coding.
5265 buffer-file-coding-system-explicit
5268 coding-system-for-read
5270 coding-system-for-read)
5272 ;; As a coding system suitable for multibyte
5273 ;; buffer is specified, make the current
5274 ;; buffer multibyte.
5277 ;; This force after-insert-file-set-coding
5278 ;; (called from insert-file-contents) to set
5279 ;; buffer-file-coding-system to a proper value.
5282 ;; Note that this preserves point in an intelligent way.
5286 nil nil t))
5288 nil nil t)))))
5289 ;; Recompute the truename in case changes in symlinks
5290 ;; have changed the truename.
5294 ;; Run after-revert-hook as it was before we reverted.
5298 local-hook)
5301 t))))))
5304 "Recover the visited file--get contents from its last auto-save file."
5309 "Visit file FILE, but get contents from its last auto-save file."
5310 ;; Actually putting the file name in the minibuffer should be used
5311 ;; only rarely.
5312 ;; Not just because users often use the default.
5332 ;; Use insert-directory-safely, not insert-directory,
5333 ;; because these files might not exist. In particular,
5334 ;; FILE might not exist if the auto-save file was for
5335 ;; a buffer that didn't visit a file, such as "*mail*".
5336 ;; The code in v20.x called `ls' directly, so we need
5337 ;; to emulate what `ls' did in that case.
5343 ;; Keep the current buffer-file-coding-system.
5345 ;; Auto-saved file should be read with special coding.
5354 "Recover auto save files from a previous Emacs session.
5355 This command first displays a Dired buffer showing you the
5356 previous sessions that you could recover from.
5357 To choose one, move point to the proper line and then type C-c C-c.
5358 Then you'll be asked about a number of files to recover."
5368 auto-save-list-file-prefix)))
5369 t)
5378 ;; Each line starts with a space
5379 ;; so that Font Lock mode won't highlight the first character.
5388 "Choose one saved session to recover auto-save files from.
5389 This command is used in the special Dired buffer created by
5392 ;; Get the name of the session file to recover from.
5394 files
5400 ;; Read in the auto-save-list file.
5403 ;; Loop thru the text of that file
5404 ;; and get out the names of the files to recover.
5408 ;; This is a pair of lines for a non-file-visiting buffer.
5409 ;; Get the auto-save file name and manufacture
5410 ;; a "visited file name" from that.
5413 ;; If there is no auto-save file name, the
5414 ;; auto-save-list file is probably corrupted.
5427 ;; This pair of lines is a file-visiting
5428 ;; buffer. Use the visited file name.
5438 ;; Ignore a file if its auto-save file does not exist now.
5442 ;; The file contains a pair of line for each auto-saved buffer.
5443 ;; The first line of the pair contains the visited file name
5444 ;; or is empty if the buffer was not visiting a file.
5445 ;; The second line is the auto-save file name.
5453 files
5459 "Kill BUFFER if confirmed."
5467 "Kill some buffers. Asks the user whether to kill each one of them.
5468 Non-interactively, if optional argument LIST is non-nil, it
5469 specifies the list of buffers to kill, asking for approval for each one."
5477 ; if we killed the base buffer.
5484 "Kill buffers whose name matches the specified REGEXP.
5485 The optional second argument indicates whether to kill internal buffers too."
5494 \f
5496 "Adjust current buffer's auto save file name for current conditions.
5497 Also rename any existing auto save file, if it was made in this session."
5509 "Return file name to use for auto-saves of current buffer.
5510 Does not consider `auto-save-visited-file-name' as that variable is checked
5511 before calling this function. You can redefine this for customization.
5512 See also `auto-save-file-name-p'."
5520 result uniq)
5521 ;; Apply user-specified translations
5522 ;; to the file name.
5526 filename)
5536 filename))))
5541 ;; We truncate the file name to DOS 8+3 limits
5542 ;; before doing anything else, because the regexp
5543 ;; passed to string-match below cannot handle
5544 ;; extensions longer than 3 characters, multiple
5545 ;; dots, and other atrocities.
5550 fn)
5555 "#"
5558 ;; Make sure auto-save file names don't contain characters
5559 ;; invalid for the underlying filesystem.
5561 ;; Don't modify remote (ange-ftp) filenames
5564 result))))
5566 ;; Deal with buffers that don't have any associated files. (Mail
5567 ;; mode tends to create a good number of these.)
5571 file-name)
5572 ;; Restrict the characters used in the file name to those which
5573 ;; are known to be safe on all filesystems, url-encoding the
5574 ;; rest.
5575 ;; We do this on all platforms, because even if we are not
5576 ;; running on DOS/Windows, the current directory may be on a
5577 ;; mounted VFAT filesystem, such as a USB memory stick.
5581 ;; For multibyte characters, this will produce more than
5582 ;; 2 hex digits, so is not true URL encoding.
5586 ;; Generate the file name.
5592 ;; Try a few alternative directories, to get one we can
5593 ;; write it.
5599 ;; Don't modify remote (ange-ftp) filenames
5601 ;; The call to convert-standard-filename is in case
5602 ;; buffer-name includes characters not allowed by the
5603 ;; DOS/Windows filesystems. make-temp-file writes to the
5604 ;; file it creates, so we must fix the file name _before_
5605 ;; make-temp-file is called.
5607 fname))
5609 ;; make-temp-file creates the file,
5610 ;; but we don't want it to exist until we do an auto-save.
5614 file-name)))
5617 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5618 FILENAME should lack slashes. You can redefine this for customization."
5620 \f
5622 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5623 The generated regexp will match a filename only if the filename
5624 matches that wildcard according to shell rules. Only wildcards known
5625 by `sh' are supported."
5627 ;; Copy the initial run of non-special characters.
5630 ;; If no special characters, we're almost done.
5634 j)
5636 result
5657 ;; Found "[^". Insert a `\0' character
5658 ;; (which cannot happen in a filename)
5659 ;; into the character class, so that `^'
5660 ;; is not the first character after `[',
5661 ;; and thus non-special in a regexp.
5666 ;; I don't think `]' can appear in a
5667 ;; character class in a wildcard, but
5668 ;; let's be general here.
5675 i
5688 ;; Shell wildcards should match the entire filename,
5689 ;; not its part. Make the regexp say so.
5691 \f
5694 "Switches for `list-directory' to pass to `ls' for brief listing."
5700 "Switches for `list-directory' to pass to `ls' for verbose listing."
5705 "Expand wildcard pattern PATTERN.
5706 This returns a list of file names which match the pattern.
5708 If PATTERN is written as an absolute file name,
5709 the values are absolute also.
5711 If PATTERN is written as a relative file name, it is interpreted
5712 relative to the current default directory, `default-directory'.
5713 The file names returned are normally also relative to the current
5714 default directory. However, if FULL is non-nil, they are absolute."
5718 ;; A list of all dirs that DIRPART specifies.
5719 ;; This can be more than one dir
5720 ;; if DIRPART contains wildcards.
5724 dirpart)))
5728 contents)
5734 ;; Filter out "." and ".."
5739 name))
5746 this-dir-contents)
5747 this-dir-contents)
5748 contents))))
5750 contents)))
5752 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5756 "Display a list of files in or matching DIRNAME, a la `ls'.
5757 DIRNAME is globbed by the shell if necessary.
5758 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5759 Actions controlled by variables `list-directory-brief-switches'
5760 and `list-directory-verbose-switches'."
5764 nil default-directory nil)
5765 pfx)))
5767 list-directory-brief-switches))
5768 buffer)
5780 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5788 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5790 PATTERN is assumed to represent a file-name wildcard suitable for the
5791 underlying filesystem. For Unix and GNU/Linux, each character from the
5793 the parts of the pattern which don't include wildcard characters are
5794 quoted with double quotes.
5797 on Windows), so PATTERN can use them to quote wildcard characters that
5798 need to be passed verbatim to shell commands."
5802 ;; DOS/Windows don't allow `"' in file names. So if the
5803 ;; argument has quotes, we can safely assume it is already
5804 ;; quoted by the caller.
5806 ;; We quote [&()#$'] in case their shell is a port of a
5807 ;; Unixy shell. We quote [,=+] because stock DOS and
5808 ;; Windows shells require that in some cases, such as
5809 ;; passing arguments to batch files that use positional
5810 ;; arguments like %1.
5812 pattern
5815 end)
5832 pattern))))
5839 "Program to get the amount of free space on a file system.
5840 We assume the output has the format of `df'.
5841 The value of this variable must be just a command name or file name;
5842 if you want to specify options, use `directory-free-space-args'.
5844 A value of nil disables this feature.
5846 If the function `file-system-info' is defined, it is always used in
5847 preference to the program given by this variable."
5853 "Options to use when running `directory-free-space-program'."
5858 "Return the amount of free space on directory DIR's file system.
5859 The return value is a string describing the amount of free
5860 space (normally, the number of free 1KB blocks).
5862 This function calls `file-system-info' if it is available, or
5863 invokes the program specified by `directory-free-space-program'
5864 and `directory-free-space-args'. If the system call or program
5865 is unsuccessful, or if DIR is a remote directory, this function
5866 returns nil."
5868 ;; Try to find the number of free blocks. Non-Posix systems don't
5869 ;; always have df, but might have an equivalent system call.
5878 ;; Avoid failure if the default directory does
5879 ;; not exist (Bug#2631, Bug#3911).
5882 nil t nil
5883 directory-free-space-args
5884 dir)
5886 ;; Assume that the "available" column is before the
5887 ;; "capacity" column. Find the "%" and scan backward.
5891 "[[:space:]]+[^[:space:]]+%[^%]*$"
5898 ;; The following expression replaces `dired-move-to-filename-regexp'.
5902 ;; In some locales, month abbreviations are as short as 2 letters,
5903 ;; and they can be followed by ".".
5904 ;; In Breton, a month name can include a quote character.
5917 s "+"
5920 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5921 ;; omits the Kanji characters after month and day-of-month.
5922 ;; On Mac OS X 10.3, the date format in East Asian locales is
5923 ;; day-of-month digits followed by month digits.
5929 ;; The "[0-9]" below requires the previous column to end in a digit.
5930 ;; This avoids recognizing `1 may 1997' as a date in the line:
5931 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5933 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5935 ;; For non-iso date formats, we add the ".*" in order to find
5936 ;; the last possible match. This avoids recognizing
5937 ;; `jservice 10 1024' as a date in the line:
5938 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5940 ;; vc dired listings provide the state or blanks between file
5941 ;; permissions and date. The state is always surrounded by
5942 ;; parentheses:
5943 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5944 ;; This is not supported yet.
5949 "Regular expression to match up to the file name in a directory listing.
5950 The default value is designed to recognize dates and times
5955 ;; insert-directory
5956 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5957 ;; FULL-DIRECTORY-P is nil.
5958 ;; The single line of output must display FILE's name as it was
5959 ;; given, namely, an absolute path name.
5960 ;; - must insert exactly one line for each file if WILDCARD or
5961 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5962 ;; before the file lines, plus optional text after the file lines.
5963 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5964 ;; allowed.
5965 ;; File lines should display the basename.
5966 ;; - must be consistent with
5967 ;; - functions dired-move-to-filename, (these two define what a file line is)
5968 ;; dired-move-to-end-of-filename,
5969 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5970 ;; dired-insert-headerline
5971 ;; dired-after-subdir-garbage (defines what a "total" line is)
5972 ;; - variable dired-subdir-regexp
5973 ;; - may be passed "--dired" as the first argument in SWITCHES.
5974 ;; Filename handlers might have to remove this switch if their
5975 ;; "ls" command does not support it.
5977 "Insert directory listing for FILE, formatted according to SWITCHES.
5978 Leaves point after the inserted text.
5979 SWITCHES may be a string of options, or a list of strings
5980 representing individual options.
5981 Optional third arg WILDCARD means treat FILE as shell wildcard.
5982 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5983 switches do not contain `d', so that a full listing is expected.
5985 This works by running a directory listing program
5986 whose name is in the variable `insert-directory-program'.
5987 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5989 When SWITCHES contains the long `--dired' option, this function
5990 treats it specially, for the sake of dired. However, the
5991 normally equivalent short `-D' option is just passed on to
5992 `insert-directory-program', as any other option."
5993 ;; We need the directory in order to find the right handler.
5998 wildcard full-directory-p)
6001 ;; Read the actual directory using `insert-directory-program'.
6002 ;; RESULT gets the status code.
6004 ;; putting text property `dired-filename, decode one
6005 ;; bunch by one to preserve that property.
6007 ;; This is to control encoding the arguments in call-process.
6011 default-file-name-coding-system))))
6014 ;; Run ls in the directory part of the file pattern
6015 ;; using the last component as argument.
6021 ;; NB since switches is passed to the shell, be
6022 ;; careful of malicious values, eg "-l;reboot".
6023 ;; See eg dired-safe-switches-p.
6025 shell-file-name nil t nil
6026 "-c"
6028 ""
6030 insert-directory-program
6031 " -d "
6033 switches
6035 " -- "
6036 ;; Quote some characters that have
6037 ;; special meanings in shells; but
6038 ;; don't quote the wildcards--we want
6039 ;; them to be special. We also
6040 ;; currently don't quote the quoting
6041 ;; characters in case people want to
6042 ;; use them explicitly to quote
6043 ;; wildcard characters.
6045 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6046 ;; directory if FILE is a symbolic link.
6053 insert-directory-program nil t nil
6057 ;; Split the switches at any spaces so we can
6058 ;; pass separate options as separate args.
6060 ;; Avoid lossage if FILE starts with `-'.
6068 file))))))))
6070 ;; If we got "//DIRED//" in the output, it means we got a real
6071 ;; directory listing, even if `ls' returned nonzero.
6072 ;; So ignore any errors.
6085 ;; The first time ls returns an error,
6086 ;; find the version numbers of ls,
6087 ;; and set insert-directory-ls-version
6088 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6089 ;; is equal or if the info cannot be obtained.
6090 ;; (That can mean it isn't GNU ls.)
6100 comparison)
6116 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6120 ;; If `insert-directory-program' failed, signal an error.
6122 ;; Delete the error message it may have output.
6124 ;; On non-Posix systems, we cannot open a directory, so
6125 ;; don't even try, because that will always result in
6126 ;; the ubiquitous "Access denied". Instead, show the
6127 ;; command line so the user can try to guess what went wrong.
6132 insert-directory-program
6134 file result)
6135 ;; Unix. Access the file to get a suitable error.
6142 ;; The following overshoots by one line for an empty
6143 ;; directory listed with "--dired", but without "-a"
6144 ;; switch, where the ls output contains a
6145 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6146 ;; We take care of that case later.
6154 error-lines)
6155 ;; Find all the lines that are error messages,
6156 ;; and record the bounds of each one.
6163 ;; Now read the numeric positions of file names.
6170 error-lines))
6173 error-lines)))
6175 ;; End is followed by \n or by " -> ".
6177 ;; It seems that we can't trust ls's output as to
6178 ;; byte positions of filenames.
6184 ;; Take care of the case where the ls output contains a
6185 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6186 ;; and we went one line too far back (see above).
6191 ;; Now decode what read if necessary.
6193 file-name-coding-system
6194 default-file-name-coding-system
6196 coding-no-eol
6197 val pos)
6201 ;; If no coding system is specified or detection is
6202 ;; requested, detect the coding.
6216 ;; Force no eol conversion on a file name, so
6217 ;; that CR is preserved.
6225 ;; Try to insert the amount of free space.
6228 ;; First find the line to put it on.
6232 ;; Replace "total" with "used", to avoid confusion.
6238 "Convert `ls --dired' file name position value POS to a buffer position.
6239 File name position values returned in ls --dired output
6240 count only stdout; they don't count the error messages sent to stderr.
6241 So this function converts to them to real buffer positions.
6242 ERROR-LINES is a list of buffer positions of error message lines,
6243 of the form (START END)."
6247 pos)
6251 "Insert directory listing for FILE, formatted according to SWITCHES.
6253 Like `insert-directory', but if FILE does not exist, it inserts a
6254 message to that effect instead of signaling an error."
6257 ;; Simulate the message printed by `ls'.
6261 "Functions to call with no arguments to query about killing Emacs.
6262 If any of these functions returns nil, killing Emacs is canceled.
6263 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6267 "How to ask for confirmation when leaving Emacs.
6268 If nil, the default, don't ask at all. If the value is non-nil, it should
6269 be a predicate function such as `yes-or-no-p'."
6277 "Offer to save each buffer, then kill this Emacs process.
6278 With prefix ARG, silently save all file-visiting buffers, then kill."
6287 ;; process-list is not defined on MSDOS.
6289 active)
6298 ;; Query the user for other things, perhaps.
6305 "Offer to save each buffer, then kill the current connection.
6306 If the current frame has no client, kill Emacs itself.
6308 With prefix ARG, silently save all file-visiting buffers, then kill.
6310 If emacsclient was started with a list of filenames to edit, then
6311 only these files will be asked to be saved."
6316 \f
6317 ;; We use /: as a prefix to "quote" a file name
6318 ;; so that magic file name handlers will not apply to it.
6322 file-name-handler-alist))
6324 ;; We depend on being the last handler on the list,
6325 ;; so that anything else which does need handling
6326 ;; has been handled already.
6327 ;; So it is safe for us to inhibit *all* magic file name handlers.
6336 default-directory))
6337 ;; Get a list of the indices of the args which are file names.
6340 ;; The first six are special because they
6341 ;; return a file name. We want to include the /:
6342 ;; in the return value.
6343 ;; So just avoid stripping it in the first place.
6350 ;; `identity' means just return the first arg
6351 ;; not stripped of its quoting.
6353 ;; `add' means add "/:" to the result.
6356 ;; `unquote-then-quote' means set buffer-file-name
6357 ;; temporarily to unquoted filename.
6359 ;; List the arguments which are filenames.
6367 ;; For all other operations, treat the first argument only
6368 ;; as the file name.
6370 method
6371 ;; Copy ARGUMENTS so we can replace elements in it.
6375 ;; Strip off the /: from the file names that have it.
6383 "/"
6400 \f
6401 ;; Symbolic modes and read-file-modes.
6404 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6405 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6406 Others, or All) for whom to produce the mask.
6407 The bit-mask that is returned extracts from mode bits the access rights
6408 for the specified category of users."
6416 "Convert CHAR to a numeric value of mode bits.
6417 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6418 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6425 ;; Rights relative to the previous file modes.
6436 "Convert a symbolic mode string specification to an equivalent number.
6438 WHO-MASK is the bit-mask specifying the category of users to which to
6439 apply the access permissions. See `file-modes-char-to-who'.
6440 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6441 RIGHTS request to add, remove, or set permissions based on existing ones,
6448 char-right)
6455 num-rights
6459 op char-right)))
6460 num-rights))
6463 "Convert symbolic file modes to numeric file modes.
6464 MODES is the string to convert, it should match
6466 See Info node `(coreutils)File permissions' for more information on this
6467 notation.
6468 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6469 MODES request to add, remove, or set permissions based on existing ones,
6483 num-who num-modes)
6486 num-modes)))
6489 "Read file modes in octal or symbolic notation and return its numeric value.
6490 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6491 ORIG-FILE is the name of a file on whose mode bits to base returned
6492 permissions if what user types requests to add, remove, or set permissions
6508 nil nil default)))
6514 \f
6515 ;; Trashcan handling.
6517 "Directory for `move-file-to-trash' to move files and directories to.
6518 This directory is only used when the function `system-move-file-to-trash'
6519 is not defined.
6520 Relative paths are interpreted relative to `default-directory'.
6521 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6531 "Move the file (or directory) named FILENAME to the trash.
6532 When `delete-by-moving-to-trash' is non-nil, this function is
6533 called by `delete-file' and `delete-directory' instead of
6534 deleting files outright.
6536 If the function `system-move-file-to-trash' is defined, call it
6537 with FILENAME as an argument.
6538 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6539 directory.
6540 Otherwise, trash FILENAME using the freedesktop.org conventions,
6541 like the GNOME, KDE and XFCE desktop environments. Emacs only
6545 ;; If `trash-directory' is non-nil, move the file there.
6549 trash-dir)))
6550 ;; We can't trash a parent directory of trash-directory.
6553 trash-dir filename))
6556 ;; Ensure that the trashed file-name is unique.
6563 ;; If `system-move-file-to-trash' is defined, use it.
6566 ;; Otherwise, use the freedesktop.org method, as specified at
6567 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6578 ;; Check if we have permissions to delete.
6582 ;; The trashed file cannot be the trash dir or its parent.
6585 trash-files-dir filename))
6588 trash-info-dir filename))
6590 ;; Ensure that the trash directory exists; otherwise, create it.
6601 ;; Try to move to trash with .trashinfo undo information
6606 ;; Perform url-encoding on FN. For compatibility with
6607 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6608 ;; for path separators.
6613 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6614 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6627 fn))
6632 ;; Attempt to make .trashinfo file, trying up to 5
6633 ;; times. The .trashinfo file is opened with O_EXCL,
6634 ;; as per trash-spec 0.7, even if that can be a problem
6635 ;; on old NFS versions...
6639 trash-files-dir))
6641 success info-fn)
6646 trash-info-dir))
6654 ;; Uniquify new-fn. (Some file managers do not
6655 ;; like Emacs-style backup file names---e.g. bug
6656 ;; 170956 in Konqueror bug tracker.)
6661 ;; Finally, try to move the file to the trashcan.
6665 \f
6690 ;;; files.el ends here