| blob | 0673b4fe56b735dca603261e2d12570d054d3782 |
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))))
913 ;; FIXME? maybe this function should (optionally?)
914 ;; use file-readable-p instead. In many cases, an unreadable
915 ;; FILE is no better than a non-existent one.
916 ;; See eg dir-locals-find-file.
922 root))
926 "Search for COMMAND in `exec-path' and return the absolute file name.
927 Return nil if COMMAND is not found anywhere in `exec-path'."
928 ;; Use 1 rather than file-executable-p to better match the behavior of
929 ;; call-process.
933 "Load the Emacs Lisp library named LIBRARY.
934 This is an interface to the function `load'. LIBRARY is searched
935 for in `load-path', both with and without `load-suffixes' (as
936 well as `load-file-rep-suffixes').
938 See Info node `(emacs)Lisp Libraries' for more details.
939 See `load-file' for a different interface to `load'."
943 load-path
948 "Test whether FILE specifies a location on a remote system.
949 A file is considered remote if accessing it is likely to
950 be slower or less reliable than accessing local files.
952 `file-remote-p' never opens a new remote connection. It can
953 only reuse a connection that is already open.
955 Return nil or a string identifying the remote connection
956 \(ideally a prefix of FILE). Return nil if FILE is a relative
957 file name.
959 When IDENTIFICATION is nil, the returned string is a complete
960 remote identifier: with components method, user, and host. The
961 components are those present in FILE, with defaults filled in for
962 any that are missing.
964 IDENTIFICATION can specify which part of the identification to
965 return. IDENTIFICATION can be the symbol `method', `user',
966 `host', or `localname'. Any other value is handled like nil and
967 means to return the complete identification. The string returned
968 for IDENTIFICATION `localname' can differ depending on whether
969 there is an existing connection.
971 If CONNECTED is non-nil, return an identification only if FILE is
972 located on a remote system and a connection is established to
973 that remote system.
975 Tip: You can use this expansion of remote identifier components
976 to derive a new remote file name from an existing one. For
982 same remote identifier as FILE but expanded; a name such as
987 nil)))
990 "Whether to use the remote file-name cache for read access.
991 When `nil', never expire cached values (caution)
992 When `t', never use the cache (safe, but may be slow)
993 A number means use cached values for that amount of seconds since caching.
995 The attributes of remote files are cached for better performance.
996 If they are changed outside of Emacs's control, the cached values
997 become invalid, and must be reread. If you are sure that nothing
998 other than Emacs changes the files, you can set this variable to `nil'.
1000 If a remote file is checked regularly, it might be a good idea to
1001 let-bind this variable to a value less than the interval between
1002 consecutive checks. For example:
1004 (defun display-time-file-nonempty-p (file)
1005 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1006 (and (file-exists-p file)
1007 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1018 "Copy the file FILE into a temporary file on this machine.
1019 Returns the name of the local copy, or nil, if FILE is directly
1020 accessible."
1021 ;; This formerly had an optional BUFFER argument that wasn't used by
1022 ;; anything.
1026 nil)))
1029 "Return the truename of FILENAME.
1030 If FILENAME is not absolute, first expands it against `default-directory'.
1031 The truename of a file name is found by chasing symbolic links
1032 both at the level of the file and at the level of the directories
1033 containing it, until no links are left at any level.
1036 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1037 ;; COUNTER can be a cons cell whose car is the count of how many
1038 ;; more links to chase before getting an error.
1039 ;; PREV-DIRS can be a cons cell whose car is an alist
1040 ;; of truenames we've just recently computed.
1054 ;; For speed, remove the ange-ftp completion handler from the list.
1055 ;; We know it's not needed here.
1056 ;; For even more speed, do this only on the outermost call.
1063 ;; andrewi@harlequin.co.uk - none of the following code (except for
1064 ;; invoking the file-name handler) currently applies on Windows
1065 ;; (ie. there are no native symlinks), but there is an issue with
1066 ;; case differences being ignored by the OS, and short "8.3 DOS"
1067 ;; name aliases existing for all files. (The short names are not
1068 ;; reported by directory-files, but can be used to refer to files.)
1069 ;; It seems appropriate for file-truename to resolve these issues in
1070 ;; the most natural way, which on Windows is to call the function
1071 ;; `w32-long-file-name' - this returns the exact name of a file as
1072 ;; it is stored on disk (expanding short name aliases with the full
1073 ;; name in the process).
1076 ;; For file name that has a special handler, call handler.
1077 ;; This is so that ange-ftp can save time by doing a no-op.
1080 ;; If filename contains a wildcard, newname will be the old name.
1082 ;; If filename exists, use the long name. If it doesn't exist,
1083 ;; drill down until we find a directory that exists, and use
1084 ;; the long name of that, with the extra non-existent path
1085 ;; components concatenated.
1087 missing rest)
1090 ;; Include the preceding directory separator in the missing
1091 ;; part so subsequent recursion on the rest works.
1096 ""
1101 ;; If this file directly leads to a link, process that iteratively
1102 ;; so that we don't use lots of stack.
1108 ;; For file name that has a special handler, call handler.
1109 ;; This is so that ange-ftp can save time by doing a no-op.
1112 done t)
1114 target dirfile)
1115 ;; Get the truename of the directory.
1117 ;; If these are equal, we have the (or a) root directory.
1119 ;; If this is the same dir we last got the truename for,
1120 ;; save time--don't recalculate.
1130 done t)
1133 done t)
1134 ;; Put it back on the file name.
1136 ;; Is the file name the name of a link?
1139 ;; Yes => chase that link, then start all over
1140 ;; since the link may point to a directory name that uses links.
1141 ;; We can't safely use expand-file-name here
1142 ;; since target might look like foo/../bar where foo
1143 ;; is itself a link. Instead, we handle . and .. above.
1146 target
1148 done nil)
1149 ;; No, we are done!
1151 filename))
1154 "Chase links in FILENAME until a name that is not a link.
1155 Unlike `file-truename', this does not check whether a parent
1156 directory name is a symbolic link.
1157 If the optional argument LIMIT is a number,
1158 it means chase no more than that many links and then stop."
1166 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1169 ;; Handle `..' by hand, since it needs to work in the
1170 ;; target of any directory symlink.
1171 ;; This code is not quite complete; it does not handle
1172 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1176 ;; Chase links in the default dir of the symlink.
1180 ;; Now find the parent of that dir.
1184 newname))
1186 ;; A handy function to display file sizes in human-readable form.
1187 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1189 "Produce a string showing FILE-SIZE in human-readable form.
1191 Optional second argument FLAVOR controls the units and the display format:
1193 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1195 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1197 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1200 1024.0
1203 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1209 "%.1f%s%s"
1211 file-size
1213 "K"
1218 "Create a temporary file.
1219 The returned file name (created by appending some random characters at the end
1220 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1221 is guaranteed to point to a newly created empty file.
1222 You can then use `write-region' to write new data into the file.
1224 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1226 If SUFFIX is non-nil, add that at the end of the file name."
1228 file)
1231 ;; Create temp files with strict access rights. It's easy to
1232 ;; loosen them later, whereas it's impossible to close the
1233 ;; time-window of loose permissions otherwise.
1241 temporary-file-directory)
1243 temporary-file-directory))))
1249 nil)
1251 ;; the file was somehow created by someone else between
1252 ;; `make-temp-name' and `write-region', let's try again.
1253 nil)
1254 file)
1255 ;; Reset the umask.
1259 "Change the encoding of FILE's name from CODING to NEW-CODING.
1260 The value is a new name of FILE.
1261 Signals a `file-already-exists' error if a file of the new name
1262 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1263 is non-nil. A number as fourth arg means request confirmation if
1264 the new name already exists. This is what happens in interactive
1265 use with M-x."
1268 default-file-name-coding-system))
1270 from-coding to-coding)
1272 ;; We provide the default coding only when it seems that
1273 ;; the filename is correctly decoded by the default
1274 ;; coding.
1280 filename default-coding)
1281 default-coding))
1285 ;; We provide the default coding only when a user is going to
1286 ;; change the encoding not from the default coding.
1290 filename from-coding)))
1293 filename from-coding default-coding)
1294 default-coding)))
1298 default-file-name-coding-system))
1299 ;; FILE should have been decoded by DEFAULT-CODING.
1303 ;; Suppress further encoding.
1308 newname))
1309 \f
1311 "Whether confirmation is requested before visiting a new file or buffer.
1312 If nil, confirmation is not requested.
1313 If the value is `after-completion', confirmation is only
1314 requested if the user called `minibuffer-complete' right before
1315 `minibuffer-complete-and-exit'.
1316 Any other non-nil value means to request confirmation.
1318 This affects commands like `switch-to-buffer' and `find-file'."
1326 "Whether to request confirmation before visiting a new file or buffer.
1327 The variable `confirm-nonexistent-file-or-buffer' determines the
1328 return value, which may be passed as the REQUIRE-MATCH arg to
1329 `read-buffer' or `find-file-read-args'."
1337 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1338 BODY should use the minibuffer at most once.
1339 Recursive uses of the minibuffer are unaffected (FUN is not
1340 called additional times).
1342 This macro actually adds an auxiliary function that calls FUN,
1343 rather than FUN itself, to `minibuffer-setup-hook'."
1349 ;; Clear out this hook so it does not interfere
1350 ;; with any recursive minibuffer usage.
1361 t))
1364 "Edit file FILENAME.
1365 Switch to a buffer visiting file FILENAME,
1366 creating one if none already exists.
1367 Interactively, the default if you just type RET is the current directory,
1368 but the visited file name is available through the minibuffer history:
1369 type M-n to pull it into the minibuffer.
1371 You can visit files on remote machines by specifying something
1372 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1373 also visit local files as a different user by specifying
1374 /sudo::FILE for the file name.
1375 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1376 manual, for more about this.
1378 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1379 expand wildcards (if any) and visit multiple files. You can
1380 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1382 To visit a file without any kind of conversion and without
1393 "Edit file FILENAME, in another window.
1396 an existing one. See the function `display-buffer'.
1398 Interactively, the default if you just type RET is the current directory,
1399 but the visited file name is available through the minibuffer history:
1400 type M-n to pull it into the minibuffer.
1402 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1403 expand wildcards (if any) and visit multiple files."
1416 "Edit file FILENAME, in another frame.
1419 an existing one. See the function `display-buffer'.
1421 Interactively, the default if you just type RET is the current directory,
1422 but the visited file name is available through the minibuffer history:
1423 type M-n to pull it into the minibuffer.
1425 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1426 expand wildcards (if any) and visit multiple files."
1439 "Edit the existing file FILENAME.
1441 file names with wildcards."
1450 "Edit file FILENAME but don't allow changes.
1464 value))
1467 "Edit file FILENAME in another window but don't allow changes.
1481 value))
1484 "Edit file FILENAME in another frame but don't allow changes.
1498 value))
1501 "Find file FILENAME as a replacement for the file in the next window.
1502 This command does not select that window.
1506 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1507 expand wildcards (if any) and replace the file with multiple files."
1518 "Find alternate file: " file-dir nil
1520 t))))
1530 "Find file FILENAME, select its buffer, kill previous buffer.
1531 If the current buffer now contains an empty file that you just visited
1532 \(presumably by mistake), use this command to visit the file you really want.
1536 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1537 expand wildcards (if any) and replace the file with multiple files.
1539 If the current buffer is an indirect buffer, or the base buffer
1540 for one or more indirect buffers, the other buffer(s) are not
1541 killed."
1550 "Find alternate file: " file-dir nil
1552 t)))
1567 ;; Run `kill-buffer-hook' here. It needs to happen before
1568 ;; variables like `buffer-file-name' etc are set to nil below,
1569 ;; because some of the hooks that could be invoked
1570 ;; (e.g., `save-place-to-alist') depend on those variables.
1571 ;;
1572 ;; Note that `kill-buffer-hook' is not what queries whether to
1573 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1574 ;; asks that itself. Thus, there's no need to temporarily do
1575 ;; `(set-buffer-modified-p nil)' before running this hook.
1577 ;; Okay, now we can end-of-life the old buffer.
1584 ;; This prevents us from finding the same buffer
1585 ;; if we specified the same file again.
1589 ;; Likewise for dired buffers.
1593 ;; This executes if find-file gets an error
1594 ;; and does not really find anything.
1595 ;; We put things back as they were.
1596 ;; If find-file actually finds something, we kill obuf below.
1605 ;; We already ran these; don't run them again.
1608 \f
1610 "Create a suitably named buffer for visiting FILENAME, and return it.
1611 FILENAME (sans directory) is used unchanged if that name is free;
1612 otherwise a string <2> or <3> or ... is appended to get an unused name.
1613 Spaces at the start of FILENAME (sans directory) are removed."
1622 "Create and return a buffer with a name based on NAME.
1623 Choose the buffer's name using `generate-new-buffer-name'."
1627 "Regexp to match the automounter prefix in a directory name."
1635 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1637 home directory is a root directory) and removes automounter prefixes
1638 \(see the variable `automount-dir-prefix')."
1639 ;; Get rid of the prefixes added by the automounter.
1646 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1647 ;; To fix this right, we need a `file-name-case-sensitive-p'
1648 ;; function, but we don't have that yet, so just guess.
1651 ;; If any elt of directory-abbrev-alist matches this name,
1652 ;; abbreviate accordingly.
1658 ;; Compute and save the abbreviated homedir name.
1659 ;; We defer computing this until the first time it's needed, to
1660 ;; give time for directory-abbrev-alist to be set properly.
1661 ;; We include a slash at the end, to avoid spurious matches
1662 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1669 ;; If FILENAME starts with the abbreviated homedir,
1670 ;; make it start with `~' instead.
1672 ;; If the home dir is just /, don't change it.
1675 ;; MS-DOS root directories can come with a drive letter;
1676 ;; Novell Netware allows drive letters beyond `Z:'.
1684 filename)))
1687 "Return the buffer visiting file FILENAME (a string).
1688 This is like `get-file-buffer', except that it checks for any buffer
1689 visiting the same file, possibly under a different name.
1690 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1691 and others are ignored.
1692 If there is no such live buffer, return nil."
1705 found)
1715 ;; Verify this buffer's file number
1716 ;; still belongs to its file.
1719 attributes)
1723 found))))
1724 \f
1726 "Non-nil means file-visiting commands should handle wildcards.
1727 For example, if you specify `*.c', that would visit all the files
1728 whose names match the pattern."
1734 "Non-nil means suppress warning messages for symlinked files.
1735 When nil, Emacs prints a warning when visiting a file that is already
1736 visited, but with a different name. Setting this option to t
1737 suppresses this warning."
1743 "Maximum size of file above which a confirmation is requested.
1744 When nil, never request confirmation."
1751 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1752 OP-TYPE specifies the file operation being performed (for message to user)."
1761 "Read file FILENAME into a buffer and return the buffer.
1762 If a buffer exists visiting FILENAME, return that one, but
1763 verify that the file has not changed since visited or saved.
1764 The buffer is not selected, just returned to the caller.
1765 Optional second arg NOWARN non-nil means suppress any warning messages.
1766 Optional third arg RAWFILE non-nil means the file is read literally.
1767 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1768 and visit all the matching files. When wildcards are actually
1769 used and expanded, return a list of buffers that are visiting
1770 the various files."
1777 'find-directory-functions
1780 filename)))
1783 find-file-wildcards
1797 ;; Find any buffer for a file which has same truename.
1799 ;; Let user know if there is a buffer with the same truename.
1803 find-file-suppress-same-file-warnings
1807 ;; Optionally also find that buffer.
1810 ;; Check to see if the file looks uncommonly large.
1814 ;; We are using an existing buffer.
1821 ;; Certain files should be reverted automatically
1822 ;; if they have changed on disk and not in the buffer.
1830 found))
1840 "File %s changed on disk. Discard your edits? "
1845 "File %s changed on disk. Discard your edits in %s? "
1853 ;; Check if a formerly read-only file has become
1854 ;; writable and vice versa, but if the buffer agrees
1855 ;; with the new state of the file, that is ok too.
1863 buffer-file-name
1872 ;; It is confusing to ask whether to visit
1873 ;; non-literally if they have the file in
1874 ;; hexl-mode or image-mode.
1880 "The file %s is already visited normally,
1881 and you have edited the buffer. Now you have asked to visit it literally,
1882 meaning no coding system handling, format conversion, or local variables.
1883 Emacs can only visit a file in one way at a time.
1885 Do you want to save the file, and visit it literally instead? "
1886 "The file %s is already visited literally,
1887 meaning no coding system handling, format conversion, or local variables.
1888 You have edited the buffer. Now you have asked to visit the file normally,
1889 but Emacs can only visit a file in one way at a time.
1896 rawfile truename number))
1900 "\
1901 Do you want to discard your changes, and visit the file literally now? "
1902 "\
1905 rawfile truename number)
1911 "The file %s is already visited normally.
1912 You have asked to visit it literally,
1913 meaning no coding system decoding, format conversion, or local variables.
1914 But Emacs can only visit a file in one way at a time.
1916 Do you want to revisit the file literally now? "
1917 "The file %s is already visited literally,
1918 meaning no coding system decoding, format conversion, or local variables.
1919 You have asked to visit it normally,
1920 but Emacs can only visit a file in one way at a time.
1925 rawfile truename number)
1928 ;; Return the buffer we are using.
1929 buf)
1930 ;; Create a new buffer.
1932 ;; find-file-noselect-1 may use a different buffer.
1934 rawfile truename number))))))
1940 ;; Needed in case we are re-visiting the file with a different
1941 ;; text representation.
1958 filename)))
1959 ;; Unconditionally set error
1969 filename)))
1970 ;; Run find-file-not-found-functions until one returns non-nil.
1972 ;; If they fail too, set error.
1974 ;; Record the file's truename, and maybe use that as visited name.
1982 ;; Set buffer's default directory to that of the file.
1984 ;; Turn off backup files for certain file names. Since
1985 ;; this is a permanent local, the major mode won't eliminate it.
2000 \f
2002 "Like `insert-file-contents', but only reads in the file literally.
2003 A buffer may be modified in several ways after reading into the buffer,
2004 to Emacs features such as format decoding, character code
2005 conversion, `find-file-hook', automatic uncompression, etc.
2007 This function ensures that none of these modifications will take place."
2015 nil))
2018 inhibit-file-name-handlers))
2031 filename)))
2032 ;; Check whether the file is uncommonly large
2043 "Insert contents of file FILENAME into buffer after point with no conversion.
2045 This function is meant for the user to run interactively.
2046 Don't call it from programs! Use `insert-file-contents-literally' instead.
2047 \(Its calling sequence is different; see its documentation)."
2052 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2053 This has the `permanent-local' property, which takes effect if you
2058 "Visit file FILENAME with no conversion of any kind.
2059 Format conversion and character code conversion are both disabled,
2060 and multibyte characters are disabled in the resulting buffer.
2061 The major mode used is Fundamental mode regardless of the file name,
2062 and local variable specifications in the file are ignored.
2063 Automatic uncompression and adding a newline at the end of the
2064 file due to `require-final-newline' is also disabled.
2066 You cannot absolutely rely on this function to result in
2067 visiting the file literally. If Emacs already has a buffer
2068 which is visiting the file, you get the existing buffer,
2069 regardless of whether it was created literally or not.
2071 In a Lisp program, if you want to be sure of accessing a file's
2072 contents literally, you should create a temporary buffer and then read
2073 the file contents into it using `insert-file-contents-literally'."
2076 "Find file literally: " nil default-directory
2079 \f
2081 _after-find-file-from-revert-buffer
2082 nomodes)
2083 "Called after finding a file and by the default revert function.
2084 Sets buffer mode, parses local variables.
2085 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2086 error in reading the file. WARN non-nil means warn if there
2087 exists an auto-save file more recent than the visited file.
2088 NOAUTO means don't mess with auto-save mode.
2089 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2090 \(see `revert-buffer-in-progress-p' for similar functionality).
2091 Fifth arg NOMODES non-nil means don't alter the file's modes.
2092 Finishes by calling the functions in `find-file-hook'
2093 unless NOMODES is non-nil."
2096 nil
2106 "Symbolic link that points to nonexistent file"
2110 ;; No need to warn if buffer is auto-saved
2111 ;; under the name of the visited file.
2113 auto-save-visited-file-name))
2116 buffer-file-name))
2136 ;; Make people do a little extra work (C-x C-q)
2137 ;; before altering a backup file.
2140 ;; When a file is marked read-only,
2141 ;; make the buffer read-only even if root is looking at it.
2149 ;; If requested, add a newline at the end of the file.
2159 view-read-only
2165 "Eval BODY and turn any error into a FORMAT message.
2166 FORMAT can have a %s escape which will be replaced with the actual error.
2167 If `debug-on-error' is set, errors are not caught, so that you can
2168 debug them.
2169 Avoid using a large BODY since it is duplicated."
2178 "Choose the major mode for this buffer automatically.
2179 Also sets up any specified local variables of the file.
2180 Uses the visited file name, the -*- line, and the local variables spec.
2182 This function is called automatically from `find-file'. In that case,
2183 we may set up the file-specified mode and local variables,
2184 depending on the value of `enable-local-variables'.
2185 In addition, if `local-enable-local-variables' is nil, we do
2186 not set local variables (though we do notice a mode specified with -*-.)
2188 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2189 or from Lisp without specifying the optional argument FIND-FILE;
2190 in that case, this function acts as if `enable-local-variables' were t."
2194 ;; FIXME this is less efficient than it could be, since both
2195 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2200 ;; Turn font lock off and on, to make sure it takes account of
2201 ;; whatever file local variables are relevant to it.
2203 ;; Font-lock-mode (now in font-core.el) can be ON when
2204 ;; font-lock.el still hasn't been loaded.
2214 "Non-nil means to try second pass through `auto-mode-alist'.
2215 This means that if the first case-sensitive search through the alist fails
2216 to find a matching major mode, a second case-insensitive search is made.
2217 On systems with case-insensitive file names, this variable is ignored,
2218 since only a single case-insensitive search through the alist is made."
2224 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2225 ;; c++-mode, java-mode and more) are added through autoload
2226 ;; directives in that file. That way is discouraged since it
2227 ;; spreads out the definition of the initial value.
2271 ;; Less common extensions come here
2272 ;; so more common ones above are found faster.
2280 ;; Besides .gdbinit, gdb documents other names to be usable for init
2281 ;; files, cross-debuggers can use something like
2282 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2283 ;; don't interfere with each other.
2315 ;; The Fortran standard does not say anything about file extensions.
2316 ;; .f90 was widely used for F90, now we seem to be trapped into
2317 ;; using a different extension for each language revision.
2318 ;; Anyway, the following extensions are supported by gfortran.
2326 ;; The list of archive file extensions should be in sync with
2327 ;; `auto-coding-alist' with `no-conversion' coding system.
2333 ;; Mailer puts message to be edited in
2334 ;; /tmp/Re.... or Message
2337 ;; some news reader is reported to use this
2348 ;; .emacs or .gnus or .viper following a directory delimiter in
2349 ;; Unix, MSDOG or VMS syntax.
2352 ;; _emacs following a directory delimiter
2353 ;; in MsDos syntax
2357 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2358 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2359 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2362 ;; .xs is also used for ld scripts, but seems to be more commonly
2363 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2365 ;; Explained in binutils ld/genscripts.sh. Eg:
2366 ;; A .x script file is the default script.
2367 ;; A .xr script is for linking without relocation (-r flag). Etc.
2371 ;; Common Lisp ASDF package system.
2378 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2390 ;; Windows candidates may be opened case sensitively on Unix
2396 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2397 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2398 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2399 ;; this has lower priority to avoid matching changelog.sgml etc.
2401 ;; either user's dot-files or under /etc or some such
2403 ;; alas not all ~/.*rc files are like this
2404 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2409 ;; this contains everything twice, with space and with colon :-(
2411 ;; Get rid of any trailing .n.m and try again.
2412 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2413 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2414 ;; Using mode nil rather than `ignore' would let the search continue
2415 ;; through this list (with the shortened name) rather than start over.
2418 ;; This should come after "in" stripping (e.g. config.h.in).
2419 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2421 ;; The following should come after the ChangeLog pattern
2422 ;; for the sake of ChangeLog.1, etc.
2423 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2425 "Alist of filename patterns vs corresponding major mode functions.
2426 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2427 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2428 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2429 mode function to use. FUNCTION will be called, unless it is nil.
2431 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2432 calling FUNCTION (if it's not nil), we delete the suffix that matched
2433 REGEXP and search the list again for another match.
2435 The extensions whose FUNCTION is `archive-mode' should also
2436 appear in `auto-coding-alist' with `no-conversion' coding system.
2438 See also `interpreter-mode-alist', which detects executable script modes
2439 based on the interpreters they specify to run,
2444 "Select Conf mode or XML mode according to start of file."
2454 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2455 ;; and pike-mode) are added through autoload directives in that
2456 ;; file. That way is discouraged since it spreads out the
2457 ;; definition of the initial value.
2497 "Alist mapping interpreter names to major modes.
2498 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2499 Each element looks like (INTERPRETER . MODE).
2500 If INTERPRETER matches the name of the interpreter specified in the first line
2501 of a script, mode MODE is enabled.
2508 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2509 ;; because we are duplicating info from auto-mode-alist.
2510 ;; TODO many elements of this list are also in auto-coding-alist.
2518 "List of regexps matching file names in which to ignore local variables.
2520 Files matching this list are typically binary file formats.
2521 They may happen to contain sequences that look like local variable
2522 specifications, but are not really, or they may be containers for
2523 member files with their own local variable sections, which are
2524 not appropriate for the containing file.
2531 "List of regexps matching suffixes to remove from file names.
2532 When checking `inhibit-local-variables-regexps', we first discard
2535 ;; TODO explicitly add case-fold-search t?
2537 "Return non-nil if file local variables should be ignored.
2538 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2539 and `inhibit-local-variables-suffixes'."
2547 sufs)
2552 temp))
2557 "Regexp matching interpreters, for file mode determination.
2558 This regular expression is matched against the first line of a file
2559 to determine the file's mode in `set-auto-mode'. If it matches, the file
2560 is assumed to be interpreted by the interpreter matched by the second group
2561 of the regular expression. The mode is then determined as the mode
2565 "Alist of buffer beginnings vs. corresponding major mode functions.
2566 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2567 After visiting a file, if REGEXP matches the text at the beginning of the
2568 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2569 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2570 major mode.
2572 If FUNCTION is nil, then it is not called. (That is a way of saying
2580 ;; The < comes before the groups (but the first) to reduce backtracking.
2581 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2582 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2586 comment-re "*"
2589 . html-mode)
2591 ;; These two must come after html, because they are more general:
2596 . sgml-mode)
2599 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2600 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2601 After visiting a file, if REGEXP matches the text at the beginning of the
2602 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2603 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2604 have not specified a mode for this file.
2610 "Upper limit on `magic-mode-alist' regexp matches.
2614 "Select major mode appropriate for current buffer.
2616 To find the right major mode, this function checks for a -*- mode tag
2617 checks for a `mode:' entry in the Local Variables section of the file,
2618 checks if it uses an interpreter listed in `interpreter-mode-alist',
2619 matches the buffer beginning against `magic-mode-alist',
2620 compares the filename against the entries in `auto-mode-alist',
2621 then matches the buffer beginning against `magic-fallback-mode-alist'.
2623 If `enable-local-variables' is nil, or if the file name matches
2624 `inhibit-local-variables-regexps', this function does not check
2625 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2626 is nil, then the only mode: tag that can be relevant is a -*- one.
2628 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2629 set the major mode only if that would change it. In other words
2630 we don't actually set it to the same mode the buffer already has."
2631 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2633 end done mode modes)
2634 ;; Once we drop the deprecated feature where mode: is also allowed to
2635 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2636 ;; remove this section and just let (hack-local-variables t) handle it.
2637 ;; Find a -*- mode tag.
2641 ;; Note by design local-enable-local-variables does not matter here.
2643 try-locals
2646 ;; Find all specifications for the `mode:' variable
2647 ;; and execute them left to right.
2659 modes)))
2660 ;; Simple -*-MODE-*- case.
2663 modes))))
2664 ;; If we found modes to use, invoke them now, outside the save-excursion.
2672 ;; continuing would call minor modes again, toggling them off
2674 ;; hack-local-variables checks local-enable-local-variables etc, but
2675 ;; we might as well be explicit here for the sake of clarity.
2677 enable-local-variables
2678 local-enable-local-variables
2679 try-locals
2686 ;; If we didn't, look for an interpreter specified in the first line.
2687 ;; As a special case, allow for things like "#!/bin/env perl", which
2688 ;; finds the interpreter anywhere in $PATH.
2695 ;; Map interpreter name to a mode, signaling we're done at the
2696 ;; same time.
2698 interpreter-mode-alist))
2699 ;; If we found an interpreter mode to use, invoke it now.
2702 ;; Next try matching the buffer beginning against magic-mode-alist.
2716 ;; Next compare the filename against the entries in auto-mode-alist.
2721 ;; Remove backup-suffixes from file name.
2723 ;; Remove remote file name identification.
2728 ;; Find first matching alist entry.
2731 ;; System is case-insensitive.
2735 ;; System is case-sensitive.
2737 ;; First match case-sensitively.
2741 ;; Fallback to case-insensitive match.
2755 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2770 ;; When `keep-mode-if-same' is set, we are working on behalf of
2771 ;; set-visited-file-name. In that case, if the major mode specified is the
2772 ;; same one we already have, don't actually reset it. We don't want to lose
2773 ;; minor modes such as Font Lock.
2775 "Apply MODE and return it.
2776 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2777 any aliases and compared to current major mode. If they are the
2778 same, do nothing and return nil."
2784 mode)))
2787 "Find the -*- spec in the buffer.
2788 Call with point at the place to start searching from.
2789 If one is found, set point to the beginning and return the position
2790 of the end. Otherwise, return nil; may change point.
2791 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
2792 be ignored; but `enable-local-variables' and `local-enable-local-variables'
2793 have no effect."
2796 ;; Don't look for -*- if this file name matches any
2797 ;; of the regexps in inhibit-local-variables-regexps.
2800 ;; If the file begins with "#!" (exec
2801 ;; interpreter magic), look for mode frobs
2802 ;; in the first two lines. You cannot
2803 ;; necessarily put them in the first line
2804 ;; of such a file without screwing up the
2805 ;; interpreter invocation. The same holds
2806 ;; for '\" in man pages (preprocessor
2807 ;; magic for the `man' program).
2818 end))))
2819 \f
2820 ;;; Handling file local variables
2824 file-local-variables-alist dir-local-variables-alist)
2829 "Normal hook run after processing a file's local variables specs.
2830 Major modes can use this to examine user-specified local variables
2834 "List variable-value pairs that are considered safe.
2835 Each element is a cons cell (VAR . VAL), where VAR is a variable
2836 symbol and VAL is a value that is considered safe."
2837 :risky t
2842 ;; This should be here at least as long as Emacs supports write-file-hooks.
2846 "Expressions that are considered safe in an `eval:' local variable.
2847 Add expressions to this list if you want Emacs to evaluate them, when
2848 they appear in an `eval' local variable specification, without first
2849 asking you for confirmation."
2850 :risky t
2855 ;; Risky local variables:
2858 buffer-auto-save-file-name
2859 buffer-file-name
2860 buffer-file-truename
2861 buffer-undo-list
2862 debugger
2863 default-text-properties
2864 eval
2865 exec-directory
2866 exec-path
2867 file-name-handler-alist
2868 frame-title-format
2869 global-mode-string
2870 header-line-format
2871 icon-title-format
2872 inhibit-quit
2873 load-path
2874 max-lisp-eval-depth
2875 max-specpdl-size
2876 minor-mode-map-alist
2877 minor-mode-overriding-map-alist
2878 mode-line-format
2879 mode-name
2880 overriding-local-map
2881 overriding-terminal-local-map
2882 process-environment
2883 standard-input
2884 standard-output
2885 unread-command-events))
2887 ;; Safe local variables:
2888 ;;
2889 ;; For variables defined by major modes, the safety declarations can go into
2890 ;; the major mode's file, since that will be loaded before file variables are
2891 ;; processed.
2892 ;;
2893 ;; For variables defined by minor modes, put the safety declarations in the
2894 ;; file defining the minor mode after the defcustom/defvar using an autoload
2895 ;; cookie, e.g.:
2896 ;;
2897 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2898 ;;
2899 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2900 ;; minor mode file may not be loaded yet.
2901 ;;
2902 ;; For variables defined in the C source code the declaration should go here:
2924 "Alist of file-local variable settings in the current buffer.
2925 Each element in this list has the form (VAR . VALUE), where VAR
2926 is a file-local variable (a symbol) and VALUE is the value
2927 specified. The actual value in the buffer may differ from VALUE,
2933 "Alist of directory-local variable settings in the current buffer.
2934 Each element in this list has the form (VAR . VALUE), where VAR
2935 is a directory-local variable (a symbol) and VALUE is the value
2936 specified in .dir-locals.el. The actual value in the buffer
2937 may differ from VALUE, if it is changed by the major or minor modes,
2942 "Normal hook run before setting file-local variables.
2943 It is called after checking for unsafe/risky variables and
2944 setting `file-local-variables-alist', and before applying the
2945 variables stored in `file-local-variables-alist'. A hook
2946 function is allowed to change the contents of this alist.
2948 This hook is called only if there is at least one file-local
2952 "Get confirmation before setting up local variable values.
2953 ALL-VARS is the list of all variables to be set up.
2954 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2955 RISKY-VARS is the list of those that are marked as risky.
2956 If these settings come from directory-local variables, then
2957 DIR-NAME is the name of the associated directory. Otherwise it is nil."
2959 nil
2966 unsafe-vars))
2970 prompt char)
2978 ", and variables that are risky (**)."
2986 y -- to apply the local variables list.
2990 ! -- to apply the local variables list, and permanently mark these
3002 ;; Make strings with embedded whitespace easier to read.
3010 ""
3027 "Return local variables specified in the -*- line.
3028 Returns an alist of elements (VAR . VAL), where VAR is a variable
3029 and VAL is the specified value. Ignores any specification for
3030 `mode:' and `coding:' (which should have already been handled
3031 by `set-auto-mode' and `set-auto-coding', respectively).
3032 Return nil if the -*- line is malformed.
3034 If MODE-ONLY is non-nil, just returns the symbol specifying the
3035 mode, if there is one, otherwise nil."
3040 result)
3042 nil)
3044 ;; Simple form: "-*- MODENAME -*-".
3048 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3049 ;; (last ";" is optional).
3050 ;; If MODE-ONLY, just check for `mode'.
3051 ;; Otherwise, parse the -*- line into the RESULT alist.
3059 ;; There used to be a downcase here,
3060 ;; but the manual didn't say so,
3061 ;; and people want to set var names that aren't all lc.
3067 ;; It is traditional to ignore
3068 ;; case when checking for `mode' in set-auto-mode,
3069 ;; so we must do that here as well.
3070 ;; That is inconsistent, but we're stuck with it.
3071 ;; The same can be said for `coding' in set-auto-coding.
3081 ;; Downcase "Mode:".
3087 result))))))
3090 "Filter local variable settings, querying the user if necessary.
3091 VARIABLES is the alist of variable-value settings. This alist is
3092 filtered based on the values of `ignored-local-variables',
3093 `enable-local-eval', `enable-local-variables', and (if necessary)
3094 user interaction. The results are added to
3095 `file-local-variables-alist', without applying them.
3096 If these settings come from directory-local variables, then
3097 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3098 ;; Find those variables that we may want to save to
3099 ;; `safe-local-variable-values'.
3105 ;; Ignore any variable in `ignored-local-variables'.
3106 nil)
3107 ;; Obey `enable-local-eval'.
3115 ;; Ignore duplicates (except `mode') in the present list.
3117 ;; Accept known-safe variables.
3121 ;; The variable is either risky or unsafe:
3128 ;; Query, unless all vars are safe or user wants no querying.
3134 risky-vars dir-name))
3145 "Parse and put into effect this buffer's local variables spec.
3146 Uses `hack-local-variables-apply' to apply the variables.
3149 is specified, and return the corresponding mode symbol, or nil.
3150 In this case, we try to ignore minor-modes, and only return a
3151 major-mode.
3153 If `enable-local-variables' or `local-enable-local-variables' is nil,
3154 this function does nothing. If `inhibit-local-variables-regexps'
3155 applies to the file in question, the file is not scanned for
3156 local variables, but directory-local variables may still be applied."
3157 ;; We don't let inhibit-local-variables-p influence the value of
3158 ;; enable-local-variables, because then it would affect dir-local
3159 ;; variables. We don't want to search eg tar files for file local
3160 ;; variable sections, but there is no reason dir-locals cannot apply
3161 ;; to them. The real meaning of inhibit-local-variables-p is "do
3162 ;; not scan this file for local variables".
3165 result)
3169 ;; Note this is a no-op if enable-local-variables is nil.
3171 ;; This entire function is basically a no-op if enable-local-variables
3172 ;; is nil. All it does is set file-local-variables-alist to nil.
3174 ;; This part used to ignore enable-local-variables when mode-only
3175 ;; was non-nil. That was inappropriate, eg consider the
3176 ;; (artificial) example of:
3177 ;; (setq local-enable-local-variables nil)
3178 ;; Open a file foo.txt that contains "mode: sh".
3179 ;; It correctly opens in text-mode.
3180 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3182 ;; If MODE-ONLY is non-nil, and the prop line specifies a
3183 ;; mode, then we're done, and have no need to scan further.
3185 mode-only))
3186 ;; Look for "Local variables:" line in last page.
3194 ;; suffix is what comes after "local variables:" in its line.
3195 ;; prefix is what comes before "local variables:" in its line.
3205 beg)
3209 endpos
3215 nil t))
3216 ;; This used to be an error, but really all it means is
3217 ;; that this may simply not be a local-variables section,
3218 ;; so just ignore it.
3228 ;; Discard the prefix.
3233 ;; Discard the suffix.
3243 ;; Find the variable name; strip whitespace.
3252 val val2)
3255 ;; Read the variable value.
3262 ;; Specifying minor-modes via mode: is
3263 ;; deprecated, but try to reject them anyway.
3271 'eval
3276 ;; Now we've read all the local variables.
3277 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3279 ;; Otherwise, set the variables.
3284 "Apply the elements of `file-local-variables-alist'.
3285 If there are any elements, runs `before-hack-local-variables-hook',
3286 then calls `hack-one-local-variable' to apply the alist elements one by one.
3287 Finishes by running `hack-local-variables-hook', regardless of whether
3288 the alist is empty or not.
3290 Note that this function ignores a `mode' entry if it specifies the same
3291 major mode as the buffer already has."
3293 ;; Any 'evals must run in the Right sequence.
3302 "Non-nil if SYM is safe as a file-local variable with value VAL.
3303 It is safe if any of these conditions are met:
3305 * There is a matching entry (SYM . VAL) in the
3306 `safe-local-variable-values' user option.
3308 * The `safe-local-variable' property of SYM is a function that
3309 evaluates to a non-nil value with VAL as an argument."
3313 ;; If the function signals an error, that means it
3314 ;; can't assure us that the value is safe.
3318 "Non-nil if SYM could be dangerous as a file-local variable.
3319 It is dangerous if either of these conditions are met:
3321 * Its `risky-local-variable' property is non-nil.
3327 ;; If this is an alias, check the base name.
3347 "Return t if it is safe to eval EXP when it is found in a file."
3349 ;; Detect certain `put' expressions.
3356 lisp-indent-function
3357 scheme-indent-function))
3358 ;; Only allow safe values (not functions).
3363 ;; Only allow indirect form specs.
3364 ;; During bootstrapping, edebug-basic-spec might not be
3365 ;; defined yet.
3369 ;; Allow expressions that the user requested.
3371 ;; Certain functions can be allowed with safe arguments
3372 ;; or can specify verification functions to try.
3374 ;; Allow (minor)-modes calls with no arguments.
3375 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3384 ok))
3392 ok))))))))
3395 "Set local variable VAR with value VAL.
3396 If VAR is `mode', call `VAL-mode' as a function unless it's
3397 already the major mode."
3404 ;; A minor mode must be passed an argument.
3405 ;; Otherwise, if the user enables the minor mode in a
3406 ;; major mode hook, this would toggle it off.
3412 ;; Make sure the string has no text properties.
3413 ;; Some text properties can get evaluated in various ways,
3414 ;; so it is risky to put them on with a local variable list.
3418 \f
3419 ;;; Handling directory-local variables, aka project settings.
3425 "List of cached directory roots for directory-local variable classes.
3426 Each element in this list has the form (DIR CLASS MTIME).
3427 DIR is the name of the directory.
3428 CLASS is the name of a variable class (a symbol).
3429 MTIME is the recorded modification time of the directory-local
3430 variables file associated with this entry. This time is a list
3431 of two integers (the same format as `file-attributes'), and is
3432 used to test whether the cache entry is still valid.
3433 Alternatively, MTIME can be nil, which means the entry is always
3437 "Return the variable list for CLASS."
3441 "Collect directory-local variables from MODE-VARIABLES.
3442 VARIABLES is the initial list of variables.
3443 Returns the new list."
3448 ;; If variables are specified more than once, only use the last. (Why?)
3449 ;; The pseudo-variables mode and eval are different (bug#3430).
3452 ;; Need a new cons in case we setcdr later.
3456 "Collect entries from CLASS-VARIABLES into VARIABLES.
3457 ROOT is the root directory of the project.
3458 Return the new variables list."
3461 ;; FIXME: Why not use file-relative-name?
3468 ;; Don't include this in the previous condition, because we
3469 ;; want to filter all strings before the next condition.
3483 ;; TODO someone might want to extend this to allow
3484 ;; integer values for subdir, where N means
3485 ;; variables apply to this directory and N levels
3486 ;; below it (0 == nil).
3489 alist variables))))))))
3491 ;; The file's content might be invalid (e.g. have a merge conflict), but
3492 ;; that shouldn't prevent the user from opening the file.
3494 nil))))
3497 "Declare that the DIRECTORY root is an instance of CLASS.
3498 DIRECTORY is the name of a directory, a string.
3499 CLASS is the name of a project class, a symbol.
3500 MTIME is either the modification time of the directory-local
3501 variables file that defined this class, or nil.
3503 When a file beneath DIRECTORY is visited, the mode-specific
3504 variables from CLASS are applied to the buffer. The variables
3505 for a class are defined using `dir-locals-set-class-variables'."
3512 "Map the type CLASS to a list of variable settings.
3513 CLASS is the project class, a symbol. VARIABLES is a list
3514 that declares directory-local variables for the class.
3515 An element in VARIABLES is either of the form:
3516 (MAJOR-MODE . ALIST)
3517 or
3518 (DIRECTORY . LIST)
3520 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3521 whose elements are of the form (VARIABLE . VALUE).
3523 In the second form, DIRECTORY is a directory name (a string), and
3524 LIST is a list of the form accepted by the function.
3526 When a file is visited, the file's class is found. A directory
3527 may be assigned a class using `dir-locals-set-directory-class'.
3528 Then variables are set in the file's buffer according to the
3529 class' LIST. The list is processed in order.
3531 * If the element is of the form (MAJOR-MODE . ALIST), and the
3532 buffer's major mode is derived from MAJOR-MODE (as determined
3533 by `derived-mode-p'), then all the variables in ALIST are
3534 applied. A MAJOR-MODE of nil may be used to match any buffer.
3535 `make-local-variable' is called for each variable before it is
3536 set.
3538 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3539 is an initial substring of the file's directory, then LIST is
3540 applied by recursively following these rules."
3547 "File that contains directory-local variables.
3548 It has to be constant to enforce uniform values
3552 "Find the directory-local variables for FILE.
3553 This searches upward in the directory tree from FILE.
3554 It stops at the first directory that has been registered in
3555 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3556 If it finds an entry in the cache, it checks that it is valid.
3557 A cache entry with no modification time element (normally, one that
3558 has been assigned directly using `dir-locals-set-directory-class', not
3559 set from a file) is always valid.
3560 A cache entry based on a `dir-locals-file' is valid if the modification
3561 time stored in the cache matches the current file modification time.
3562 If not, the cache entry is cleared so that the file will be re-read.
3564 This function returns either nil (no directory local variables found),
3565 or the matching entry from `dir-locals-directory-cache' (a list),
3566 or the full path to the `dir-locals-file' (a string) in the case
3567 of no valid cache entry."
3572 dir-locals-file))
3575 ;; `locate-dominating-file' may have abbreviated the name.
3578 ;; Let dir-locals-read-from-file inform us via demoted-errors
3579 ;; about unreadable files, etc.
3580 ;; Maybe we'd want to keep searching though - that is
3581 ;; a locate-dominating-file issue.
3582 ;;; (or (not (file-readable-p locals-file))
3583 ;;; (not (file-regular-p locals-file)))
3584 ;;; (setq locals-file nil))
3585 ;; Find the best cached value in `dir-locals-directory-cache'.
3597 ;; Found a potential cache entry. Check validity.
3598 ;; A cache entry with no MTIME is assumed to always be valid
3599 ;; (ie, set directly, not from a dir-locals file).
3600 ;; Note, we don't bother to check that there is a matching class
3601 ;; element in dir-locals-class-alist, since that's done by
3602 ;; dir-locals-set-directory-class.
3609 ;; This cache entry is OK.
3610 dir-elt
3611 ;; This cache entry is invalid; clear it.
3614 ;; Return the first existing dir-locals file. Might be the same
3615 ;; as dir-elt's, might not (eg latter might have been deleted).
3616 locals-file)
3617 ;; No cache entry.
3618 locals-file)))
3621 "Load a variables FILE and register a new class and instance.
3622 FILE is the name of the file holding the variables to apply.
3623 The new class name is the same as the directory in which FILE
3624 is found. Returns the new class name."
3626 ;; Errors reading the file are not very informative.
3627 ;; Eg just "Error: (end-of-file)" does not give any clue that the
3628 ;; problem is related to dir-locals.
3638 class-name))))
3641 "Read per-directory local variables for the current buffer.
3642 Store the directory-local variables in `dir-local-variables-alist'
3643 and `file-local-variables-alist', without applying them."
3646 ;; Find the variables file.
3670 "Apply directory-local variables to a non-file buffer.
3671 For non-file buffers, such as Dired buffers, directory-local
3672 variables are looked for in `default-directory' and its parent
3673 directories."
3677 \f
3680 However, the mode will not be changed if
3681 \(1) a local variables list or the `-*-' line specifies a major mode, or
3683 \ not suitable for ordinary files, or
3684 \(3) the new file name does not particularly specify any mode."
3689 "Change name of file visited in current buffer to FILENAME.
3690 This also renames the buffer to correspond to the new file.
3691 The next time the buffer is saved it will go in the newly specified file.
3692 FILENAME nil or an empty string means mark buffer as not visiting any file.
3693 Remember to delete the initial contents of the minibuffer
3694 if you wish to pass an empty string as the argument.
3696 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3697 confirmation in the case where another buffer is already visiting FILENAME.
3699 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3700 the old visited file has been renamed to the new name FILENAME."
3708 nil
3723 filename)))
3730 buffer-file-name filename)
3734 ;; If new-name == old-name, renaming would add a spurious <2>
3735 ;; and it's considered as a feature in rename-buffer.
3741 ;; Abbreviate the file names of the buffer.
3750 nil))
3751 ;; write-file-functions is normally used for things like ftp-find-file
3752 ;; that visit things that are not local files as if they were files.
3753 ;; Changing to visit an ordinary local file instead should flush the hook.
3758 ;; If buffer was read-only because of version control,
3759 ;; that reason is gone now, so make it writable.
3763 ;; Turn off backup files for certain file names.
3764 ;; Since this is a permanent local, the major mode won't eliminate it.
3766 backup-enable-predicate
3772 ;; If auto-save was not already on, turn it on if appropriate.
3776 ;; If auto save is on, start using a new name.
3777 ;; We deliberately don't rename or delete the old auto save
3778 ;; for the old visited file name. This is because perhaps
3779 ;; the user wants to save the new state and then compare with the
3780 ;; previous state from the auto save file.
3783 ;; Rename the old auto save file if any.
3790 ;; Update the major mode, if the file name determines it.
3792 ;; Don't change the mode if it is special.
3795 ;; Don't change the mode if the local variable list specifies it.
3796 ;; The file name can influence whether the local variables apply.
3798 ;; h-l-v also checks it, but might as well be explicit.
3801 ;; TODO consider making normal-mode handle this case.
3809 "Write current buffer into file FILENAME.
3810 This makes the buffer visit that file, and marks it as not modified.
3812 If you specify just a directory name as FILENAME, that means to use
3813 the default file name but in that directory. You can also yank
3814 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3816 If the buffer is not already visiting a file, the default file name
3817 for the output file is the buffer name.
3819 If optional second arg CONFIRM is non-nil, this function
3820 asks for confirmation before overwriting an existing file.
3821 Interactively, confirmation is required unless you supply a prefix argument."
3822 ;; (interactive "FWrite file: ")
3826 nil nil nil nil)
3830 default-directory)
3831 nil nil))
3835 ;; If arg is just a directory,
3836 ;; use the default file name, but in that directory.
3847 ;; Make buffer writable if file is writable.
3852 ;; It's likely that the VC status at the new location is different from
3853 ;; the one at the old location.
3855 \f
3857 "Make a backup of the disk file visited by the current buffer, if appropriate.
3858 This is normally done before saving the buffer the first time.
3860 A backup may be done by renaming or by copying; see documentation of
3861 variable `make-backup-files'. If it's done by renaming, then the file is
3862 no longer accessible under its old name.
3864 The value is non-nil after a backup was made by renaming.
3865 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3866 MODES is the result of `file-modes' on the original
3867 file; this means that the caller, after saving the buffer, should change
3868 the modes of the new file to agree with the old modes.
3869 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3870 file; this means that the caller, after saving the buffer, should change
3871 the SELinux context of the new file to agree with the old context.
3872 BACKUPNAME is the backup file name, which is the old file renamed."
3879 backup-info backupname targets setmodes)
3880 ;; If specified name is a symbolic link, chase it to the target.
3881 ;; Thus we make the backups in the directory where the real file is.
3886 ;; (if (file-directory-p buffer-file-name)
3887 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3891 ;; If have old versions to maybe delete,
3892 ;; ask the user to confirm now, before doing anything.
3893 ;; But don't actually delete til later.
3898 real-file-name)))))
3901 ;; Actually write the back up file.
3904 ; (file-symlink-p buffer-file-name)
3905 backup-by-copying
3906 ;; Don't rename a suid or sgid file.
3921 ;; rename-file should delete old backup.
3925 ;; If trouble writing the backup, write it in
3926 ;; .emacs.d/%backup%.
3929 backupname)
3933 ;; Now delete the old versions, if desired.
3940 setmodes)
3947 ;; Create temp files with strict access rights. It's easy to
3948 ;; loosen them later, whereas it's impossible to close the
3949 ;; time-window of loose permissions otherwise.
3952 ;; Try to overwrite old backup first.
3960 nil)
3962 ;; The file was somehow created by someone else between
3963 ;; `delete-file' and `copy-file', so let's try again.
3964 ;; rms says "I think there is also a possible race
3965 ;; condition for making backup files" (emacs-devel 20070821).
3966 nil)))
3967 ;; Reset the umask.
3976 ;; The last ~[[:digit]]+ matches relative versions in git,
3977 ;; e.g. `foo.js.~HEAD~1~'.
3978 "Regular expression matching the backup/version part of a file name.
3982 "Return file NAME sans backup versions or strings.
3983 This is a separate procedure so your site-init or startup file can
3984 redefine it.
3985 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3986 we do not remove backup version numbers, only true file version numbers.
3987 See also `file-name-version-regexp'."
3994 name))))))
3997 "Return t if deleting FILE and rewriting it would preserve the owner."
4002 ;; Return t if the file doesn't exist, since it's true that no
4003 ;; information would be lost by an (attempted) delete and create.
4006 ;; Files created on Windows by Administrator (RID=500)
4007 ;; have the Administrators group (RID=544) recorded as
4008 ;; their owner. Rewriting them will still preserve the
4009 ;; owner.
4015 The extension, in a file name, is the part that follows the last `.',
4016 except that a leading `.', if any, doesn't count."
4019 directory)
4023 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4024 ;; we don't want to expand it.
4027 filename))))
4031 The extension, in a file name, is the part that follows the last `.',
4032 excluding version numbers and backup suffixes,
4033 except that a leading `.', if any, doesn't count.
4034 Return nil for extensionless file names such as `foo'.
4035 Return the empty string for file names such as `foo.'.
4037 If PERIOD is non-nil, then the returned value includes the period
4038 that delimits the extension, and if FILENAME has no extension,
4049 "A function to use instead of the default `make-backup-file-name'.
4050 A value of nil gives the default `make-backup-file-name' behavior.
4052 This could be buffer-local to do something special for specific
4053 files. If you define it, you may need to change `backup-file-name-p'
4054 and `file-name-sans-versions' too.
4056 See also `backup-directory-alist'."
4062 "Alist of filename patterns and backup directory names.
4063 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4064 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4065 relative or absolute. If it is absolute, so that all matching files
4066 are backed up into the same directory, the file names in this
4067 directory will be the full name of the file backed up with all
4068 directory separators changed to `!' to prevent clashes. This will not
4069 work correctly if your filesystem truncates the resulting name.
4071 For the common case of all backups going into one directory, the alist
4073 directory name.
4075 If this variable is nil, or it fails to match a filename, the backup
4076 is made in the original file's directory.
4078 On MS-DOS filesystems without long names this variable is always
4079 ignored."
4085 "Default `backup-enable-predicate' function.
4086 Checks for files in `temporary-file-directory',
4087 `small-temporary-file-directory', and /tmp."
4090 ;; Directory is under temporary-file-directory.
4095 ;; Directory is under /tmp.
4100 0 nil
4102 ;; Directory is under small-temporary-file-directory.
4107 "Create the non-numeric backup file name for FILE.
4108 Normally this will just be the file's name with `~' appended.
4109 Customization hooks are provided as follows.
4111 If the variable `make-backup-file-name-function' is non-nil, its value
4112 should be a function which will be called with FILE as its argument;
4113 the resulting name is used.
4115 Otherwise a match for FILE is sought in `backup-directory-alist'; see
4116 the documentation of that variable. If the directory for the backup
4117 doesn't exist, it is created."
4131 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
4133 elt backup-directory abs-backup-directory)
4138 alist nil)))
4139 ;; If backup-directory is relative, it should be relative to the
4140 ;; file's directory. By expanding explicitly here, we avoid
4141 ;; depending on default-directory.
4150 abs-backup-directory nil))))
4152 file
4156 ;; Normalize DOSish file names: downcase the drive
4157 ;; letter, if any, and replace the leading "x:" with
4158 ;; "/drive_x".
4161 ;; Replace any invalid file-name characters (for the
4162 ;; case of backing up remote files).
4166 "drive_"
4169 ""
4172 ;; Make the name unique by substituting directory
4173 ;; separators. It may not really be worth bothering about
4174 ;; doubling `!'s in the original name...
4179 backup-directory))
4184 "Return non-nil if FILE is a backup file name (numeric or not).
4185 This is a separate function so you can redefine it for customization.
4186 You may need to redefine `file-name-sans-versions' as well."
4191 ;; This is used in various files.
4192 ;; The usage of backup-extract-version-start is not very clean,
4193 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4195 "Given the name of a numeric backup file, FN, return the backup number.
4196 Uses the free variable `backup-extract-version-start', whose value should be
4197 the index in the name where the version number begins."
4204 "Find a file name for a backup file FN, and suggestions for deletions.
4205 Value is a list whose car is the name for the backup file
4206 and whose cdr is a list of old versions to consider deleting now.
4207 If the value is nil, don't make a backup.
4208 Uses `backup-directory-alist' in the same way as does
4209 `make-backup-file-name'."
4211 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4215 ;; We don't support numbered backups on plain MS-DOS
4216 ;; when long file names are unavailable.
4226 possibilities deserve-versions-p versions)
4229 base-versions
4232 possibilities)
4233 #'<)
4238 kept-old-versions
4239 kept-new-versions
4246 ;; Delete nothing if there is overflow
4247 ;; in the number of versions to keep.
4253 v))))))))))
4256 "Return number of names file FILENAME has."
4259 ;; (defun file-relative-name (filename &optional directory)
4260 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4261 ;; This function returns a relative file name which is equivalent to FILENAME
4262 ;; when used with that default directory as the default.
4263 ;; If this is impossible (which can happen on MSDOS and Windows
4264 ;; when the file name and directory use different drive names)
4265 ;; then it returns FILENAME."
4266 ;; (save-match-data
4267 ;; (let ((fname (expand-file-name filename)))
4268 ;; (setq directory (file-name-as-directory
4269 ;; (expand-file-name (or directory default-directory))))
4270 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4271 ;; ;; drive names, they can't be relative, so return the absolute name.
4272 ;; (if (and (or (eq system-type 'ms-dos)
4273 ;; (eq system-type 'cygwin)
4274 ;; (eq system-type 'windows-nt))
4275 ;; (not (string-equal (substring fname 0 2)
4276 ;; (substring directory 0 2))))
4277 ;; filename
4278 ;; (let ((ancestor ".")
4279 ;; (fname-dir (file-name-as-directory fname)))
4280 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4281 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4282 ;; (setq directory (file-name-directory (substring directory 0 -1))
4283 ;; ancestor (if (equal ancestor ".")
4284 ;; ".."
4285 ;; (concat "../" ancestor))))
4286 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4287 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4288 ;; ;; We matched within FNAME's directory part.
4289 ;; ;; Add the rest of FNAME onto ANCESTOR.
4290 ;; (let ((rest (substring fname (match-end 0))))
4291 ;; (if (and (equal ancestor ".")
4292 ;; (not (equal rest "")))
4293 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4294 ;; rest
4295 ;; (concat (file-name-as-directory ancestor) rest)))
4296 ;; ;; We matched FNAME's directory equivalent.
4297 ;; ancestor))))))
4300 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4301 This function returns a relative file name which is equivalent to FILENAME
4302 when used with that default directory as the default.
4303 If FILENAME and DIRECTORY lie on different machines or on different drives
4304 on a DOS/Windows machine, it returns FILENAME in expanded form."
4308 default-directory))))
4314 ;; Test for different filesystems on DOS/Windows
4316 ;; Should `cygwin' really be included here? --stef
4319 ;; Test for different drive letters
4321 ;; Test for UNCs on different servers
4326 ;; Windows file names cannot have ? in
4327 ;; them, so use that to detect when
4328 ;; neither FILENAME nor DIRECTORY is a
4329 ;; UNC.
4331 0 nil
4337 ;; Test for different remote file system identification
4339 filename
4345 directory nil nil case-fold-search))
4347 directory nil nil case-fold-search))))
4350 ".."
4352 ;; Now ancestor is empty, or .., or ../.., etc.
4354 directory nil nil case-fold-search))
4355 ;; We matched within FILENAME's directory part.
4356 ;; Add the rest of FILENAME onto ANCESTOR.
4359 ;; But don't bother with ANCESTOR if it would give us `./'.
4360 rest
4362 ;; We matched FILENAME's directory equivalent.
4363 ancestor))))))
4364 \f
4366 "Save current buffer in visited file if modified.
4367 Variations are described below.
4369 By default, makes the previous version into a backup file
4370 if previously requested or if this is the first save.
4372 to become a backup when the next save is done.
4374 unconditionally makes the previous version into a backup file.
4376 to become a backup when the next save is done,
4377 and unconditionally makes the previous version into a backup file.
4379 With a numeric argument of 0, never make the previous version
4380 into a backup file.
4382 If a file's name is FOO, the names of its numbered backup versions are
4383 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4384 Numeric backups (rather than FOO~) will be made if value of
4385 `version-control' is not the atom `never' and either there are already
4386 numeric versions of the file being backed up, or `version-control' is
4387 non-nil.
4388 We don't want excessive versions piling up, so there are variables
4389 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4390 and `kept-new-versions', which tells how many newest versions to keep.
4391 Defaults are 2 old versions and 2 new.
4392 `dired-kept-versions' controls dired's clean-directory (.) command.
4393 If `delete-old-versions' is nil, system will query user
4394 before trimming versions. Otherwise it does it silently.
4396 If `vc-make-backup-files' is nil, which is the default,
4397 no backup files are made for files managed by version control.
4398 (This is because the version control system itself records previous versions.)
4400 See the subroutine `basic-save-buffer' for more information."
4406 ;; We used to display the message below only for files > 50KB, but
4407 ;; then Rmail-mbox never displays it due to buffer swapping. If
4408 ;; the test is ever re-introduced, be sure to handle saving of
4409 ;; Rmail files.
4416 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4417 Normally delete only if the file was written by this Emacs since
4418 the last real save, but optional arg FORCE non-nil means delete anyway."
4432 "Normal hook that is run before a buffer is saved to its file."
4438 "Normal hook that is run after a buffer is saved to its file."
4444 "If non-nil, use this coding system for saving the buffer.
4445 More precisely, use this coding system in place of the
4446 value of `buffer-file-coding-system', when saving the buffer.
4447 Calling `write-region' for any purpose other than saving the buffer
4448 will still use `buffer-file-coding-system'; this variable has no effect
4455 "Save the current buffer in its visited file, if it has been modified.
4456 The hooks `write-contents-functions' and `write-file-functions' get a chance
4457 to do the job of saving; if they do not, then the buffer is saved in
4458 the visited file in the usual way.
4459 Before and after saving the buffer, this function runs
4460 `before-save-hook' and `after-save-hook', respectively."
4463 ;; In an indirect buffer, save its base buffer instead.
4467 ;; handle the case when no modification has been made but
4468 ;; the file disappeared since visited
4472 setmodes)
4473 ;; If buffer has no file name, ask user for one.
4480 ;; Signal an error if the user specified the name of an
4481 ;; existing directory.
4484 filename))
4486 ;; Signal an error if the specified name refers to a
4487 ;; non-existing directory.
4498 "%s has changed since visited or saved. Save anyway? "
4518 ;; Support VC version backups.
4524 ;; If a hook returned t, file is already "written".
4525 ;; Otherwise, write it the usual way now.
4527 ;; Now we have saved the current buffer. Let's make sure
4528 ;; that buffer-file-coding-system is fixed to what
4529 ;; actually used for saving by binding it locally.
4541 ;; If the auto-save file was recent before this command,
4542 ;; delete it now.
4544 ;; Support VC `implicit' locking.
4549 ;; This does the "real job" of writing a buffer into its visited file
4550 ;; and making a backup file. This is what is normally done
4551 ;; but inhibited if one of write-file-functions returns non-nil.
4552 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4564 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4577 "File %s is write-protected; try to save anyway? "
4579 buffer-file-name)))
4594 ;; Write temp name, then rename it.
4595 ;; This requires write access to the containing dir,
4596 ;; which is why we don't try it if we don't have that access.
4598 tempname succeed
4601 ;; Create temp files with strict access rights. It's easy to
4602 ;; loosen them later, whereas it's impossible to close the
4603 ;; time-window of loose permissions otherwise.
4608 ;; Try various temporary names.
4609 ;; This code follows the example of make-temp-file,
4610 ;; but it calls write-region in the appropriate way
4611 ;; for saving the buffer.
4617 ;; Pass in nil&nil rather than point-min&max
4618 ;; cause we're saving the whole buffer.
4619 ;; write-region-annotate-functions may use it.
4621 tempname nil realname
4623 nil)
4625 ;; The file was somehow created by someone else between
4626 ;; `make-temp-name' and `write-region', let's try again.
4627 nil)
4629 ;; Reset the umask.
4631 ;; If we failed, restore the buffer's modtime.
4634 ;; Since we have created an entirely new file,
4635 ;; make sure it gets the right permission bits set.
4640 buffer-file-name)))
4641 ;; We succeeded in writing the temp file,
4642 ;; so rename it.
4644 ;; If file not writable, see if we can make it writable
4645 ;; temporarily while we write it.
4646 ;; But no need to do so if we have just backed it up
4647 ;; (setmodes is set) because that says we're superseding.
4649 ;; Change the mode back, after writing.
4652 buffer-file-name))
4658 ;; Pass in nil&nil rather than point-min&max to indicate
4659 ;; we're saving the buffer rather than just a region.
4660 ;; write-region-annotate-functions may make us of it.
4662 buffer-file-name nil t buffer-file-truename)
4664 ;; If we get an error writing the new file, and we made
4665 ;; the backup by renaming, undo the backing-up.
4670 setmodes))
4676 `((?\C-r
4683 ;; Return nil to ask about BUF again.
4684 nil)
4697 ;; Return nil to ask about BUF again.
4698 nil)
4708 "Save some modified file-visiting buffers. Asks user about each one.
4709 You can answer `y' to save, `n' not to save, `C-r' to look at the
4710 buffer in question with `view-buffer' before deciding or `d' to
4711 view the differences using `diff-buffer-with-file'.
4713 This command first saves any buffers where `buffer-save-without-query' is
4714 non-nil, without asking.
4716 Optional argument (the prefix) non-nil means save all with no questions.
4717 Optional second argument PRED determines which buffers are considered:
4718 If PRED is nil, all the file-visiting buffers are considered.
4719 If PRED is t, then certain non-file buffers will also be considered.
4720 If PRED is a zero-argument function, it indicates for each buffer whether
4721 to consider it or not when called with that buffer current.
4723 See `save-some-buffers-action-alist' if you want to
4724 change the additional actions you can take on files."
4728 files-done abbrevs-done)
4730 ;; First save any buffers that we're supposed to save unconditionally.
4731 ;; That way the following code won't ask about them.
4736 ;; Ask about those buffers that merit it,
4737 ;; and record the number thus saved.
4741 ;; Note that killing some buffers may kill others via
4742 ;; hooks (e.g. Rmail and its viewing buffer).
4755 t
4767 save-some-buffers-action-alist))
4768 ;; Maybe to save abbrevs, and record whether
4769 ;; we either saved them or asked to.
4776 ;; Don't keep bothering user if he says no.
4789 \f
4791 "Mark current buffer as unmodified, not needing to be saved.
4794 It is not a good idea to use this function in Lisp programs, because it
4795 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4802 "Change whether this buffer is read-only.
4803 With prefix argument ARG, make the buffer read-only if ARG is
4804 positive, otherwise make it writable. If buffer is read-only
4805 and `view-read-only' is non-nil, enter view mode.
4807 This function is usually the wrong thing to use in a Lisp program.
4808 It can have side-effects beyond changing the read-only status of a buffer
4809 \(e.g., enabling view mode), and does not affect read-only regions that
4810 are caused by text properties. To make a buffer read-only in Lisp code,
4811 set `buffer-read-only'. To ignore read-only status (whether due to text
4812 properties or buffer state) and make changes, temporarily bind
4813 `inhibit-read-only'."
4818 nil ; do nothing.
4819 ;; Toggle.
4826 ;; If view-mode is already active, `view-mode-enter' is a nop.
4834 "Insert contents of file FILENAME into buffer after point.
4835 Set mark after the inserted text.
4837 This function is meant for the user to run interactively.
4838 Don't call it from programs! Use `insert-file-contents' instead.
4839 \(Its calling sequence is different; see its documentation)."
4844 "Append the contents of the region to the end of file FILENAME.
4845 When called from a function, expects three arguments,
4846 START, END and FILENAME. START and END are normally buffer positions
4847 specifying the part of the buffer to write.
4848 If START is nil, that means to use the entire buffer contents.
4849 If START is a string, then output that string to the file
4850 instead of any buffer contents; END is ignored.
4852 This does character code conversion and applies annotations
4853 like `write-region' does."
4858 "Return most recent backup file for FILENAME or nil if no backups exist."
4859 ;; `make-backup-file-name' will get us the right directory for
4860 ;; ordinary or numeric backups. It might create a directory for
4861 ;; backups as a side-effect, according to `backup-directory-alist'.
4868 tem)
4877 newest))
4880 "Rename current buffer to a similar name not already taken.
4881 This function is useful for creating multiple shell process buffers
4882 or multiple mail buffers, etc.
4884 Note that some commands, in particular those based on `compilation-mode'
4885 \(`compile', `grep', etc.) will reuse the current buffer if it has the
4886 appropriate mode even if it has been renamed. So as well as renaming
4887 the buffer, you also need to switch buffers before running another
4888 instance of such commands."
4896 ;; If the existing buffer name has a <NNN>,
4897 ;; which isn't part of the file name (if any),
4898 ;; then get rid of that.
4904 "Create the directory DIR and optionally any nonexistent parent dirs.
4905 If DIR already exists as a directory, signal an error, unless
4906 PARENTS is non-nil.
4908 Interactively, the default choice of directory to create is the
4909 current buffer's default directory. That is useful when you have
4910 visited a file in a nonexistent directory.
4912 Noninteractively, the second (optional) argument PARENTS, if
4913 non-nil, says whether to create parent directories that don't
4914 exist. Interactively, this happens by default.
4916 If creating the directory or directories fail, an error will be
4917 raised."
4920 nil nil)
4921 t))
4922 ;; If default-directory is a remote directory,
4923 ;; make sure we find its make-directory handler.
4931 create-list)
4933 ;; If directory is its own parent, then we can't
4934 ;; keep looping forever
4949 "Delete the directory named DIRECTORY. Does not follow symlinks.
4950 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4951 TRASH non-nil means to trash the directory instead, provided
4952 `delete-by-moving-to-trash' is non-nil.
4954 When called interactively, TRASH is t if no prefix argument is
4955 given. With a prefix argument, TRASH is nil."
4962 "Move directory to trash: "
4964 default-directory default-directory nil nil))))
4970 nil)
4972 ;; If default-directory is a remote directory, make sure we find its
4973 ;; delete-directory handler.
4980 ;; Only move non-empty dir to trash if recursive deletion was
4981 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4982 ;; case, where the operation fails in delete-directory-internal.
4983 ;; As `move-file-to-trash' trashes directories (empty or
4984 ;; otherwise) as a unit, we do not need to recurse here.
4986 ;; Check if directory is empty apart from "." and "..".
4991 ;; Otherwise, call ourselves recursively if needed.
4995 ;; This test is equivalent to
4996 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4997 ;; but more efficient
5001 ;; We do not want to delete "." and "..".
5007 "Return non-nil if files FILE1 and FILE2 name the same file.
5008 If FILE1 or FILE2 does not exist, the return value is unspecified."
5019 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5021 Return nil if DIR is not an existing directory."
5043 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5044 This function always sets the file modes of the output files to match
5045 the corresponding input file.
5047 The third arg KEEP-TIME non-nil means give the output files the same
5048 last-modified time as the old ones. (This works on only some systems.)
5050 A prefix arg makes KEEP-TIME non-nil.
5052 Noninteractively, the last argument PARENTS says whether to
5053 create parent directories if they don't exist. Interactively,
5054 this happens by default.
5056 If NEWNAME names an existing directory, copy DIRECTORY as a
5057 subdirectory there. However, if called from Lisp with a non-nil
5058 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5059 directly into NEWNAME instead."
5066 default-directory default-directory nil nil)
5067 current-prefix-arg t nil)))
5070 directory newname))
5071 ;; If default-directory is a remote directory, make sure we find its
5072 ;; copy-directory handler.
5077 newname keep-time parents copy-contents)
5079 ;; Compute target name.
5084 ;; If NEWNAME is not an existing directory, create it;
5085 ;; that is where we will copy the files of DIRECTORY.
5087 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5088 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5093 newname))
5097 newname))
5100 ;; Copy recursively.
5102 ;; We do not want to copy "." and "..".
5104 directory-files-no-dot-files-regexp))
5114 ;; Set directory attributes.
5119 \f
5122 "Function to use to revert this buffer, or nil to do the default.
5123 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5128 "Function to use to insert contents when reverting this buffer.
5129 Gets two args, first the nominal file name to use,
5130 and second, t if reading the auto-save file.
5135 "Function to check whether a non-file buffer needs reverting.
5136 This should be a function with one optional argument NOCONFIRM.
5137 Auto Revert Mode passes t for NOCONFIRM. The function should return
5138 non-nil if the buffer should be reverted. A return value of
5139 `fast' means that the need for reverting was not checked, but
5140 that reverting the buffer is fast. The buffer is current when
5141 this function is called.
5143 The idea behind the NOCONFIRM argument is that it should be
5144 non-nil if the buffer is going to be reverted without asking the
5145 user. In such situations, one has to be careful with potentially
5146 time consuming operations.
5148 For more information on how this variable is used by Auto Revert mode,
5152 "Normal hook for `revert-buffer' to run before reverting.
5153 If `revert-buffer-function' is used to override the normal revert
5157 "Normal hook for `revert-buffer' to run after reverting.
5158 Note that the hook value that it runs is the value that was in effect
5159 before reverting; that makes a difference if you have buffer-local
5160 hook functions.
5162 If `revert-buffer-function' is used to override the normal revert
5166 "Non-nil if a `revert-buffer' operation is in progress, nil otherwise.
5172 "Replace current buffer text with the text of the visited file on disk.
5173 This undoes all changes since the file was visited or saved.
5174 With a prefix argument, offer to revert from latest auto-save file, if
5175 that is more recent than the visited file.
5177 This command also implements an interface for special buffers
5178 that contain text which doesn't come from a file, but reflects
5179 some other data instead (e.g. Dired buffers, `buffer-list'
5180 buffers). This is done via the variable `revert-buffer-function'.
5181 In these cases, it should reconstruct the buffer contents from the
5182 appropriate data.
5184 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5185 to revert from the auto-save file when this is nil. Note that the
5186 sense of this argument is the reverse of the prefix argument, for the
5187 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5188 to nil.
5190 Optional second argument NOCONFIRM means don't ask for confirmation
5191 at all. (The variable `revert-without-query' offers another way to
5192 revert buffers without querying for confirmation.)
5194 Optional third argument PRESERVE-MODES non-nil means don't alter
5195 the files modes. Normally we reinitialize them using `normal-mode'.
5197 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5199 If the value of `revert-buffer-function' is non-nil, it is called to
5200 do all the work for this command. Otherwise, the hooks
5201 `before-revert-hook' and `after-revert-hook' are run at the beginning
5202 and the end, and if `revert-buffer-insert-file-contents-function' is
5203 non-nil, it is called instead of rereading visited file contents."
5205 ;; I admit it's odd to reverse the sense of the prefix argument, but
5206 ;; there is a lot of code out there which assumes that the first
5207 ;; argument should be t to avoid consulting the auto-save file, and
5208 ;; there's no straightforward way to encourage authors to notice a
5209 ;; reversal of the argument sense. So I'm just changing the user
5210 ;; interface, but leaving the programmatic interface the same.
5220 buffer-auto-save-file-name
5225 buffer-auto-save-file-name
5226 buffer-file-name)))
5236 file-name)))
5238 ;; If file was backed up but has changed since,
5239 ;; we should make another backup.
5243 ;; Effectively copy the after-revert-hook status,
5244 ;; since after-find-file will clobber it.
5247 after-revert-hook))
5252 ;; Get rid of all undo records for this buffer.
5254 ;; Don't make undo records for the reversion.
5257 file-name auto-save-p)))
5260 "File %s no longer exists!"
5262 file-name))
5265 "File %s no longer readable!"
5267 file-name))
5269 ;; Bind buffer-file-name to nil
5270 ;; so that we don't try to lock the file.
5276 ;; Auto-saved file should be read by Emacs's
5277 ;; internal coding.
5281 buffer-file-coding-system-explicit
5284 coding-system-for-read
5286 coding-system-for-read)
5288 ;; As a coding system suitable for multibyte
5289 ;; buffer is specified, make the current
5290 ;; buffer multibyte.
5293 ;; This force after-insert-file-set-coding
5294 ;; (called from insert-file-contents) to set
5295 ;; buffer-file-coding-system to a proper value.
5298 ;; Note that this preserves point in an intelligent way.
5302 nil nil t))
5304 nil nil t)))))
5305 ;; Recompute the truename in case changes in symlinks
5306 ;; have changed the truename.
5310 ;; Run after-revert-hook as it was before we reverted.
5314 local-hook)
5317 t))))))
5320 "Recover the visited file--get contents from its last auto-save file."
5325 "Visit file FILE, but get contents from its last auto-save file."
5326 ;; Actually putting the file name in the minibuffer should be used
5327 ;; only rarely.
5328 ;; Not just because users often use the default.
5348 ;; Use insert-directory-safely, not insert-directory,
5349 ;; because these files might not exist. In particular,
5350 ;; FILE might not exist if the auto-save file was for
5351 ;; a buffer that didn't visit a file, such as "*mail*".
5352 ;; The code in v20.x called `ls' directly, so we need
5353 ;; to emulate what `ls' did in that case.
5359 ;; Keep the current buffer-file-coding-system.
5361 ;; Auto-saved file should be read with special coding.
5370 "Recover auto save files from a previous Emacs session.
5371 This command first displays a Dired buffer showing you the
5372 previous sessions that you could recover from.
5373 To choose one, move point to the proper line and then type C-c C-c.
5374 Then you'll be asked about a number of files to recover."
5384 auto-save-list-file-prefix)))
5385 t)
5394 ;; Each line starts with a space
5395 ;; so that Font Lock mode won't highlight the first character.
5404 "Choose one saved session to recover auto-save files from.
5405 This command is used in the special Dired buffer created by
5408 ;; Get the name of the session file to recover from.
5410 files
5416 ;; Read in the auto-save-list file.
5419 ;; Loop thru the text of that file
5420 ;; and get out the names of the files to recover.
5424 ;; This is a pair of lines for a non-file-visiting buffer.
5425 ;; Get the auto-save file name and manufacture
5426 ;; a "visited file name" from that.
5429 ;; If there is no auto-save file name, the
5430 ;; auto-save-list file is probably corrupted.
5443 ;; This pair of lines is a file-visiting
5444 ;; buffer. Use the visited file name.
5454 ;; Ignore a file if its auto-save file does not exist now.
5458 ;; The file contains a pair of line for each auto-saved buffer.
5459 ;; The first line of the pair contains the visited file name
5460 ;; or is empty if the buffer was not visiting a file.
5461 ;; The second line is the auto-save file name.
5469 files
5475 "Kill BUFFER if confirmed."
5483 "Kill some buffers. Asks the user whether to kill each one of them.
5484 Non-interactively, if optional argument LIST is non-nil, it
5485 specifies the list of buffers to kill, asking for approval for each one."
5493 ; if we killed the base buffer.
5500 "Kill buffers whose name matches the specified REGEXP.
5501 The optional second argument indicates whether to kill internal buffers too."
5510 \f
5512 "Adjust current buffer's auto save file name for current conditions.
5513 Also rename any existing auto save file, if it was made in this session."
5525 "Return file name to use for auto-saves of current buffer.
5526 Does not consider `auto-save-visited-file-name' as that variable is checked
5527 before calling this function. You can redefine this for customization.
5528 See also `auto-save-file-name-p'."
5536 result uniq)
5537 ;; Apply user-specified translations
5538 ;; to the file name.
5542 filename)
5552 filename))))
5557 ;; We truncate the file name to DOS 8+3 limits
5558 ;; before doing anything else, because the regexp
5559 ;; passed to string-match below cannot handle
5560 ;; extensions longer than 3 characters, multiple
5561 ;; dots, and other atrocities.
5566 fn)
5571 "#"
5574 ;; Make sure auto-save file names don't contain characters
5575 ;; invalid for the underlying filesystem.
5577 ;; Don't modify remote (ange-ftp) filenames
5580 result))))
5582 ;; Deal with buffers that don't have any associated files. (Mail
5583 ;; mode tends to create a good number of these.)
5587 file-name)
5588 ;; Restrict the characters used in the file name to those which
5589 ;; are known to be safe on all filesystems, url-encoding the
5590 ;; rest.
5591 ;; We do this on all platforms, because even if we are not
5592 ;; running on DOS/Windows, the current directory may be on a
5593 ;; mounted VFAT filesystem, such as a USB memory stick.
5597 ;; For multibyte characters, this will produce more than
5598 ;; 2 hex digits, so is not true URL encoding.
5602 ;; Generate the file name.
5608 ;; Try a few alternative directories, to get one we can
5609 ;; write it.
5615 ;; Don't modify remote (ange-ftp) filenames
5617 ;; The call to convert-standard-filename is in case
5618 ;; buffer-name includes characters not allowed by the
5619 ;; DOS/Windows filesystems. make-temp-file writes to the
5620 ;; file it creates, so we must fix the file name _before_
5621 ;; make-temp-file is called.
5623 fname))
5625 ;; make-temp-file creates the file,
5626 ;; but we don't want it to exist until we do an auto-save.
5630 file-name)))
5633 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5634 FILENAME should lack slashes. You can redefine this for customization."
5636 \f
5638 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5639 The generated regexp will match a filename only if the filename
5640 matches that wildcard according to shell rules. Only wildcards known
5641 by `sh' are supported."
5643 ;; Copy the initial run of non-special characters.
5646 ;; If no special characters, we're almost done.
5650 j)
5652 result
5673 ;; Found "[^". Insert a `\0' character
5674 ;; (which cannot happen in a filename)
5675 ;; into the character class, so that `^'
5676 ;; is not the first character after `[',
5677 ;; and thus non-special in a regexp.
5682 ;; I don't think `]' can appear in a
5683 ;; character class in a wildcard, but
5684 ;; let's be general here.
5691 i
5704 ;; Shell wildcards should match the entire filename,
5705 ;; not its part. Make the regexp say so.
5707 \f
5710 "Switches for `list-directory' to pass to `ls' for brief listing."
5716 "Switches for `list-directory' to pass to `ls' for verbose listing."
5721 "Expand wildcard pattern PATTERN.
5722 This returns a list of file names which match the pattern.
5724 If PATTERN is written as an absolute file name,
5725 the values are absolute also.
5727 If PATTERN is written as a relative file name, it is interpreted
5728 relative to the current default directory, `default-directory'.
5729 The file names returned are normally also relative to the current
5730 default directory. However, if FULL is non-nil, they are absolute."
5734 ;; A list of all dirs that DIRPART specifies.
5735 ;; This can be more than one dir
5736 ;; if DIRPART contains wildcards.
5740 dirpart)))
5744 contents)
5750 ;; Filter out "." and ".."
5755 name))
5762 this-dir-contents)
5763 this-dir-contents)
5764 contents))))
5766 contents)))
5768 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5772 "Display a list of files in or matching DIRNAME, a la `ls'.
5773 DIRNAME is globbed by the shell if necessary.
5774 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5775 Actions controlled by variables `list-directory-brief-switches'
5776 and `list-directory-verbose-switches'."
5780 nil default-directory nil)
5781 pfx)))
5783 list-directory-brief-switches))
5784 buffer)
5796 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5804 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5806 PATTERN is assumed to represent a file-name wildcard suitable for the
5807 underlying filesystem. For Unix and GNU/Linux, each character from the
5809 the parts of the pattern which don't include wildcard characters are
5810 quoted with double quotes.
5813 on Windows), so PATTERN can use them to quote wildcard characters that
5814 need to be passed verbatim to shell commands."
5818 ;; DOS/Windows don't allow `"' in file names. So if the
5819 ;; argument has quotes, we can safely assume it is already
5820 ;; quoted by the caller.
5822 ;; We quote [&()#$'] in case their shell is a port of a
5823 ;; Unixy shell. We quote [,=+] because stock DOS and
5824 ;; Windows shells require that in some cases, such as
5825 ;; passing arguments to batch files that use positional
5826 ;; arguments like %1.
5828 pattern
5831 end)
5848 pattern))))
5855 "Program to get the amount of free space on a file system.
5856 We assume the output has the format of `df'.
5857 The value of this variable must be just a command name or file name;
5858 if you want to specify options, use `directory-free-space-args'.
5860 A value of nil disables this feature.
5862 If the function `file-system-info' is defined, it is always used in
5863 preference to the program given by this variable."
5869 "Options to use when running `directory-free-space-program'."
5874 "Return the amount of free space on directory DIR's file system.
5875 The return value is a string describing the amount of free
5876 space (normally, the number of free 1KB blocks).
5878 This function calls `file-system-info' if it is available, or
5879 invokes the program specified by `directory-free-space-program'
5880 and `directory-free-space-args'. If the system call or program
5881 is unsuccessful, or if DIR is a remote directory, this function
5882 returns nil."
5884 ;; Try to find the number of free blocks. Non-Posix systems don't
5885 ;; always have df, but might have an equivalent system call.
5894 ;; Avoid failure if the default directory does
5895 ;; not exist (Bug#2631, Bug#3911).
5898 nil t nil
5899 directory-free-space-args
5900 dir)
5902 ;; Assume that the "available" column is before the
5903 ;; "capacity" column. Find the "%" and scan backward.
5907 "[[:space:]]+[^[:space:]]+%[^%]*$"
5914 ;; The following expression replaces `dired-move-to-filename-regexp'.
5918 ;; In some locales, month abbreviations are as short as 2 letters,
5919 ;; and they can be followed by ".".
5920 ;; In Breton, a month name can include a quote character.
5933 s "+"
5936 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5937 ;; omits the Kanji characters after month and day-of-month.
5938 ;; On Mac OS X 10.3, the date format in East Asian locales is
5939 ;; day-of-month digits followed by month digits.
5945 ;; The "[0-9]" below requires the previous column to end in a digit.
5946 ;; This avoids recognizing `1 may 1997' as a date in the line:
5947 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5949 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5951 ;; For non-iso date formats, we add the ".*" in order to find
5952 ;; the last possible match. This avoids recognizing
5953 ;; `jservice 10 1024' as a date in the line:
5954 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5956 ;; vc dired listings provide the state or blanks between file
5957 ;; permissions and date. The state is always surrounded by
5958 ;; parentheses:
5959 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5960 ;; This is not supported yet.
5965 "Regular expression to match up to the file name in a directory listing.
5966 The default value is designed to recognize dates and times
5971 ;; insert-directory
5972 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5973 ;; FULL-DIRECTORY-P is nil.
5974 ;; The single line of output must display FILE's name as it was
5975 ;; given, namely, an absolute path name.
5976 ;; - must insert exactly one line for each file if WILDCARD or
5977 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5978 ;; before the file lines, plus optional text after the file lines.
5979 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5980 ;; allowed.
5981 ;; File lines should display the basename.
5982 ;; - must be consistent with
5983 ;; - functions dired-move-to-filename, (these two define what a file line is)
5984 ;; dired-move-to-end-of-filename,
5985 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5986 ;; dired-insert-headerline
5987 ;; dired-after-subdir-garbage (defines what a "total" line is)
5988 ;; - variable dired-subdir-regexp
5989 ;; - may be passed "--dired" as the first argument in SWITCHES.
5990 ;; Filename handlers might have to remove this switch if their
5991 ;; "ls" command does not support it.
5993 "Insert directory listing for FILE, formatted according to SWITCHES.
5994 Leaves point after the inserted text.
5995 SWITCHES may be a string of options, or a list of strings
5996 representing individual options.
5997 Optional third arg WILDCARD means treat FILE as shell wildcard.
5998 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5999 switches do not contain `d', so that a full listing is expected.
6001 This works by running a directory listing program
6002 whose name is in the variable `insert-directory-program'.
6003 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6005 When SWITCHES contains the long `--dired' option, this function
6006 treats it specially, for the sake of dired. However, the
6007 normally equivalent short `-D' option is just passed on to
6008 `insert-directory-program', as any other option."
6009 ;; We need the directory in order to find the right handler.
6014 wildcard full-directory-p)
6017 ;; Read the actual directory using `insert-directory-program'.
6018 ;; RESULT gets the status code.
6020 ;; putting text property `dired-filename, decode one
6021 ;; bunch by one to preserve that property.
6023 ;; This is to control encoding the arguments in call-process.
6027 default-file-name-coding-system))))
6030 ;; Run ls in the directory part of the file pattern
6031 ;; using the last component as argument.
6037 ;; NB since switches is passed to the shell, be
6038 ;; careful of malicious values, eg "-l;reboot".
6039 ;; See eg dired-safe-switches-p.
6041 shell-file-name nil t nil
6042 "-c"
6044 ""
6046 insert-directory-program
6047 " -d "
6049 switches
6051 " -- "
6052 ;; Quote some characters that have
6053 ;; special meanings in shells; but
6054 ;; don't quote the wildcards--we want
6055 ;; them to be special. We also
6056 ;; currently don't quote the quoting
6057 ;; characters in case people want to
6058 ;; use them explicitly to quote
6059 ;; wildcard characters.
6061 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6062 ;; directory if FILE is a symbolic link.
6069 insert-directory-program nil t nil
6073 ;; Split the switches at any spaces so we can
6074 ;; pass separate options as separate args.
6076 ;; Avoid lossage if FILE starts with `-'.
6084 file))))))))
6086 ;; If we got "//DIRED//" in the output, it means we got a real
6087 ;; directory listing, even if `ls' returned nonzero.
6088 ;; So ignore any errors.
6101 ;; The first time ls returns an error,
6102 ;; find the version numbers of ls,
6103 ;; and set insert-directory-ls-version
6104 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6105 ;; is equal or if the info cannot be obtained.
6106 ;; (That can mean it isn't GNU ls.)
6116 comparison)
6132 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6136 ;; If `insert-directory-program' failed, signal an error.
6138 ;; Delete the error message it may have output.
6140 ;; On non-Posix systems, we cannot open a directory, so
6141 ;; don't even try, because that will always result in
6142 ;; the ubiquitous "Access denied". Instead, show the
6143 ;; command line so the user can try to guess what went wrong.
6148 insert-directory-program
6150 file result)
6151 ;; Unix. Access the file to get a suitable error.
6158 ;; The following overshoots by one line for an empty
6159 ;; directory listed with "--dired", but without "-a"
6160 ;; switch, where the ls output contains a
6161 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6162 ;; We take care of that case later.
6170 error-lines)
6171 ;; Find all the lines that are error messages,
6172 ;; and record the bounds of each one.
6179 ;; Now read the numeric positions of file names.
6186 error-lines))
6189 error-lines)))
6191 ;; End is followed by \n or by " -> ".
6193 ;; It seems that we can't trust ls's output as to
6194 ;; byte positions of filenames.
6200 ;; Take care of the case where the ls output contains a
6201 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6202 ;; and we went one line too far back (see above).
6207 ;; Now decode what read if necessary.
6209 file-name-coding-system
6210 default-file-name-coding-system
6212 coding-no-eol
6213 val pos)
6217 ;; If no coding system is specified or detection is
6218 ;; requested, detect the coding.
6232 ;; Force no eol conversion on a file name, so
6233 ;; that CR is preserved.
6241 ;; Try to insert the amount of free space.
6244 ;; First find the line to put it on.
6248 ;; Replace "total" with "used", to avoid confusion.
6254 "Convert `ls --dired' file name position value POS to a buffer position.
6255 File name position values returned in ls --dired output
6256 count only stdout; they don't count the error messages sent to stderr.
6257 So this function converts to them to real buffer positions.
6258 ERROR-LINES is a list of buffer positions of error message lines,
6259 of the form (START END)."
6263 pos)
6267 "Insert directory listing for FILE, formatted according to SWITCHES.
6269 Like `insert-directory', but if FILE does not exist, it inserts a
6270 message to that effect instead of signaling an error."
6273 ;; Simulate the message printed by `ls'.
6277 "Functions to call with no arguments to query about killing Emacs.
6278 If any of these functions returns nil, killing Emacs is canceled.
6279 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6283 "How to ask for confirmation when leaving Emacs.
6284 If nil, the default, don't ask at all. If the value is non-nil, it should
6285 be a predicate function such as `yes-or-no-p'."
6293 "Offer to save each buffer, then kill this Emacs process.
6294 With prefix ARG, silently save all file-visiting buffers without asking.
6295 If there are active processes where `process-query-on-exit-flag'
6296 returns non-nil, asks whether processes should be killed.
6297 Runs the members of `kill-emacs-query-functions' in turn and stops
6298 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6307 ;; process-list is not defined on MSDOS.
6309 active)
6318 ;; Query the user for other things, perhaps.
6325 "Offer to save each buffer, then kill the current connection.
6326 If the current frame has no client, kill Emacs itself.
6328 With prefix ARG, silently save all file-visiting buffers, then kill.
6330 If emacsclient was started with a list of filenames to edit, then
6331 only these files will be asked to be saved."
6336 \f
6337 ;; We use /: as a prefix to "quote" a file name
6338 ;; so that magic file name handlers will not apply to it.
6342 file-name-handler-alist))
6344 ;; We depend on being the last handler on the list,
6345 ;; so that anything else which does need handling
6346 ;; has been handled already.
6347 ;; So it is safe for us to inhibit *all* magic file name handlers.
6356 default-directory))
6357 ;; Get a list of the indices of the args which are file names.
6360 ;; The first six are special because they
6361 ;; return a file name. We want to include the /:
6362 ;; in the return value.
6363 ;; So just avoid stripping it in the first place.
6370 ;; `identity' means just return the first arg
6371 ;; not stripped of its quoting.
6373 ;; `add' means add "/:" to the result.
6376 ;; `unquote-then-quote' means set buffer-file-name
6377 ;; temporarily to unquoted filename.
6379 ;; List the arguments which are filenames.
6387 ;; For all other operations, treat the first argument only
6388 ;; as the file name.
6390 method
6391 ;; Copy ARGUMENTS so we can replace elements in it.
6395 ;; Strip off the /: from the file names that have it.
6403 "/"
6420 \f
6421 ;; Symbolic modes and read-file-modes.
6424 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6425 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6426 Others, or All) for whom to produce the mask.
6427 The bit-mask that is returned extracts from mode bits the access rights
6428 for the specified category of users."
6436 "Convert CHAR to a numeric value of mode bits.
6437 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6438 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6445 ;; Rights relative to the previous file modes.
6456 "Convert a symbolic mode string specification to an equivalent number.
6458 WHO-MASK is the bit-mask specifying the category of users to which to
6459 apply the access permissions. See `file-modes-char-to-who'.
6460 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6461 RIGHTS request to add, remove, or set permissions based on existing ones,
6468 char-right)
6475 num-rights
6479 op char-right)))
6480 num-rights))
6483 "Convert symbolic file modes to numeric file modes.
6484 MODES is the string to convert, it should match
6486 See Info node `(coreutils)File permissions' for more information on this
6487 notation.
6488 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6489 MODES request to add, remove, or set permissions based on existing ones,
6503 num-who num-modes)
6506 num-modes)))
6509 "Read file modes in octal or symbolic notation and return its numeric value.
6510 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6511 ORIG-FILE is the name of a file on whose mode bits to base returned
6512 permissions if what user types requests to add, remove, or set permissions
6528 nil nil default)))
6534 \f
6535 ;; Trashcan handling.
6537 "Directory for `move-file-to-trash' to move files and directories to.
6538 This directory is only used when the function `system-move-file-to-trash'
6539 is not defined.
6540 Relative paths are interpreted relative to `default-directory'.
6541 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6551 "Move the file (or directory) named FILENAME to the trash.
6552 When `delete-by-moving-to-trash' is non-nil, this function is
6553 called by `delete-file' and `delete-directory' instead of
6554 deleting files outright.
6556 If the function `system-move-file-to-trash' is defined, call it
6557 with FILENAME as an argument.
6558 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6559 directory.
6560 Otherwise, trash FILENAME using the freedesktop.org conventions,
6561 like the GNOME, KDE and XFCE desktop environments. Emacs only
6565 ;; If `trash-directory' is non-nil, move the file there.
6569 trash-dir)))
6570 ;; We can't trash a parent directory of trash-directory.
6573 trash-dir filename))
6576 ;; Ensure that the trashed file-name is unique.
6583 ;; If `system-move-file-to-trash' is defined, use it.
6586 ;; Otherwise, use the freedesktop.org method, as specified at
6587 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6598 ;; Check if we have permissions to delete.
6602 ;; The trashed file cannot be the trash dir or its parent.
6605 trash-files-dir filename))
6608 trash-info-dir filename))
6610 ;; Ensure that the trash directory exists; otherwise, create it.
6621 ;; Try to move to trash with .trashinfo undo information
6626 ;; Perform url-encoding on FN. For compatibility with
6627 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6628 ;; for path separators.
6633 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6634 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6647 fn))
6652 ;; Attempt to make .trashinfo file, trying up to 5
6653 ;; times. The .trashinfo file is opened with O_EXCL,
6654 ;; as per trash-spec 0.7, even if that can be a problem
6655 ;; on old NFS versions...
6659 trash-files-dir))
6661 success info-fn)
6666 trash-info-dir))
6674 ;; Uniquify new-fn. (Some file managers do not
6675 ;; like Emacs-style backup file names---e.g. bug
6676 ;; 170956 in Konqueror bug tracker.)
6681 ;; Finally, try to move the file to the trashcan.
6685 \f
6710 ;;; files.el ends here