| blob | a8b2a20409416e9b75d880a51280e63628102948 |
1 ;;; files.el --- file input and output commands for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1992-2014 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Package: emacs
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Defines most of Emacs's file- and directory-handling functions,
26 ;; including basic file visiting, backup generation, link handling,
27 ;; ITS-id version control, load- and write-hook handling, and the like.
29 ;;; Code:
34 "Backups of edited data files."
38 "Finding files."
43 "Non-nil means delete auto-save file when a buffer is saved or killed.
45 Note that the auto-save file will not be deleted if the buffer is killed
46 when it has unsaved changes."
51 nil
52 "Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 FROM with TO when it appears in a directory name. This replacement is
55 done when setting up the default directory of a newly visited file.
57 FROM is matched against directory names anchored at the first
61 FROM and TO should be equivalent names, which refer to the
62 same directory. Do not use `~' in the TO strings;
63 they should be ordinary absolute directory names.
65 Use this feature when you have directories which you normally refer to
66 via absolute symbolic links. Make TO the name of the link, and FROM
67 the name it is linked to."
76 "Non-nil means make a backup of a file the first time it is saved.
77 This can be done by renaming the file or by copying.
79 Renaming means that Emacs renames the existing file so that it is a
80 backup file, then writes the buffer into a new file. Any other names
81 that the old file had will now refer to the backup file. The new file
82 is owned by you and its group is defaulted.
84 Copying means that Emacs copies the existing file into the backup
85 file, then writes the buffer on top of the existing file. Any other
86 names that the old file had will now refer to the new (edited) file.
87 The file's owner and group are unchanged.
89 The choice of renaming or copying is controlled by the variables
90 `backup-by-copying', `backup-by-copying-when-linked',
91 `backup-by-copying-when-mismatch' and
92 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
96 ;; Do this so that local variables based on the file name
97 ;; are not overridden by the major mode.
99 "Non-nil means don't make a backup, regardless of the other parameters.
100 This variable is intended for use by making it local to a buffer.
105 "Non-nil means always use copying to create backup files.
106 See documentation of variable `make-backup-files'."
111 "Non-nil means use copying to create backups for files with multiple names.
112 This causes the alternate names to refer to the latest version as edited.
113 This variable is relevant only if `backup-by-copying' is nil."
118 "Non-nil means create backups by copying if this preserves owner or group.
119 Renaming may still be used (subject to control of other variables)
120 when it would not result in changing the owner or group of the file;
121 that is, for files which are owned by you and whose group matches
122 the default for a new file created there by you.
123 This variable is relevant only if `backup-by-copying' is nil."
130 "Non-nil means create backups by copying to preserve a privileged owner.
131 Renaming may still be used (subject to control of other variables)
132 when it would not result in changing the owner of the file or if the owner
133 has a user id greater than the value of this variable. This is useful
134 when low-numbered uid's are used for special system users (such as root)
135 that must maintain ownership of certain files.
136 This variable is relevant only if `backup-by-copying' and
137 `backup-by-copying-when-mismatch' are nil."
142 "Predicate that looks at a file name and decides whether to make backups.
146 "Non-nil in a buffer means always offer to save buffer on exit.
147 Do so even if the buffer is not visiting a file.
148 Automatically local in all buffers."
155 "Non-nil means find a file under alternative names, in existing buffers.
156 This means if any existing buffer is visiting the file you want
157 under another name, you get the existing buffer instead of a new buffer."
162 "Non-nil means visit a file under its truename.
163 The truename of a file is found by chasing all links
164 both at the file level and at the levels of the containing directories."
170 "Specify which files should be reverted without query.
171 The value is a list of regular expressions.
172 If the file name matches one of these regular expressions,
173 then `revert-buffer' reverts the file without querying
174 if the file has changed on disk and you have not edited the buffer."
179 "The device number and file number of the file visited in the current buffer.
180 The value is a list of the form (FILENUM DEVNUM).
181 This pair of numbers uniquely identifies the file.
195 "The directory for writing small temporary files.
196 If non-nil, this directory is used instead of `temporary-file-directory'
197 by programs that create small temporary files. This is for systems that
198 have fast storage with limited space, such as a RAM disk."
203 ;; The system null device. (Should reference NULL_DEVICE from C.)
230 "Non-nil means protect against I/O errors while saving files.
231 Some modes set this non-nil in particular buffers.
233 This feature works by writing the new contents into a temporary file
234 and then renaming the temporary file to replace the original.
235 In this way, any I/O error in writing leaves the original untouched,
236 and there is never any instant where the file is nonexistent.
238 Note that this feature forces backups to be made by copying.
239 Yet, at the same time, saving a precious file
240 breaks any hard links between it and other files.
242 This feature is advisory: for example, if the directory in which the
243 file is being saved is not writable, Emacs may ignore a non-nil value
244 of `file-precious-flag' and write directly into the file.
246 See also: `break-hardlink-on-save'."
251 "Whether to allow breaking hardlinks when saving files.
252 If non-nil, then when saving a file that exists under several
253 names \(i.e., has multiple hardlinks), break the hardlink
254 associated with `buffer-file-name' and write to a new file, so
255 that the other instances of the file are not affected by the
256 save.
258 If `buffer-file-name' refers to a symlink, do not break the symlink.
260 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
261 For example, if the directory in which a file is being saved is not
262 itself writable, then error instead of saving in some
263 hardlink-nonbreaking way.
265 See also `backup-by-copying' and `backup-by-copying-when-linked'."
271 "Control use of version numbers for backup files.
272 When t, make numeric backup versions unconditionally.
273 When nil, make them for files that have some already.
274 The value `never' means do not make them."
284 "When cleaning directory, number of versions to keep."
290 "If t, delete excess backup versions silently.
291 If nil, ask confirmation. Any other value prevents any trimming."
298 "Number of oldest versions to keep when a new numbered backup is made."
304 "Number of newest versions to keep when a new numbered backup is made.
305 Includes the new backup. Must be > 0"
311 "Whether to add a newline automatically at the end of the file.
313 A value of t means do this only when the file is about to be saved.
314 A value of `visit' means do this right after the file is visited.
315 A value of `visit-save' means do it at both of those times.
316 Any other non-nil value means ask user whether to add a newline, when saving.
317 A value of nil means don't add newlines.
319 Certain major modes set this locally to the value obtained
320 from `mode-require-final-newline'."
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)
421 "List of functions to be called for `find-file' on nonexistent file.
422 These functions are called as soon as the error is detected.
423 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."
440 "List of functions to be called before writing out a buffer to a file.
441 If one of them returns non-nil, the file is considered already written
442 and the rest are not called.
443 These hooks are considered to pertain to the visited file.
444 So any buffer-local binding of this variable is discarded if you change
446 change the major mode.
448 This hook is not run if any of the functions in
449 `write-contents-functions' returns non-nil. Both hooks pertain
450 to how to save a buffer to file, for instance, choosing a suitable
451 coding system and setting mode bits. (See Info
452 node `(elisp)Saving Buffers'.) To perform various checks or
464 "List of functions to be called before writing out a buffer to a file.
465 If one of them returns non-nil, the file is considered already written
466 and the rest are not called and neither are the functions in
467 `write-file-functions'.
469 This variable is meant to be used for hooks that pertain to the
470 buffer's contents, not to the particular visited file; thus,
471 `set-visited-file-name' does not clear this variable; but changing the
472 major mode does clear it.
474 For hooks that _do_ pertain to the particular visited file, use
475 `write-file-functions'. Both this variable and
476 `write-file-functions' relate to how a buffer is saved to file.
477 To perform various checks or updates before the buffer is saved,
482 "Control use of local variables in files you visit.
483 The value can be t, nil, :safe, :all, or something else.
485 A value of t means file local variables specifications are obeyed
486 if all the specified variable values are safe; if any values are
487 not safe, Emacs queries you, once, whether to set them all.
488 \(When you say yes to certain values, they are remembered as safe.)
490 :safe means set the safe variables, and ignore the rest.
491 :all means set all variables, whether safe or not.
492 (Don't set it permanently to :all.)
493 A value of nil means always ignore the file local variables.
495 Any other value means always query you once whether to set them all.
496 \(When you say yes to certain values, they are remembered as safe, but
499 This variable also controls use of major modes specified in
500 a -*- line.
503 always obeys file local variable specifications and the -*- line,
504 and ignores this variable."
505 :risky t
514 "Non-nil means enable use of directory-local variables.
515 Some modes may wish to set this to nil to prevent directory-local
518 ;; This is an odd variable IMO.
519 ;; You might wonder why it is needed, when we could just do:
520 ;; (set (make-local-variable 'enable-local-variables) nil)
521 ;; These two are not precisely the same.
522 ;; Setting this variable does not cause -*- mode settings to be
523 ;; ignored, whereas setting enable-local-variables does.
524 ;; Only three places in Emacs use this variable: tar and arc modes,
525 ;; and rmail. The first two don't need it. They already use
526 ;; inhibit-local-variables-regexps, which is probably enough, and
527 ;; could also just set enable-local-variables locally to nil.
528 ;; Them setting it has the side-effect that dir-locals cannot apply to
529 ;; eg tar files (?). FIXME Is this appropriate?
530 ;; AFAICS, rmail is the only thing that needs this, and the only
531 ;; reason it uses it is for BABYL files (which are obsolete).
532 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
533 ;; to respect, so that find-file on a BABYL file will switch to
534 ;; rmail-mode automatically (this is nice, but hardly essential,
535 ;; since most people are used to explicitly running a command to
536 ;; access their mail; M-x gnus etc). Rmail files may happen to
537 ;; contain Local Variables sections in messages, which Rmail wants to
538 ;; ignore. So AFAICS the only reason this variable exists is for a
539 ;; minor convenience feature for handling of an obsolete Rmail file format.
541 "Like `enable-local-variables' but meant for buffer-local bindings.
542 The meaningful values are nil and non-nil. The default is non-nil.
543 If a major mode sets this to nil, buffer-locally, then any local
544 variables list in a file visited in that mode will be ignored.
546 This variable does not affect the use of major modes specified
551 The value can be t, nil or something else.
552 A value of t means obey `eval' variables.
553 A value of nil means ignore them; anything else means query."
554 :risky t
560 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
569 "Non-nil means buffers visiting files read-only do so in view mode.
570 In fact, this means that all read-only buffers normally have
571 View mode enabled, including buffers that are read-only because
572 you visit a file you cannot alter, and buffers you make read-only
578 "History list of file names entered in the minibuffer.
580 Maximum length of the history list is determined by the value
582 \f
585 "Provides support for ange-ftp host name completion.
586 Runs the usual ange-ftp hook, but only for completion operations."
587 ;; Having this here avoids the need to load ange-ftp when it's not
588 ;; really in use.
594 inhibit-file-name-handlers)))
602 "Convert a standard file's name to something suitable for the OS.
603 This means to guarantee valid names and perhaps to canonicalize
604 certain patterns.
606 FILENAME should be an absolute file name since the conversion rules
607 sometimes vary depending on the position in the file name. E.g. c:/foo
608 is a valid DOS file name, but c:/bar/c:/foo is not.
610 This function's standard definition is trivial; it just returns
611 the argument. However, on Windows and DOS, replace invalid
612 characters. On DOS, make sure to obey the 8.3 limitations.
613 In the native Windows build, turn Cygwin names into native names,
614 and also turn slashes into backslashes if the shell requires it (see
615 `w32-shell-dos-semantics').
617 See Info node `(elisp)Standard File Names' for more details."
622 ;; Replace invalid filename characters with !
626 name))
634 "Read directory name, prompting with PROMPT and completing in directory DIR.
635 Value is not expanded---you must call `expand-file-name' yourself.
636 Default name to DEFAULT-DIRNAME if user exits with the same
637 non-empty string that was inserted by this function.
638 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
639 or just DIR if INITIAL is nil.)
640 If the user exits with an empty minibuffer, this function returns
641 an empty string. (This can only happen if the user erased the
642 pre-inserted contents or if `insert-default-directory' is nil.)
643 Fourth arg MUSTMATCH non-nil means require existing directory's name.
644 Non-nil and non-t means also require confirmation after completion.
645 Fifth arg INITIAL specifies text to start with.
646 DIR should be an absolute directory name. It defaults to
647 the value of `default-directory'."
652 dir))
653 mustmatch initial
656 \f
658 "Show the current default directory."
663 "Value of the CDPATH environment variable, as a list.
667 "Explode a search path into a list of directory names.
668 Directories are separated by `path-separator' (which is colon in
669 GNU and Unix systems). Substitute environment variables into the
670 resulting list of directory names. For an empty path element (i.e.,
671 a leading or trailing separator, or two adjacent separators), return
672 nil (meaning `default-directory') as the associated list element."
680 "Change current directory to given absolute file name DIR."
681 ;; Put the name into directory syntax now,
682 ;; because otherwise expand-file-name may give some bad results.
684 ;; We used to additionally call abbreviate-file-name here, for an
685 ;; unknown reason. Problem is that most buffers are setup
686 ;; without going through cd-absolute and don't call
687 ;; abbreviate-file-name on their default-directory, so the few that
688 ;; do end up using a superficially different directory.
700 "Make DIR become the current buffer's default directory.
701 If your environment includes a `CDPATH' variable, try each one of
702 that list of directories (separated by occurrences of
703 `path-separator') when resolving a relative directory name.
704 The path separator is colon in GNU and GNU-like systems."
707 ;; FIXME: There's a subtle bug in the completion below. Seems linked
708 ;; to a fundamental difficulty of implementing `predicate' correctly.
709 ;; The manifestation is that TAB may list non-directories in the case where
710 ;; those files also correspond to valid directories (if your cd-path is (A/
711 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
712 ;; will be listed as valid completions).
713 ;; This is because `a' (listed because of A/a) is indeed a valid choice
714 ;; (which will lead to the use of B/a).
719 cd-path nil))
728 default-directory default-directory
729 t))))
739 "Load the Lisp file named FILE."
740 ;; This is a case where .elc makes a lot of sense.
747 "Search for FILENAME through PATH.
748 If found, return the absolute file name of FILENAME, with its suffixes;
749 otherwise return nil.
750 PATH should be a list of directories to look in, like the lists in
751 `exec-path' or `load-path'.
752 If SUFFIXES is non-nil, it should be a list of suffixes to append to
755 If non-nil, PREDICATE is used instead of `file-readable-p'.
757 This function will normally skip directories, so if you want it to find
758 directories, make sure the PREDICATE function returns `dir-ok' for them.
760 PREDICATE can also be an integer to pass to the `access' system call,
761 in which case file-name handlers are ignored. This usage is deprecated.
762 For compatibility, PREDICATE can also be one of the symbols
763 `executable', `readable', `writable', or `exists', or a list of
764 one or more of those symbols."
775 "Do completion for file names passed to `locate-file'."
778 ;; FIXME: maybe we should use completion-file-name-table instead,
779 ;; tho at least for `load', the arg is passed through
780 ;; substitute-in-file-name for historical reasons.
790 ;; If we have files like "foo.el" and "foo.elc", we could load one of
791 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
792 ;; preferred way. So if we list all 3, that gives a lot of redundant
793 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
794 ;; the user does want to pay attention to the extension. We try to
795 ;; diffuse this tension by stripping the suffix, except when the
796 ;; result is a single element (i.e. usually we only list "foo" unless
797 ;; it's the only remaining element in the list, in which case we do
798 ;; list "foo", "foo.elc" and "foo.el").
809 string-file dir))
814 ;; Switching from names to names+fullnames creates a non-monotonicity
815 ;; which can cause problems with things like partial-completion.
816 ;; To minimize the problem, filter out completion-regexp-list, so that
817 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
818 ;; from `names' which only matched `string' when they still had
819 ;; their suffix.
821 ;; Remove duplicates of the first element, so that we can easily check
822 ;; if `names' really only contains a single element.
825 ;; There's no more than one matching non-suffixed element, so expand
826 ;; the list by adding the suffixed elements as well.
829 string-dir names string-file pred action)))))
832 "Do completion for file names passed to `locate-file'.
833 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
837 string nil action))
841 "Regexp of directory names which stop the search in `locate-dominating-file'.
842 Any directory whose name matches this regexp will be treated like
843 a kind of root directory by `locate-dominating-file' which will stop its search
844 when it bumps into it.
845 The default regexp prevents fruitless and time-consuming attempts to find
846 special files in directories in which filenames are interpreted as hostnames,
849 ;; (defun locate-dominating-files (file regexp)
850 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
851 ;; Stop at the first parent where a matching file is found and return the list
852 ;; of files that that match in this directory."
853 ;; (catch 'found
854 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
855 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
856 ;; (let ((user nil)
857 ;; ;; Abbreviate, so as to stop when we cross ~/.
858 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
859 ;; files)
860 ;; (while (and dir
861 ;; ;; As a heuristic, we stop looking up the hierarchy of
862 ;; ;; directories as soon as we find a directory belonging to
863 ;; ;; another user. This should save us from looking in
864 ;; ;; things like /net and /afs. This assumes that all the
865 ;; ;; files inside a project belong to the same user.
866 ;; (let ((prev-user user))
867 ;; (setq user (nth 2 (file-attributes dir)))
868 ;; (or (null prev-user) (equal user prev-user))))
869 ;; (if (setq files (condition-case nil
870 ;; (directory-files dir 'full regexp 'nosort)
871 ;; (error nil)))
872 ;; (throw 'found files)
873 ;; (if (equal dir
874 ;; (setq dir (file-name-directory
875 ;; (directory-file-name dir))))
876 ;; (setq dir nil))))
877 ;; nil)))
880 "Look up the directory hierarchy from FILE for a directory containing NAME.
881 Stop at the first parent directory containing a file NAME,
882 and return the directory. Return nil if not found.
883 Instead of a string, NAME can also be a predicate taking one argument
884 \(a directory) and returning a non-nil value if that directory is the one for
885 which we're looking."
886 ;; We used to use the above locate-dominating-files code, but the
887 ;; directory-files call is very costly, so we're much better off doing
888 ;; multiple calls using the code in here.
889 ;;
890 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
891 ;; `name' in /home or in /.
894 ;; `user' is not initialized outside the loop because
895 ;; `file' may not exist, so we may have to walk up part of the
896 ;; hierarchy before we find the "initial UID". Note: currently unused
897 ;; (user nil)
898 try)
901 ;; FIXME: Disabled this heuristic because it is sometimes
902 ;; inappropriate.
903 ;; As a heuristic, we stop looking up the hierarchy of
904 ;; directories as soon as we find a directory belonging
905 ;; to another user. This should save us from looking in
906 ;; things like /net and /afs. This assumes that all the
907 ;; files inside a project belong to the same user.
908 ;; (let ((prev-user user))
909 ;; (setq user (nth 2 (file-attributes file)))
910 ;; (and prev-user (not (equal user prev-user))))
922 "Non-nil means warn if cannot access `user-emacs-directory'.
923 Set this to nil at your own risk..."
929 "Return an absolute per-user Emacs-specific file name.
930 If NEW-NAME exists in `user-emacs-directory', return it.
931 Else if OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
932 Else return NEW-NAME in `user-emacs-directory', creating the
933 directory if it does not exist."
941 at-home
942 ;; Make sure `user-emacs-directory' exists,
943 ;; unless we're in batch mode or dumping Emacs.
945 purify-flag
959 user-emacs-directory-warning
961 ;; Only warn once per Emacs session.
965 Unable to %s `user-emacs-directory' (%s).
966 Any data that would normally be written there may be lost!
967 If you never want to see this message again,
968 customize the variable `user-emacs-directory-warning'."
969 errtype user-emacs-directory)))))
970 bestname))))
974 "Search for COMMAND in `exec-path' and return the absolute file name.
975 Return nil if COMMAND is not found anywhere in `exec-path'."
976 ;; Use 1 rather than file-executable-p to better match the behavior of
977 ;; call-process.
981 "Load the Emacs Lisp library named LIBRARY.
982 This is an interface to the function `load'. LIBRARY is searched
983 for in `load-path', both with and without `load-suffixes' (as
984 well as `load-file-rep-suffixes').
986 See Info node `(emacs)Lisp Libraries' for more details.
987 See `load-file' for a different interface to `load'."
991 load-path
996 "Test whether FILE specifies a location on a remote system.
997 A file is considered remote if accessing it is likely to
998 be slower or less reliable than accessing local files.
1000 `file-remote-p' never opens a new remote connection. It can
1001 only reuse a connection that is already open.
1003 Return nil or a string identifying the remote connection
1004 \(ideally a prefix of FILE). Return nil if FILE is a relative
1005 file name.
1007 When IDENTIFICATION is nil, the returned string is a complete
1008 remote identifier: with components method, user, and host. The
1009 components are those present in FILE, with defaults filled in for
1010 any that are missing.
1012 IDENTIFICATION can specify which part of the identification to
1013 return. IDENTIFICATION can be the symbol `method', `user',
1014 `host', or `localname'. Any other value is handled like nil and
1015 means to return the complete identification. The string returned
1016 for IDENTIFICATION `localname' can differ depending on whether
1017 there is an existing connection.
1019 If CONNECTED is non-nil, return an identification only if FILE is
1020 located on a remote system and a connection is established to
1021 that remote system.
1023 Tip: You can use this expansion of remote identifier components
1024 to derive a new remote file name from an existing one. For
1030 same remote identifier as FILE but expanded; a name such as
1035 nil)))
1037 ;; Probably this entire variable should be obsolete now, in favor of
1038 ;; something Tramp-related (?). It is not used in many places.
1039 ;; It's not clear what the best file for this to be in is, but given
1040 ;; it uses custom-initialize-delay, it is easier if it is preloaded
1041 ;; rather than autoloaded.
1043 ;; This used to try various hard-coded places for remsh, rsh, and
1044 ;; rcmd, trying to guess based on location whether "rsh" was
1045 ;; "restricted shell" or "remote shell", but I don't see the point
1046 ;; in this day and age. Almost everyone will use ssh, and have
1047 ;; whatever command they want to use in PATH.
1054 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1061 "Whether to use the remote file-name cache for read access.
1062 When `nil', never expire cached values (caution)
1063 When `t', never use the cache (safe, but may be slow)
1064 A number means use cached values for that amount of seconds since caching.
1066 The attributes of remote files are cached for better performance.
1067 If they are changed outside of Emacs's control, the cached values
1068 become invalid, and must be reread. If you are sure that nothing
1069 other than Emacs changes the files, you can set this variable to `nil'.
1071 If a remote file is checked regularly, it might be a good idea to
1072 let-bind this variable to a value less than the interval between
1073 consecutive checks. For example:
1075 (defun display-time-file-nonempty-p (file)
1076 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1077 (and (file-exists-p file)
1078 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1089 "Copy the file FILE into a temporary file on this machine.
1090 Returns the name of the local copy, or nil, if FILE is directly
1091 accessible."
1092 ;; This formerly had an optional BUFFER argument that wasn't used by
1093 ;; anything.
1097 nil)))
1100 "Return the truename of FILENAME.
1101 If FILENAME is not absolute, first expands it against `default-directory'.
1102 The truename of a file name is found by chasing symbolic links
1103 both at the level of the file and at the level of the directories
1104 containing it, until no links are left at any level.
1107 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1108 ;; COUNTER can be a cons cell whose car is the count of how many
1109 ;; more links to chase before getting an error.
1110 ;; PREV-DIRS can be a cons cell whose car is an alist
1111 ;; of truenames we've just recently computed.
1125 ;; For speed, remove the ange-ftp completion handler from the list.
1126 ;; We know it's not needed here.
1127 ;; For even more speed, do this only on the outermost call.
1134 ;; andrewi@harlequin.co.uk - on Windows, there is an issue with
1135 ;; case differences being ignored by the OS, and short "8.3 DOS"
1136 ;; name aliases existing for all files. (The short names are not
1137 ;; reported by directory-files, but can be used to refer to files.)
1138 ;; It seems appropriate for file-truename to resolve these issues in
1139 ;; the most natural way, which on Windows is to call the function
1140 ;; `w32-long-file-name' - this returns the exact name of a file as
1141 ;; it is stored on disk (expanding short name aliases with the full
1142 ;; name in the process).
1145 ;; If filename exists, use its long name. If it doesn't
1146 ;; exist, the recursion below on the directory of filename
1147 ;; will drill down until we find a directory that exists,
1148 ;; and use the long name of that, with the extra
1149 ;; non-existent path components concatenated.
1154 ;; If this file directly leads to a link, process that iteratively
1155 ;; so that we don't use lots of stack.
1161 ;; For file name that has a special handler, call handler.
1162 ;; This is so that ange-ftp can save time by doing a no-op.
1165 done t)
1167 target dirfile)
1168 ;; Get the truename of the directory.
1170 ;; If these are equal, we have the (or a) root directory.
1174 ;; If this is the same dir we last got the truename for,
1175 ;; save time--don't recalculate.
1185 done t)
1188 done t)
1189 ;; Put it back on the file name.
1191 ;; Is the file name the name of a link?
1194 ;; Yes => chase that link, then start all over
1195 ;; since the link may point to a directory name that uses links.
1196 ;; We can't safely use expand-file-name here
1197 ;; since target might look like foo/../bar where foo
1198 ;; is itself a link. Instead, we handle . and .. above.
1201 target
1203 done nil)
1204 ;; No, we are done!
1206 filename))
1209 "Chase links in FILENAME until a name that is not a link.
1210 Unlike `file-truename', this does not check whether a parent
1211 directory name is a symbolic link.
1212 If the optional argument LIMIT is a number,
1213 it means chase no more than that many links and then stop."
1221 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1224 ;; Handle `..' by hand, since it needs to work in the
1225 ;; target of any directory symlink.
1226 ;; This code is not quite complete; it does not handle
1227 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1231 ;; Chase links in the default dir of the symlink.
1235 ;; Now find the parent of that dir.
1239 newname))
1241 ;; A handy function to display file sizes in human-readable form.
1242 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1244 "Produce a string showing FILE-SIZE in human-readable form.
1246 Optional second argument FLAVOR controls the units and the display format:
1248 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1250 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1252 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1255 1024.0
1258 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1264 "%.1f%s%s"
1266 file-size
1268 "K"
1273 "Create a temporary file.
1274 The returned file name (created by appending some random characters at the end
1275 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1276 is guaranteed to point to a newly created empty file.
1277 You can then use `write-region' to write new data into the file.
1279 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1281 If SUFFIX is non-nil, add that at the end of the file name."
1283 file)
1286 ;; Create temp files with strict access rights. It's easy to
1287 ;; loosen them later, whereas it's impossible to close the
1288 ;; time-window of loose permissions otherwise.
1296 temporary-file-directory)
1298 temporary-file-directory))))
1304 nil)
1306 ;; the file was somehow created by someone else between
1307 ;; `make-temp-name' and `write-region', let's try again.
1308 nil)
1309 file)
1310 ;; Reset the umask.
1314 "Change the encoding of FILE's name from CODING to NEW-CODING.
1315 The value is a new name of FILE.
1316 Signals a `file-already-exists' error if a file of the new name
1317 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1318 is non-nil. A number as fourth arg means request confirmation if
1319 the new name already exists. This is what happens in interactive
1320 use with M-x."
1323 default-file-name-coding-system))
1325 from-coding to-coding)
1327 ;; We provide the default coding only when it seems that
1328 ;; the filename is correctly decoded by the default
1329 ;; coding.
1335 filename default-coding)
1336 default-coding))
1340 ;; We provide the default coding only when a user is going to
1341 ;; change the encoding not from the default coding.
1345 filename from-coding)))
1348 filename from-coding default-coding)
1349 default-coding)))
1353 default-file-name-coding-system))
1354 ;; FILE should have been decoded by DEFAULT-CODING.
1358 ;; Suppress further encoding.
1363 newname))
1364 \f
1366 "Whether confirmation is requested before visiting a new file or buffer.
1367 If nil, confirmation is not requested.
1368 If the value is `after-completion', confirmation is only
1369 requested if the user called `minibuffer-complete' right before
1370 `minibuffer-complete-and-exit'.
1371 Any other non-nil value means to request confirmation.
1373 This affects commands like `switch-to-buffer' and `find-file'."
1381 "Whether to request confirmation before visiting a new file or buffer.
1382 The variable `confirm-nonexistent-file-or-buffer' determines the
1383 return value, which may be passed as the REQUIRE-MATCH arg to
1384 `read-buffer' or `find-file-read-args'."
1392 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1393 BODY should use the minibuffer at most once.
1394 Recursive uses of the minibuffer are unaffected (FUN is not
1395 called additional times).
1397 This macro actually adds an auxiliary function that calls FUN,
1398 rather than FUN itself, to `minibuffer-setup-hook'."
1404 ;; Clear out this hook so it does not interfere
1405 ;; with any recursive minibuffer usage.
1416 t))
1419 "Edit file FILENAME.
1420 Switch to a buffer visiting file FILENAME,
1421 creating one if none already exists.
1422 Interactively, the default if you just type RET is the current directory,
1423 but the visited file name is available through the minibuffer history:
1424 type M-n to pull it into the minibuffer.
1426 You can visit files on remote machines by specifying something
1427 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1428 also visit local files as a different user by specifying
1429 /sudo::FILE for the file name.
1430 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1431 manual, for more about this.
1433 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1434 expand wildcards (if any) and visit multiple files. You can
1435 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1437 To visit a file without any kind of conversion and without
1448 "Edit file FILENAME, in another window.
1451 an existing one. See the function `display-buffer'.
1453 Interactively, the default if you just type RET is the current directory,
1454 but the visited file name is available through the minibuffer history:
1455 type M-n to pull it into the minibuffer.
1457 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1458 expand wildcards (if any) and visit multiple files."
1471 "Edit file FILENAME, in another frame.
1474 an existing one. See the function `display-buffer'.
1476 Interactively, the default if you just type RET is the current directory,
1477 but the visited file name is available through the minibuffer history:
1478 type M-n to pull it into the minibuffer.
1480 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1481 expand wildcards (if any) and visit multiple files."
1494 "Edit the existing file FILENAME.
1496 file names with wildcards."
1513 value))
1516 "Edit file FILENAME but don't allow changes.
1525 "Edit file FILENAME in another window but don't allow changes.
1534 "Edit file FILENAME in another frame but don't allow changes.
1543 "Find file FILENAME as a replacement for the file in the next window.
1544 This command does not select that window.
1548 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1549 expand wildcards (if any) and replace the file with multiple files."
1560 "Find alternate file: " file-dir nil
1562 t))))
1569 ;; Defined and used in buffer.c, but not as a DEFVAR_LISP.
1571 "Hook run when a buffer is killed.
1572 The buffer being killed is current while the hook is running.
1573 See `kill-buffer'.
1575 Note: Be careful with let-binding this hook considering it is
1579 "Find file FILENAME, select its buffer, kill previous buffer.
1580 If the current buffer now contains an empty file that you just visited
1581 \(presumably by mistake), use this command to visit the file you really want.
1585 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1586 expand wildcards (if any) and replace the file with multiple files.
1588 If the current buffer is an indirect buffer, or the base buffer
1589 for one or more indirect buffers, the other buffer(s) are not
1590 killed."
1599 "Find alternate file: " file-dir nil
1601 t)))
1613 ;; Run `kill-buffer-hook' here. It needs to happen before
1614 ;; variables like `buffer-file-name' etc are set to nil below,
1615 ;; because some of the hooks that could be invoked
1616 ;; (e.g., `save-place-to-alist') depend on those variables.
1617 ;;
1618 ;; Note that `kill-buffer-hook' is not what queries whether to
1619 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1620 ;; asks that itself. Thus, there's no need to temporarily do
1621 ;; `(set-buffer-modified-p nil)' before running this hook.
1623 ;; Okay, now we can end-of-life the old buffer.
1630 ;; This prevents us from finding the same buffer
1631 ;; if we specified the same file again.
1635 ;; Likewise for dired buffers.
1639 ;; This executes if find-file gets an error
1640 ;; and does not really find anything.
1641 ;; We put things back as they were.
1642 ;; If find-file actually finds something, we kill obuf below.
1651 ;; We already ran these; don't run them again.
1654 \f
1656 "Create a suitably named buffer for visiting FILENAME, and return it.
1657 FILENAME (sans directory) is used unchanged if that name is free;
1658 otherwise a string <2> or <3> or ... is appended to get an unused name.
1660 Emacs treats buffers whose names begin with a space as internal buffers.
1661 To avoid confusion when visiting a file whose name begins with a space,
1668 lastname))))
1671 "Create and return a buffer with a name based on NAME.
1672 Choose the buffer's name using `generate-new-buffer-name'."
1676 "Regexp to match the automounter prefix in a directory name."
1685 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1687 home directory is a root directory) and removes automounter prefixes
1688 \(see the variable `automount-dir-prefix')."
1689 ;; Get rid of the prefixes added by the automounter.
1696 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1697 ;; To fix this right, we need a `file-name-case-sensitive-p'
1698 ;; function, but we don't have that yet, so just guess.
1701 ;; If any elt of directory-abbrev-alist matches this name,
1702 ;; abbreviate accordingly.
1708 ;; Compute and save the abbreviated homedir name.
1709 ;; We defer computing this until the first time it's needed, to
1710 ;; give time for directory-abbrev-alist to be set properly.
1711 ;; We include a slash at the end, to avoid spurious matches
1712 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1719 ;; If FILENAME starts with the abbreviated homedir,
1720 ;; make it start with `~' instead.
1722 ;; If the home dir is just /, don't change it.
1725 ;; MS-DOS root directories can come with a drive letter;
1726 ;; Novell Netware allows drive letters beyond `Z:'.
1734 filename)))
1737 "Return the buffer visiting file FILENAME (a string).
1738 This is like `get-file-buffer', except that it checks for any buffer
1739 visiting the same file, possibly under a different name.
1740 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1741 and others are ignored.
1742 If there is no such live buffer, return nil."
1755 found)
1765 ;; Verify this buffer's file number
1766 ;; still belongs to its file.
1769 attributes)
1773 found))))
1774 \f
1776 "Non-nil means file-visiting commands should handle wildcards.
1777 For example, if you specify `*.c', that would visit all the files
1778 whose names match the pattern."
1784 "Non-nil means suppress warning messages for symlinked files.
1785 When nil, Emacs prints a warning when visiting a file that is already
1786 visited, but with a different name. Setting this option to t
1787 suppresses this warning."
1793 "Maximum size of file above which a confirmation is requested.
1794 When nil, never request confirmation."
1801 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1802 OP-TYPE specifies the file operation being performed (for message to user)."
1811 "Read file FILENAME into a buffer and return the buffer.
1812 If a buffer exists visiting FILENAME, return that one, but
1813 verify that the file has not changed since visited or saved.
1814 The buffer is not selected, just returned to the caller.
1815 Optional second arg NOWARN non-nil means suppress any warning messages.
1816 Optional third arg RAWFILE non-nil means the file is read literally.
1817 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1818 and visit all the matching files. When wildcards are actually
1819 used and expanded, return a list of buffers that are visiting
1820 the various files."
1827 'find-directory-functions
1830 filename)))
1833 find-file-wildcards
1847 ;; Find any buffer for a file which has same truename.
1849 ;; Let user know if there is a buffer with the same truename.
1853 find-file-suppress-same-file-warnings
1857 ;; Optionally also find that buffer.
1860 ;; Check to see if the file looks uncommonly large.
1864 ;; We are using an existing buffer.
1871 ;; Certain files should be reverted automatically
1872 ;; if they have changed on disk and not in the buffer.
1880 found))
1890 "File %s changed on disk. Discard your edits? "
1895 "File %s changed on disk. Discard your edits in %s? "
1903 ;; Check if a formerly read-only file has become
1904 ;; writable and vice versa, but if the buffer agrees
1905 ;; with the new state of the file, that is ok too.
1913 buffer-file-name
1920 nonexistent
1921 ;; It is confusing to ask whether to visit
1922 ;; non-literally if they have the file in
1923 ;; hexl-mode or image-mode.
1929 "The file %s is already visited normally,
1930 and you have edited the buffer. Now you have asked to visit it literally,
1931 meaning no coding system handling, format conversion, or local variables.
1932 Emacs can only visit a file in one way at a time.
1934 Do you want to save the file, and visit it literally instead? "
1935 "The file %s is already visited literally,
1936 meaning no coding system handling, format conversion, or local variables.
1937 You have edited the buffer. Now you have asked to visit the file normally,
1938 but Emacs can only visit a file in one way at a time.
1945 rawfile truename number))
1949 "\
1950 Do you want to discard your changes, and visit the file literally now? "
1951 "\
1954 rawfile truename number)
1960 "The file %s is already visited normally.
1961 You have asked to visit it literally,
1962 meaning no coding system decoding, format conversion, or local variables.
1963 But Emacs can only visit a file in one way at a time.
1965 Do you want to revisit the file literally now? "
1966 "The file %s is already visited literally,
1967 meaning no coding system decoding, format conversion, or local variables.
1968 You have asked to visit it normally,
1969 but Emacs can only visit a file in one way at a time.
1974 rawfile truename number)
1977 ;; Return the buffer we are using.
1978 buf)
1979 ;; Create a new buffer.
1981 ;; find-file-noselect-1 may use a different buffer.
1983 rawfile truename number))))))
1989 ;; Needed in case we are re-visiting the file with a different
1990 ;; text representation.
2007 filename)))
2008 ;; Unconditionally set error
2018 filename)))
2019 ;; Run find-file-not-found-functions until one returns non-nil.
2021 ;; If they fail too, set error.
2023 ;; Record the file's truename, and maybe use that as visited name.
2031 ;; Set buffer's default directory to that of the file.
2033 ;; Turn off backup files for certain file names. Since
2034 ;; this is a permanent local, the major mode won't eliminate it.
2048 \f
2050 "Like `insert-file-contents', but only reads in the file literally.
2051 A buffer may be modified in several ways after reading into the buffer,
2052 to Emacs features such as format decoding, character code
2053 conversion, `find-file-hook', automatic uncompression, etc.
2055 This function ensures that none of these modifications will take place."
2061 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2062 ;; into a file operation instead!
2064 inhibit-file-name-handlers))
2071 filename)))
2072 ;; Check whether the file is uncommonly large
2083 "Insert contents of file FILENAME into buffer after point with no conversion.
2085 This function is meant for the user to run interactively.
2086 Don't call it from programs! Use `insert-file-contents-literally' instead.
2087 \(Its calling sequence is different; see its documentation)."
2093 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2094 This has the `permanent-local' property, which takes effect if you
2099 "Visit file FILENAME with no conversion of any kind.
2100 Format conversion and character code conversion are both disabled,
2101 and multibyte characters are disabled in the resulting buffer.
2102 The major mode used is Fundamental mode regardless of the file name,
2103 and local variable specifications in the file are ignored.
2104 Automatic uncompression and adding a newline at the end of the
2105 file due to `require-final-newline' is also disabled.
2107 You cannot absolutely rely on this function to result in
2108 visiting the file literally. If Emacs already has a buffer
2109 which is visiting the file, you get the existing buffer,
2110 regardless of whether it was created literally or not.
2112 In a Lisp program, if you want to be sure of accessing a file's
2113 contents literally, you should create a temporary buffer and then read
2114 the file contents into it using `insert-file-contents-literally'."
2117 "Find file literally: " nil default-directory
2120 \f
2122 _after-find-file-from-revert-buffer
2123 nomodes)
2124 "Called after finding a file and by the default revert function.
2125 Sets buffer mode, parses local variables.
2126 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2127 error in reading the file. WARN non-nil means warn if there
2128 exists an auto-save file more recent than the visited file.
2129 NOAUTO means don't mess with auto-save mode.
2130 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2131 \(see `revert-buffer-in-progress-p' for similar functionality).
2132 Fifth arg NOMODES non-nil means don't alter the file's modes.
2133 Finishes by calling the functions in `find-file-hook'
2134 unless NOMODES is non-nil."
2137 nil
2147 "Symbolic link that points to nonexistent file"
2151 ;; No need to warn if buffer is auto-saved
2152 ;; under the name of the visited file.
2154 auto-save-visited-file-name))
2157 buffer-file-name))
2177 ;; Make people do a little extra work (C-x C-q)
2178 ;; before altering a backup file.
2181 ;; When a file is marked read-only,
2182 ;; make the buffer read-only even if root is looking at it.
2190 ;; If requested, add a newline at the end of the file.
2201 view-read-only
2207 "Eval BODY and turn any error into a FORMAT message.
2208 FORMAT can have a %s escape which will be replaced with the actual error.
2209 If `debug-on-error' is set, errors are not caught, so that you can
2210 debug them.
2211 Avoid using a large BODY since it is duplicated."
2220 "Choose the major mode for this buffer automatically.
2221 Also sets up any specified local variables of the file.
2222 Uses the visited file name, the -*- line, and the local variables spec.
2224 This function is called automatically from `find-file'. In that case,
2225 we may set up the file-specified mode and local variables,
2226 depending on the value of `enable-local-variables'.
2227 In addition, if `local-enable-local-variables' is nil, we do
2228 not set local variables (though we do notice a mode specified with -*-.)
2230 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2231 or from Lisp without specifying the optional argument FIND-FILE;
2232 in that case, this function acts as if `enable-local-variables' were t."
2236 ;; FIXME this is less efficient than it could be, since both
2237 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2242 ;; Turn font lock off and on, to make sure it takes account of
2243 ;; whatever file local variables are relevant to it.
2245 ;; Font-lock-mode (now in font-core.el) can be ON when
2246 ;; font-lock.el still hasn't been loaded.
2253 "Non-nil means to try second pass through `auto-mode-alist'.
2254 This means that if the first case-sensitive search through the alist fails
2255 to find a matching major mode, a second case-insensitive search is made.
2256 On systems with case-insensitive file names, this variable is ignored,
2257 since only a single case-insensitive search through the alist is made."
2263 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2264 ;; c++-mode, java-mode and more) are added through autoload
2265 ;; directives in that file. That way is discouraged since it
2266 ;; spreads out the definition of the initial value.
2312 ;; Less common extensions come here
2313 ;; so more common ones above are found faster.
2321 ;; Besides .gdbinit, gdb documents other names to be usable for init
2322 ;; files, cross-debuggers can use something like
2323 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2324 ;; don't interfere with each other.
2326 ;; GDB 7.5 introduced OBJFILE-gdb.gdb script files; e.g. a file
2327 ;; named 'emacs-gdb.gdb', if it exists, will be automatically
2328 ;; loaded when GDB reads an objfile called 'emacs'.
2336 ("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . sh-mode)
2360 ;; The Fortran standard does not say anything about file extensions.
2361 ;; .f90 was widely used for F90, now we seem to be trapped into
2362 ;; using a different extension for each language revision.
2363 ;; Anyway, the following extensions are supported by gfortran.
2371 ;; The list of archive file extensions should be in sync with
2372 ;; `auto-coding-alist' with `no-conversion' coding system.
2378 ;; Mailer puts message to be edited in
2379 ;; /tmp/Re.... or Message
2382 ;; some news reader is reported to use this
2395 ;; .emacs or .gnus or .viper following a directory delimiter in
2396 ;; Unix, MSDOG or VMS syntax.
2399 ;; _emacs following a directory delimiter
2400 ;; in MsDos syntax
2404 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2405 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2406 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2409 ;; .xs is also used for ld scripts, but seems to be more commonly
2410 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2412 ;; Explained in binutils ld/genscripts.sh. Eg:
2413 ;; A .x script file is the default script.
2414 ;; A .xr script is for linking without relocation (-r flag). Etc.
2418 ;; Common Lisp ASDF package system.
2425 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|djvu\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe)
2437 ;; Windows candidates may be opened case sensitively on Unix
2443 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2444 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2445 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2446 ;; this has lower priority to avoid matching changelog.sgml etc.
2448 ;; either user's dot-files or under /etc or some such
2450 ;; alas not all ~/.*rc files are like this
2451 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2456 ;; this contains everything twice, with space and with colon :-(
2458 ;; Get rid of any trailing .n.m and try again.
2459 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2460 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2461 ;; Using mode nil rather than `ignore' would let the search continue
2462 ;; through this list (with the shortened name) rather than start over.
2465 ;; This should come after "in" stripping (e.g. config.h.in).
2466 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2468 ;; The following should come after the ChangeLog pattern
2469 ;; for the sake of ChangeLog.1, etc.
2470 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2472 "Alist of filename patterns vs corresponding major mode functions.
2473 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2474 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2475 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2476 mode function to use. FUNCTION will be called, unless it is nil.
2478 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2479 calling FUNCTION (if it's not nil), we delete the suffix that matched
2480 REGEXP and search the list again for another match.
2482 The extensions whose FUNCTION is `archive-mode' should also
2483 appear in `auto-coding-alist' with `no-conversion' coding system.
2485 See also `interpreter-mode-alist', which detects executable script modes
2486 based on the interpreters they specify to run,
2491 "Select Conf mode or XML mode according to start of file."
2501 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2502 ;; and pike-mode) are added through autoload directives in that
2503 ;; file. That way is discouraged since it spreads out the
2504 ;; definition of the initial value.
2531 "Alist mapping interpreter names to major modes.
2532 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2533 Each element looks like (REGEXP . MODE).
2535 the interpreter specified in the first line of a script, enable
2536 major mode MODE.
2543 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2544 ;; because we are duplicating info from auto-mode-alist.
2545 ;; TODO many elements of this list are also in auto-coding-alist.
2554 "List of regexps matching file names in which to ignore local variables.
2556 Files matching this list are typically binary file formats.
2557 They may happen to contain sequences that look like local variable
2558 specifications, but are not really, or they may be containers for
2559 member files with their own local variable sections, which are
2560 not appropriate for the containing file.
2567 "List of regexps matching suffixes to remove from file names.
2568 The function `inhibit-local-variables-p' uses this: when checking
2569 a file name, it first discards from the end of the name anything that
2572 ;; Can't think of any situation in which you'd want this to be nil...
2577 "Return non-nil if file local variables should be ignored.
2578 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2579 and `inhibit-local-variables-suffixes'. If
2580 `inhibit-local-variables-ignore-case' is non-nil, this ignores case."
2589 sufs)
2594 temp))
2599 "Regexp matching interpreters, for file mode determination.
2600 This regular expression is matched against the first line of a file
2601 to determine the file's mode in `set-auto-mode'. If it matches, the file
2602 is assumed to be interpreted by the interpreter matched by the second group
2603 of the regular expression. The mode is then determined as the mode
2607 "Alist of buffer beginnings vs. corresponding major mode functions.
2608 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2609 After visiting a file, if REGEXP matches the text at the beginning of the
2610 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2611 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2612 major mode.
2614 If FUNCTION is nil, then it is not called. (That is a way of saying
2622 ;; The < comes before the groups (but the first) to reduce backtracking.
2623 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2624 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2628 comment-re "*"
2631 . html-mode)
2633 ;; These two must come after html, because they are more general:
2638 . sgml-mode)
2641 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2642 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2643 After visiting a file, if REGEXP matches the text at the beginning of the
2644 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2645 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2646 have not specified a mode for this file.
2652 "Upper limit on `magic-mode-alist' regexp matches.
2656 "Select major mode appropriate for current buffer.
2658 To find the right major mode, this function checks for a -*- mode tag
2659 checks for a `mode:' entry in the Local Variables section of the file,
2660 checks if it uses an interpreter listed in `interpreter-mode-alist',
2661 matches the buffer beginning against `magic-mode-alist',
2662 compares the filename against the entries in `auto-mode-alist',
2663 then matches the buffer beginning against `magic-fallback-mode-alist'.
2665 If `enable-local-variables' is nil, or if the file name matches
2666 `inhibit-local-variables-regexps', this function does not check
2667 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2668 is nil, then the only mode: tag that can be relevant is a -*- one.
2670 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2671 set the major mode only if that would change it. In other words
2672 we don't actually set it to the same mode the buffer already has."
2673 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2675 end done mode modes)
2676 ;; Once we drop the deprecated feature where mode: is also allowed to
2677 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2678 ;; remove this section and just let (hack-local-variables t) handle it.
2679 ;; Find a -*- mode tag.
2683 ;; Note by design local-enable-local-variables does not matter here.
2685 try-locals
2688 ;; Find all specifications for the `mode:' variable
2689 ;; and execute them left to right.
2701 modes)))
2702 ;; Simple -*-MODE-*- case.
2705 modes))))
2706 ;; If we found modes to use, invoke them now, outside the save-excursion.
2714 ;; continuing would call minor modes again, toggling them off
2716 ;; hack-local-variables checks local-enable-local-variables etc, but
2717 ;; we might as well be explicit here for the sake of clarity.
2719 enable-local-variables
2720 local-enable-local-variables
2721 try-locals
2728 ;; If we didn't, look for an interpreter specified in the first line.
2729 ;; As a special case, allow for things like "#!/bin/env perl", which
2730 ;; finds the interpreter anywhere in $PATH.
2736 ;; Map interpreter name to a mode, signaling we're done at the
2737 ;; same time.
2744 interpreter-mode-alist)
2746 ;; If we found an interpreter mode to use, invoke it now.
2748 ;; Next try matching the buffer beginning against magic-mode-alist.
2762 ;; Next compare the filename against the entries in auto-mode-alist.
2767 ;; Remove backup-suffixes from file name.
2769 ;; Remove remote file name identification.
2774 ;; Find first matching alist entry.
2777 ;; System is case-insensitive.
2781 ;; System is case-sensitive.
2783 ;; First match case-sensitively.
2787 ;; Fallback to case-insensitive match.
2801 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2818 ;; When `keep-mode-if-same' is set, we are working on behalf of
2819 ;; set-visited-file-name. In that case, if the major mode specified is the
2820 ;; same one we already have, don't actually reset it. We don't want to lose
2821 ;; minor modes such as Font Lock.
2823 "Apply MODE and return it.
2824 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2825 any aliases and compared to current major mode. If they are the
2826 same, do nothing and return nil."
2832 mode)))
2835 "Regexp of lines to skip when looking for file-local settings.
2836 If the first line matches this regular expression, then the -*-...-*- file-
2840 "Find the -*- spec in the buffer.
2841 Call with point at the place to start searching from.
2842 If one is found, set point to the beginning and return the position
2843 of the end. Otherwise, return nil; may change point.
2844 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
2845 be ignored; but `enable-local-variables' and `local-enable-local-variables'
2846 have no effect."
2849 ;; Don't look for -*- if this file name matches any
2850 ;; of the regexps in inhibit-local-variables-regexps.
2853 ;; If the file begins with "#!" (exec
2854 ;; interpreter magic), look for mode frobs
2855 ;; in the first two lines. You cannot
2856 ;; necessarily put them in the first line
2857 ;; of such a file without screwing up the
2858 ;; interpreter invocation. The same holds
2859 ;; for '\" in man pages (preprocessor
2860 ;; magic for the `man' program).
2871 end))))
2872 \f
2873 ;;; Handling file local variables
2877 file-local-variables-alist dir-local-variables-alist)
2882 "Normal hook run after processing a file's local variables specs.
2883 Major modes can use this to examine user-specified local variables
2887 "List variable-value pairs that are considered safe.
2888 Each element is a cons cell (VAR . VAL), where VAR is a variable
2889 symbol and VAL is a value that is considered safe."
2890 :risky t
2895 ;; This should be here at least as long as Emacs supports write-file-hooks.
2900 "Expressions that are considered safe in an `eval:' local variable.
2901 Add expressions to this list if you want Emacs to evaluate them, when
2902 they appear in an `eval' local variable specification, without first
2903 asking you for confirmation."
2904 :risky t
2909 ;; Risky local variables:
2912 buffer-auto-save-file-name
2913 buffer-file-name
2914 buffer-file-truename
2915 buffer-undo-list
2916 debugger
2917 default-text-properties
2918 eval
2919 exec-directory
2920 exec-path
2921 file-name-handler-alist
2922 frame-title-format
2923 global-mode-string
2924 header-line-format
2925 icon-title-format
2926 inhibit-quit
2927 load-path
2928 max-lisp-eval-depth
2929 max-specpdl-size
2930 minor-mode-map-alist
2931 minor-mode-overriding-map-alist
2932 mode-line-format
2933 mode-name
2934 overriding-local-map
2935 overriding-terminal-local-map
2936 process-environment
2937 standard-input
2938 standard-output
2939 unread-command-events))
2941 ;; Safe local variables:
2942 ;;
2943 ;; For variables defined by major modes, the safety declarations can go into
2944 ;; the major mode's file, since that will be loaded before file variables are
2945 ;; processed.
2946 ;;
2947 ;; For variables defined by minor modes, put the safety declarations in the
2948 ;; file defining the minor mode after the defcustom/defvar using an autoload
2949 ;; cookie, e.g.:
2950 ;;
2951 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2952 ;;
2953 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2954 ;; minor mode file may not be loaded yet.
2955 ;;
2956 ;; For variables defined in the C source code the declaration should go here:
2978 "Alist of file-local variable settings in the current buffer.
2979 Each element in this list has the form (VAR . VALUE), where VAR
2980 is a file-local variable (a symbol) and VALUE is the value
2981 specified. The actual value in the buffer may differ from VALUE,
2987 "Alist of directory-local variable settings in the current buffer.
2988 Each element in this list has the form (VAR . VALUE), where VAR
2989 is a directory-local variable (a symbol) and VALUE is the value
2990 specified in .dir-locals.el. The actual value in the buffer
2991 may differ from VALUE, if it is changed by the major or minor modes,
2996 "Normal hook run before setting file-local variables.
2997 It is called after checking for unsafe/risky variables and
2998 setting `file-local-variables-alist', and before applying the
2999 variables stored in `file-local-variables-alist'. A hook
3000 function is allowed to change the contents of this alist.
3002 This hook is called only if there is at least one file-local
3006 "Get confirmation before setting up local variable values.
3007 ALL-VARS is the list of all variables to be set up.
3008 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
3009 RISKY-VARS is the list of those that are marked as risky.
3010 If these settings come from directory-local variables, then
3011 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3018 unsafe-vars))
3020 ;; Set up the contents of the *Local Variables* buffer.
3028 ", and variables that are risky (**)."
3036 y -- to apply the local variables list.
3040 ! -- to apply the local variables list, and permanently mark these
3052 ;; Make strings with embedded whitespace easier to read.
3060 ;; Display the buffer and read a choice.
3068 ""
3071 char)
3090 "Return local variables specified in the -*- line.
3091 Returns an alist of elements (VAR . VAL), where VAR is a variable
3092 and VAL is the specified value. Ignores any specification for
3093 `mode:' and `coding:' (which should have already been handled
3094 by `set-auto-mode' and `set-auto-coding', respectively).
3095 Return nil if the -*- line is malformed.
3097 If MODE-ONLY is non-nil, just returns the symbol specifying the
3098 mode, if there is one, otherwise nil."
3103 result)
3105 nil)
3107 ;; Simple form: "-*- MODENAME -*-".
3111 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3112 ;; (last ";" is optional).
3113 ;; If MODE-ONLY, just check for `mode'.
3114 ;; Otherwise, parse the -*- line into the RESULT alist.
3122 ;; There used to be a downcase here,
3123 ;; but the manual didn't say so,
3124 ;; and people want to set var names that aren't all lc.
3130 ;; It is traditional to ignore
3131 ;; case when checking for `mode' in set-auto-mode,
3132 ;; so we must do that here as well.
3133 ;; That is inconsistent, but we're stuck with it.
3134 ;; The same can be said for `coding' in set-auto-coding.
3144 ;; Downcase "Mode:".
3150 result))))))
3153 "Filter local variable settings, querying the user if necessary.
3154 VARIABLES is the alist of variable-value settings. This alist is
3155 filtered based on the values of `ignored-local-variables',
3156 `enable-local-eval', `enable-local-variables', and (if necessary)
3157 user interaction. The results are added to
3158 `file-local-variables-alist', without applying them.
3159 If these settings come from directory-local variables, then
3160 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3161 ;; Find those variables that we may want to save to
3162 ;; `safe-local-variable-values'.
3168 ;; Ignore any variable in `ignored-local-variables'.
3169 nil)
3170 ;; Obey `enable-local-eval'.
3174 ;; In case previously marked safe (bug#5636).
3176 ;; If not safe and e-l-v = :safe, ignore totally.
3180 safe
3182 ;; Ignore duplicates (except `mode') in the present list.
3184 ;; Accept known-safe variables.
3188 ;; The variable is either risky or unsafe:
3195 ;; Query, unless all vars are safe or user wants no querying.
3201 risky-vars dir-name))
3211 ;; TODO? Warn once per file rather than once per session?
3215 "Parse and put into effect this buffer's local variables spec.
3216 Uses `hack-local-variables-apply' to apply the variables.
3219 is specified, and return the corresponding mode symbol, or nil.
3220 In this case, we try to ignore minor-modes, and only return a
3221 major-mode.
3223 If `enable-local-variables' or `local-enable-local-variables' is nil,
3224 this function does nothing. If `inhibit-local-variables-regexps'
3225 applies to the file in question, the file is not scanned for
3226 local variables, but directory-local variables may still be applied."
3227 ;; We don't let inhibit-local-variables-p influence the value of
3228 ;; enable-local-variables, because then it would affect dir-local
3229 ;; variables. We don't want to search eg tar files for file local
3230 ;; variable sections, but there is no reason dir-locals cannot apply
3231 ;; to them. The real meaning of inhibit-local-variables-p is "do
3232 ;; not scan this file for local variables".
3235 result)
3239 ;; Note this is a no-op if enable-local-variables is nil.
3241 ;; This entire function is basically a no-op if enable-local-variables
3242 ;; is nil. All it does is set file-local-variables-alist to nil.
3244 ;; This part used to ignore enable-local-variables when mode-only
3245 ;; was non-nil. That was inappropriate, eg consider the
3246 ;; (artificial) example of:
3247 ;; (setq local-enable-local-variables nil)
3248 ;; Open a file foo.txt that contains "mode: sh".
3249 ;; It correctly opens in text-mode.
3250 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3252 ;; If MODE-ONLY is non-nil, and the prop line specifies a
3253 ;; mode, then we're done, and have no need to scan further.
3255 mode-only))
3256 ;; Look for "Local variables:" line in last page.
3264 ;; suffix is what comes after "local variables:" in its line.
3265 ;; prefix is what comes before "local variables:" in its line.
3278 endpos
3284 nil t))
3285 ;; This used to be an error, but really all it means is
3286 ;; that this may simply not be a local-variables section,
3287 ;; so just ignore it.
3297 ;; Discard the prefix.
3302 ;; Discard the suffix.
3311 ;; Find the variable name;
3319 val val2)
3322 ;; Read the variable value.
3329 ;; Specifying minor-modes via mode: is
3330 ;; deprecated, but try to reject them anyway.
3344 'eval
3348 ;; Now we've read all the local variables.
3349 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3351 ;; Otherwise, set the variables.
3356 "Apply the elements of `file-local-variables-alist'.
3357 If there are any elements, runs `before-hack-local-variables-hook',
3358 then calls `hack-one-local-variable' to apply the alist elements one by one.
3359 Finishes by running `hack-local-variables-hook', regardless of whether
3360 the alist is empty or not.
3362 Note that this function ignores a `mode' entry if it specifies the same
3363 major mode as the buffer already has."
3365 ;; Any 'evals must run in the Right sequence.
3374 "Non-nil if SYM is safe as a file-local variable with value VAL.
3375 It is safe if any of these conditions are met:
3377 * There is a matching entry (SYM . VAL) in the
3378 `safe-local-variable-values' user option.
3380 * The `safe-local-variable' property of SYM is a function that
3381 evaluates to a non-nil value with VAL as an argument."
3385 ;; If the function signals an error, that means it
3386 ;; can't assure us that the value is safe.
3390 "Non-nil if SYM could be dangerous as a file-local variable.
3391 It is dangerous if either of these conditions are met:
3393 * Its `risky-local-variable' property is non-nil.
3399 ;; If this is an alias, check the base name.
3419 "Return t if it is safe to eval EXP when it is found in a file."
3421 ;; Detect certain `put' expressions.
3428 lisp-indent-function
3429 scheme-indent-function))
3430 ;; Only allow safe values (not functions).
3435 ;; Only allow indirect form specs.
3436 ;; During bootstrapping, edebug-basic-spec might not be
3437 ;; defined yet.
3441 ;; Allow expressions that the user requested.
3443 ;; Certain functions can be allowed with safe arguments
3444 ;; or can specify verification functions to try.
3446 ;; Allow (minor)-modes calls with no arguments.
3447 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3456 ok))
3464 ok))))))))
3477 "Set local variable VAR with value VAL.
3478 If VAR is `mode', call `VAL-mode' as a function unless it's
3479 already the major mode."
3481 (`mode
3487 (`eval
3493 ;; Make sure the string has no text properties.
3494 ;; Some text properties can get evaluated in various ways,
3495 ;; so it is risky to put them on with a local variable list.
3499 \f
3500 ;;; Handling directory-local variables, aka project settings.
3506 "List of cached directory roots for directory-local variable classes.
3507 Each element in this list has the form (DIR CLASS MTIME).
3508 DIR is the name of the directory.
3509 CLASS is the name of a variable class (a symbol).
3510 MTIME is the recorded modification time of the directory-local
3511 variables file associated with this entry. This time is a list
3512 of integers (the same format as `file-attributes'), and is
3513 used to test whether the cache entry is still valid.
3514 Alternatively, MTIME can be nil, which means the entry is always
3518 "Return the variable list for CLASS."
3522 "Collect directory-local variables from MODE-VARIABLES.
3523 VARIABLES is the initial list of variables.
3524 Returns the new list."
3529 ;; If variables are specified more than once, only use the last. (Why?)
3530 ;; The pseudo-variables mode and eval are different (bug#3430).
3533 ;; Need a new cons in case we setcdr later.
3537 "Collect entries from CLASS-VARIABLES into VARIABLES.
3538 ROOT is the root directory of the project.
3539 Return the new variables list."
3542 ;; FIXME: Why not use file-relative-name?
3549 ;; Don't include this in the previous condition, because we
3550 ;; want to filter all strings before the next condition.
3564 ;; TODO someone might want to extend this to allow
3565 ;; integer values for subdir, where N means
3566 ;; variables apply to this directory and N levels
3567 ;; below it (0 == nil).
3570 alist variables))))))))
3572 ;; The file's content might be invalid (e.g. have a merge conflict), but
3573 ;; that shouldn't prevent the user from opening the file.
3575 nil))))
3578 "Declare that the DIRECTORY root is an instance of CLASS.
3579 DIRECTORY is the name of a directory, a string.
3580 CLASS is the name of a project class, a symbol.
3581 MTIME is either the modification time of the directory-local
3582 variables file that defined this class, or nil.
3584 When a file beneath DIRECTORY is visited, the mode-specific
3585 variables from CLASS are applied to the buffer. The variables
3586 for a class are defined using `dir-locals-set-class-variables'."
3593 "Map the type CLASS to a list of variable settings.
3594 CLASS is the project class, a symbol. VARIABLES is a list
3595 that declares directory-local variables for the class.
3596 An element in VARIABLES is either of the form:
3597 (MAJOR-MODE . ALIST)
3598 or
3599 (DIRECTORY . LIST)
3601 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3602 whose elements are of the form (VARIABLE . VALUE).
3604 In the second form, DIRECTORY is a directory name (a string), and
3605 LIST is a list of the form accepted by the function.
3607 When a file is visited, the file's class is found. A directory
3608 may be assigned a class using `dir-locals-set-directory-class'.
3609 Then variables are set in the file's buffer according to the
3610 VARIABLES list of the class. The list is processed in order.
3612 * If the element is of the form (MAJOR-MODE . ALIST), and the
3613 buffer's major mode is derived from MAJOR-MODE (as determined
3614 by `derived-mode-p'), then all the variables in ALIST are
3615 applied. A MAJOR-MODE of nil may be used to match any buffer.
3616 `make-local-variable' is called for each variable before it is
3617 set.
3619 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3620 is an initial substring of the file's directory, then LIST is
3621 applied by recursively following these rules."
3628 "File that contains directory-local variables.
3629 It has to be constant to enforce uniform values
3633 "Find the directory-local variables for FILE.
3634 This searches upward in the directory tree from FILE.
3635 It stops at the first directory that has been registered in
3636 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3637 If it finds an entry in the cache, it checks that it is valid.
3638 A cache entry with no modification time element (normally, one that
3639 has been assigned directly using `dir-locals-set-directory-class', not
3640 set from a file) is always valid.
3641 A cache entry based on a `dir-locals-file' is valid if the modification
3642 time stored in the cache matches the current file modification time.
3643 If not, the cache entry is cleared so that the file will be re-read.
3645 This function returns either nil (no directory local variables found),
3646 or the matching entry from `dir-locals-directory-cache' (a list),
3647 or the full path to the `dir-locals-file' (a string) in the case
3648 of no valid cache entry."
3653 dir-locals-file))
3656 ;; `locate-dominating-file' may have abbreviated the name.
3659 ;; Let dir-locals-read-from-file inform us via demoted-errors
3660 ;; about unreadable files, etc.
3661 ;; Maybe we'd want to keep searching though - that is
3662 ;; a locate-dominating-file issue.
3663 ;;; (or (not (file-readable-p locals-file))
3664 ;;; (not (file-regular-p locals-file)))
3665 ;;; (setq locals-file nil))
3666 ;; Find the best cached value in `dir-locals-directory-cache'.
3678 ;; Found a potential cache entry. Check validity.
3679 ;; A cache entry with no MTIME is assumed to always be valid
3680 ;; (ie, set directly, not from a dir-locals file).
3681 ;; Note, we don't bother to check that there is a matching class
3682 ;; element in dir-locals-class-alist, since that's done by
3683 ;; dir-locals-set-directory-class.
3690 ;; This cache entry is OK.
3691 dir-elt
3692 ;; This cache entry is invalid; clear it.
3695 ;; Return the first existing dir-locals file. Might be the same
3696 ;; as dir-elt's, might not (eg latter might have been deleted).
3697 locals-file)
3698 ;; No cache entry.
3699 locals-file)))
3702 "Load a variables FILE and register a new class and instance.
3703 FILE is the name of the file holding the variables to apply.
3704 The new class name is the same as the directory in which FILE
3705 is found. Returns the new class name."
3717 class-name)))))
3720 "Non-nil means dir-local variables will be applied to remote files."
3728 "Read per-directory local variables for the current buffer.
3729 Store the directory-local variables in `dir-local-variables-alist'
3730 and `file-local-variables-alist', without applying them.
3732 This does nothing if either `enable-local-variables' or
3733 `enable-dir-local-variables' are nil."
3735 enable-dir-local-variables
3738 default-directory)))))
3739 ;; Find the variables file.
3769 "Apply directory-local variables to a non-file buffer.
3770 For non-file buffers, such as Dired buffers, directory-local
3771 variables are looked for in `default-directory' and its parent
3772 directories."
3776 \f
3779 However, the mode will not be changed if
3780 \(1) a local variables list or the `-*-' line specifies a major mode, or
3782 \ not suitable for ordinary files, or
3783 \(3) the new file name does not particularly specify any mode."
3788 "Change name of file visited in current buffer to FILENAME.
3789 This also renames the buffer to correspond to the new file.
3790 The next time the buffer is saved it will go in the newly specified file.
3791 FILENAME nil or an empty string means mark buffer as not visiting any file.
3792 Remember to delete the initial contents of the minibuffer
3793 if you wish to pass an empty string as the argument.
3795 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3796 confirmation in the case where another buffer is already visiting FILENAME.
3798 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3799 the old visited file has been renamed to the new name FILENAME."
3807 nil
3822 filename)))
3829 buffer-file-name filename)
3833 ;; If new-name == old-name, renaming would add a spurious <2>
3834 ;; and it's considered as a feature in rename-buffer.
3840 ;; Abbreviate the file names of the buffer.
3849 nil))
3850 ;; write-file-functions is normally used for things like ftp-find-file
3851 ;; that visit things that are not local files as if they were files.
3852 ;; Changing to visit an ordinary local file instead should flush the hook.
3857 ;; If buffer was read-only because of version control,
3858 ;; that reason is gone now, so make it writable.
3862 ;; Turn off backup files for certain file names.
3863 ;; Since this is a permanent local, the major mode won't eliminate it.
3865 backup-enable-predicate
3871 ;; If auto-save was not already on, turn it on if appropriate.
3875 ;; If auto save is on, start using a new name.
3876 ;; We deliberately don't rename or delete the old auto save
3877 ;; for the old visited file name. This is because perhaps
3878 ;; the user wants to save the new state and then compare with the
3879 ;; previous state from the auto save file.
3882 ;; Rename the old auto save file if any.
3889 ;; Update the major mode, if the file name determines it.
3891 ;; Don't change the mode if it is special.
3894 ;; Don't change the mode if the local variable list specifies it.
3895 ;; The file name can influence whether the local variables apply.
3897 ;; h-l-v also checks it, but might as well be explicit.
3900 ;; TODO consider making normal-mode handle this case.
3908 "Write current buffer into file FILENAME.
3909 This makes the buffer visit that file, and marks it as not modified.
3911 If you specify just a directory name as FILENAME, that means to use
3912 the default file name but in that directory. You can also yank
3913 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3915 If the buffer is not already visiting a file, the default file name
3916 for the output file is the buffer name.
3918 If optional second arg CONFIRM is non-nil, this function
3919 asks for confirmation before overwriting an existing file.
3920 Interactively, confirmation is required unless you supply a prefix argument."
3921 ;; (interactive "FWrite file: ")
3925 nil nil nil nil)
3929 default-directory)
3930 nil nil))
3934 ;; If arg is just a directory,
3935 ;; use the default file name, but in that directory.
3942 ;; NS does its own confirm dialog.
3945 use-dialog-box))
3950 ;; Make buffer writable if file is writable.
3955 ;; It's likely that the VC status at the new location is different from
3956 ;; the one at the old location.
3958 \f
3960 "Return an alist of extended attributes of file FILENAME.
3962 Extended attributes are platform-specific metadata about the file,
3963 such as SELinux context, list of ACL entries, etc."
3968 "Set extended attributes of file FILENAME to ATTRIBUTES.
3970 ATTRIBUTES must be an alist of file attributes as returned by
3971 `file-extended-attributes'."
3979 \f
3981 "Make a backup of the disk file visited by the current buffer, if appropriate.
3982 This is normally done before saving the buffer the first time.
3984 A backup may be done by renaming or by copying; see documentation of
3985 variable `make-backup-files'. If it's done by renaming, then the file is
3986 no longer accessible under its old name.
3988 The value is non-nil after a backup was made by renaming.
3989 It has the form (MODES EXTENDED-ATTRIBUTES BACKUPNAME).
3990 MODES is the result of `file-modes' on the original
3991 file; this means that the caller, after saving the buffer, should change
3992 the modes of the new file to agree with the old modes.
3993 EXTENDED-ATTRIBUTES is the result of `file-extended-attributes'
3994 on the original file; this means that the caller, after saving
3995 the buffer, should change the extended attributes of the new file
3996 to agree with the old attributes.
3997 BACKUPNAME is the backup file name, which is the old file renamed."
4004 backup-info backupname targets setmodes)
4005 ;; If specified name is a symbolic link, chase it to the target.
4006 ;; Thus we make the backups in the directory where the real file is.
4011 ;; (if (file-directory-p buffer-file-name)
4012 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
4016 ;; If have old versions to maybe delete,
4017 ;; ask the user to confirm now, before doing anything.
4018 ;; But don't actually delete til later.
4023 real-file-name)))))
4027 ;; Actually write the back up file.
4030 ; (file-symlink-p buffer-file-name)
4031 backup-by-copying
4032 ;; Don't rename a suid or sgid file.
4045 real-file-name t))))))
4047 backupname modes
4048 extended-attributes)
4049 ;; rename-file should delete old backup.
4052 backupname)))
4054 ;; If trouble writing the backup, write it in
4055 ;; .emacs.d/%backup%.
4058 backupname)
4061 modes extended-attributes)))
4063 ;; Now delete the old versions, if desired.
4070 setmodes)
4077 ;; Create temp files with strict access rights. It's easy to
4078 ;; loosen them later, whereas it's impossible to close the
4079 ;; time-window of loose permissions otherwise.
4082 ;; Try to overwrite old backup first.
4090 nil)
4092 ;; The file was somehow created by someone else between
4093 ;; `delete-file' and `copy-file', so let's try again.
4094 ;; rms says "I think there is also a possible race
4095 ;; condition for making backup files" (emacs-devel 20070821).
4096 nil)))
4097 ;; Reset the umask.
4099 ;; If set-file-extended-attributes fails, fall back on set-file-modes.
4108 ;; The last ~[[:digit]]+ matches relative versions in git,
4109 ;; e.g. `foo.js.~HEAD~1~'.
4110 "Regular expression matching the backup/version part of a file name.
4114 "Return file NAME sans backup versions or strings.
4115 This is a separate procedure so your site-init or startup file can
4116 redefine it.
4117 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4118 we do not remove backup version numbers, only true file version numbers.
4119 See also `file-name-version-regexp'."
4126 name))))))
4129 "Return t if deleting FILE and rewriting it would preserve the owner.
4130 Return nil if FILE does not exist, or if deleting and recreating it
4131 might not preserve the owner. If GROUP is non-nil, check whether
4132 the group would be preserved too."
4137 ;; Return t if the file doesn't exist, since it's true that no
4138 ;; information would be lost by an (attempted) delete and create.
4141 ;; Files created on Windows by Administrator (RID=500)
4142 ;; have the Administrators group (RID=544) recorded as
4143 ;; their owner. Rewriting them will still preserve the
4144 ;; owner.
4148 ;; On BSD-derived systems files always inherit the parent
4149 ;; directory's group, so skip the group-gid test.
4155 ;; On some systems, a file created in a setuid directory
4156 ;; inherits that directory's owner.
4160 ;; On many systems, a file created in a setgid directory
4161 ;; inherits that directory's group. On some systems
4162 ;; this happens even if the setgid bit is not set.
4169 The extension, in a file name, is the part that follows the last `.',
4170 except that a leading `.', if any, doesn't count."
4173 directory)
4177 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4178 ;; we don't want to expand it.
4181 filename))))
4185 The extension, in a file name, is the part that follows the last `.',
4186 excluding version numbers and backup suffixes,
4187 except that a leading `.', if any, doesn't count.
4188 Return nil for extensionless file names such as `foo'.
4189 Return the empty string for file names such as `foo.'.
4191 If PERIOD is non-nil, then the returned value includes the period
4192 that delimits the extension, and if FILENAME has no extension,
4203 "Return the base name of the FILENAME: no directory, no extension.
4204 FILENAME defaults to `buffer-file-name'."
4209 #'make-backup-file-name--default-function
4210 "A function to use instead of the default `make-backup-file-name'.
4212 This could be buffer-local to do something special for specific
4213 files. If you define it, you may need to change `backup-file-name-p'
4214 and `file-name-sans-versions' too.
4216 See also `backup-directory-alist'."
4221 "Alist of filename patterns and backup directory names.
4222 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4223 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4224 relative or absolute. If it is absolute, so that all matching files
4225 are backed up into the same directory, the file names in this
4226 directory will be the full name of the file backed up with all
4227 directory separators changed to `!' to prevent clashes. This will not
4228 work correctly if your filesystem truncates the resulting name.
4230 For the common case of all backups going into one directory, the alist
4232 directory name.
4234 If this variable is nil, or it fails to match a filename, the backup
4235 is made in the original file's directory.
4237 On MS-DOS filesystems without long names this variable is always
4238 ignored."
4244 "Default `backup-enable-predicate' function.
4245 Checks for files in `temporary-file-directory',
4246 `small-temporary-file-directory', and /tmp."
4248 caseless)
4249 ;; On MS-Windows, file-truename will convert short 8+3 aliases to
4250 ;; their long file-name equivalents, so compare-strings does TRT.
4254 caseless t))
4257 ;; Directory is under temporary-file-directory.
4262 ;; Directory is under /tmp.
4267 0 nil
4269 ;; Directory is under small-temporary-file-directory.
4274 "Create the non-numeric backup file name for FILE.
4275 Normally this will just be the file's name with `~' appended.
4276 Customization hooks are provided as follows.
4278 The value of `make-backup-file-name-function' should be a function which
4279 will be called with FILE as its argument; the resulting name is used.
4281 By default, a match for FILE is sought in `backup-directory-alist'; see
4282 the documentation of that variable. If the directory for the backup
4283 doesn't exist, it is created."
4286 file))
4300 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
4302 elt backup-directory abs-backup-directory)
4307 alist nil)))
4308 ;; If backup-directory is relative, it should be relative to the
4309 ;; file's directory. By expanding explicitly here, we avoid
4310 ;; depending on default-directory.
4319 abs-backup-directory nil))))
4321 file
4325 ;; Normalize DOSish file names: downcase the drive
4326 ;; letter, if any, and replace the leading "x:" with
4327 ;; "/drive_x".
4330 ;; Replace any invalid file-name characters (for the
4331 ;; case of backing up remote files).
4335 "drive_"
4338 ""
4341 ;; Make the name unique by substituting directory
4342 ;; separators. It may not really be worth bothering about
4343 ;; doubling `!'s in the original name...
4348 backup-directory))
4353 "Return non-nil if FILE is a backup file name (numeric or not).
4354 This is a separate function so you can redefine it for customization.
4355 You may need to redefine `file-name-sans-versions' as well."
4360 ;; This is used in various files.
4361 ;; The usage of backup-extract-version-start is not very clean,
4362 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4364 "Given the name of a numeric backup file, FN, return the backup number.
4365 Uses the free variable `backup-extract-version-start', whose value should be
4366 the index in the name where the version number begins."
4373 "Find a file name for a backup file FN, and suggestions for deletions.
4374 Value is a list whose car is the name for the backup file
4375 and whose cdr is a list of old versions to consider deleting now.
4376 If the value is nil, don't make a backup.
4377 Uses `backup-directory-alist' in the same way as does
4378 `make-backup-file-name'."
4380 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4384 ;; We don't support numbered backups on plain MS-DOS
4385 ;; when long file names are unavailable.
4395 possibilities deserve-versions-p versions)
4398 base-versions
4401 possibilities)
4402 #'<)
4407 kept-old-versions
4408 kept-new-versions
4415 ;; Delete nothing if there is overflow
4416 ;; in the number of versions to keep.
4422 v))))))))))
4425 "Return number of names file FILENAME has."
4428 ;; (defun file-relative-name (filename &optional directory)
4429 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4430 ;; This function returns a relative file name which is equivalent to FILENAME
4431 ;; when used with that default directory as the default.
4432 ;; If this is impossible (which can happen on MSDOS and Windows
4433 ;; when the file name and directory use different drive names)
4434 ;; then it returns FILENAME."
4435 ;; (save-match-data
4436 ;; (let ((fname (expand-file-name filename)))
4437 ;; (setq directory (file-name-as-directory
4438 ;; (expand-file-name (or directory default-directory))))
4439 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4440 ;; ;; drive names, they can't be relative, so return the absolute name.
4441 ;; (if (and (or (eq system-type 'ms-dos)
4442 ;; (eq system-type 'cygwin)
4443 ;; (eq system-type 'windows-nt))
4444 ;; (not (string-equal (substring fname 0 2)
4445 ;; (substring directory 0 2))))
4446 ;; filename
4447 ;; (let ((ancestor ".")
4448 ;; (fname-dir (file-name-as-directory fname)))
4449 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4450 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4451 ;; (setq directory (file-name-directory (substring directory 0 -1))
4452 ;; ancestor (if (equal ancestor ".")
4453 ;; ".."
4454 ;; (concat "../" ancestor))))
4455 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4456 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4457 ;; ;; We matched within FNAME's directory part.
4458 ;; ;; Add the rest of FNAME onto ANCESTOR.
4459 ;; (let ((rest (substring fname (match-end 0))))
4460 ;; (if (and (equal ancestor ".")
4461 ;; (not (equal rest "")))
4462 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4463 ;; rest
4464 ;; (concat (file-name-as-directory ancestor) rest)))
4465 ;; ;; We matched FNAME's directory equivalent.
4466 ;; ancestor))))))
4469 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4470 This function returns a relative file name which is equivalent to FILENAME
4471 when used with that default directory as the default.
4472 If FILENAME is a relative file name, it will be interpreted as existing in
4473 `default-directory'.
4474 If FILENAME and DIRECTORY lie on different machines or on different drives
4475 on a DOS/Windows machine, it returns FILENAME in expanded form."
4479 default-directory))))
4484 read-file-name-completion-ignore-case)))
4487 ;; Test for different filesystems on DOS/Windows
4489 ;; Should `cygwin' really be included here? --stef
4492 ;; Test for different drive letters
4494 ;; Test for UNCs on different servers
4499 ;; Windows file names cannot have ? in
4500 ;; them, so use that to detect when
4501 ;; neither FILENAME nor DIRECTORY is a
4502 ;; UNC.
4504 0 nil
4510 ;; Test for different remote file system identification
4512 filename
4518 directory nil nil fold-case))
4520 directory nil nil fold-case))))
4523 ".."
4525 ;; Now ancestor is empty, or .., or ../.., etc.
4527 directory nil nil fold-case))
4528 ;; We matched within FILENAME's directory part.
4529 ;; Add the rest of FILENAME onto ANCESTOR.
4532 ;; But don't bother with ANCESTOR if it would give us `./'.
4533 rest
4535 ;; We matched FILENAME's directory equivalent.
4536 ancestor))))))
4537 \f
4539 "Save current buffer in visited file if modified.
4540 Variations are described below.
4542 By default, makes the previous version into a backup file
4543 if previously requested or if this is the first save.
4545 to become a backup when the next save is done.
4547 unconditionally makes the previous version into a backup file.
4549 to become a backup when the next save is done,
4550 and unconditionally makes the previous version into a backup file.
4552 With a numeric argument of 0, never make the previous version
4553 into a backup file.
4555 If a file's name is FOO, the names of its numbered backup versions are
4556 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4557 Numeric backups (rather than FOO~) will be made if value of
4558 `version-control' is not the atom `never' and either there are already
4559 numeric versions of the file being backed up, or `version-control' is
4560 non-nil.
4561 We don't want excessive versions piling up, so there are variables
4562 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4563 and `kept-new-versions', which tells how many newest versions to keep.
4564 Defaults are 2 old versions and 2 new.
4565 `dired-kept-versions' controls dired's clean-directory (.) command.
4566 If `delete-old-versions' is nil, system will query user
4567 before trimming versions. Otherwise it does it silently.
4569 If `vc-make-backup-files' is nil, which is the default,
4570 no backup files are made for files managed by version control.
4571 (This is because the version control system itself records previous versions.)
4573 See the subroutine `basic-save-buffer' for more information."
4579 ;; We used to display the message below only for files > 50KB, but
4580 ;; then Rmail-mbox never displays it due to buffer swapping. If
4581 ;; the test is ever re-introduced, be sure to handle saving of
4582 ;; Rmail files.
4589 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4590 Normally delete only if the file was written by this Emacs since
4591 the last real save, but optional arg FORCE non-nil means delete anyway."
4605 "Normal hook that is run before a buffer is saved to its file."
4611 "Normal hook that is run after a buffer is saved to its file."
4617 "If non-nil, use this coding system for saving the buffer.
4618 More precisely, use this coding system in place of the
4619 value of `buffer-file-coding-system', when saving the buffer.
4620 Calling `write-region' for any purpose other than saving the buffer
4621 will still use `buffer-file-coding-system'; this variable has no effect
4628 "Save the current buffer in its visited file, if it has been modified.
4629 The hooks `write-contents-functions' and `write-file-functions' get a chance
4630 to do the job of saving; if they do not, then the buffer is saved in
4631 the visited file in the usual way.
4632 Before and after saving the buffer, this function runs
4633 `before-save-hook' and `after-save-hook', respectively."
4636 ;; In an indirect buffer, save its base buffer instead.
4640 ;; handle the case when no modification has been made but
4641 ;; the file disappeared since visited
4645 setmodes)
4646 ;; If buffer has no file name, ask user for one.
4654 ;; Signal an error if the user specified the name of an
4655 ;; existing directory.
4658 filename))
4665 "%s has changed since visited or saved. Save anyway? "
4685 ;; Support VC version backups.
4687 ;; Don't let errors prevent saving the buffer.
4692 ;; If a hook returned t, file is already "written".
4693 ;; Otherwise, write it the usual way now.
4702 ;; Now we have saved the current buffer. Let's make sure
4703 ;; that buffer-file-coding-system is fixed to what
4704 ;; actually used for saving by binding it locally.
4719 ;; If the auto-save file was recent before this command,
4720 ;; delete it now.
4722 ;; Support VC `implicit' locking.
4727 ;; This does the "real job" of writing a buffer into its visited file
4728 ;; and making a backup file. This is what is normally done
4729 ;; but inhibited if one of write-file-functions returns non-nil.
4730 ;; It returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4731 ;; backup-buffer.
4741 ;; This returns a value (MODES EXTENDED-ATTRIBUTES BACKUPNAME), like
4742 ;; backup-buffer.
4755 "File %s is write-protected; try to save anyway? "
4757 buffer-file-name)))
4760 ;; This may involve prompting, so do it now before backing up the file.
4761 ;; Otherwise there can be a delay while the user answers the
4762 ;; prompt during which the original file has been renamed. (Bug#13522)
4764 ;; Args here should match write-region call below around
4765 ;; which we use writecoding.
4767 buffer-file-truename))
4780 ;; Write temp name, then rename it.
4781 ;; This requires write access to the containing dir,
4782 ;; which is why we don't try it if we don't have that access.
4784 tempname succeed
4787 ;; Create temp files with strict access rights. It's easy to
4788 ;; loosen them later, whereas it's impossible to close the
4789 ;; time-window of loose permissions otherwise.
4794 ;; Try various temporary names.
4795 ;; This code follows the example of make-temp-file,
4796 ;; but it calls write-region in the appropriate way
4797 ;; for saving the buffer.
4803 ;; Pass in nil&nil rather than point-min&max
4804 ;; cause we're saving the whole buffer.
4805 ;; write-region-annotate-functions may use it.
4807 tempname nil realname
4809 nil)
4811 ;; The file was somehow created by someone else between
4812 ;; `make-temp-name' and `write-region', let's try again.
4813 nil)
4815 ;; Reset the umask.
4817 ;; If we failed, restore the buffer's modtime.
4820 ;; Since we have created an entirely new file,
4821 ;; make sure it gets the right permission bits set.
4826 buffer-file-name)))
4827 ;; We succeeded in writing the temp file,
4828 ;; so rename it.
4830 ;; If file not writable, see if we can make it writable
4831 ;; temporarily while we write it.
4832 ;; But no need to do so if we have just backed it up
4833 ;; (setmodes is set) because that says we're superseding.
4835 ;; Change the mode back, after writing.
4838 buffer-file-name))
4839 ;; If set-file-extended-attributes fails, fall back on
4840 ;; set-file-modes.
4849 ;; Pass in nil&nil rather than point-min&max to indicate
4850 ;; we're saving the buffer rather than just a region.
4851 ;; write-region-annotate-functions may make us of it.
4855 buffer-file-name nil t buffer-file-truename)
4857 ;; If we get an error writing the new file, and we made
4858 ;; the backup by renaming, undo the backing-up.
4863 setmodes))
4869 `((?\C-r
4876 ;; Return nil to ask about BUF again.
4877 nil)
4890 ;; Return nil to ask about BUF again.
4891 nil)
4901 "Save some modified file-visiting buffers. Asks user about each one.
4902 You can answer `y' to save, `n' not to save, `C-r' to look at the
4903 buffer in question with `view-buffer' before deciding or `d' to
4904 view the differences using `diff-buffer-with-file'.
4906 This command first saves any buffers where `buffer-save-without-query' is
4907 non-nil, without asking.
4909 Optional argument (the prefix) non-nil means save all with no questions.
4910 Optional second argument PRED determines which buffers are considered:
4911 If PRED is nil, all the file-visiting buffers are considered.
4912 If PRED is t, then certain non-file buffers will also be considered.
4913 If PRED is a zero-argument function, it indicates for each buffer whether
4914 to consider it or not when called with that buffer current.
4916 See `save-some-buffers-action-alist' if you want to
4917 change the additional actions you can take on files."
4921 files-done abbrevs-done)
4923 ;; First save any buffers that we're supposed to save unconditionally.
4924 ;; That way the following code won't ask about them.
4929 ;; Ask about those buffers that merit it,
4930 ;; and record the number thus saved.
4934 ;; Note that killing some buffers may kill others via
4935 ;; hooks (e.g. Rmail and its viewing buffer).
4948 t
4960 save-some-buffers-action-alist))
4961 ;; Maybe to save abbrevs, and record whether
4962 ;; we either saved them or asked to.
4969 ;; Don't keep bothering user if he says no.
4982 \f
4984 "Clear out records of last mod time of visited file.
4985 Next attempt to save will certainly not complain of a discrepancy."
4989 "Mark current buffer as unmodified, not needing to be saved.
4992 It is not a good idea to use this function in Lisp programs, because it
4993 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
5007 "Insert contents of file FILENAME into buffer after point.
5008 Set mark after the inserted text.
5010 This function is meant for the user to run interactively.
5011 Don't call it from programs! Use `insert-file-contents' instead.
5012 \(Its calling sequence is different; see its documentation)."
5018 "Append the contents of the region to the end of file FILENAME.
5019 When called from a function, expects three arguments,
5020 START, END and FILENAME. START and END are normally buffer positions
5021 specifying the part of the buffer to write.
5022 If START is nil, that means to use the entire buffer contents.
5023 If START is a string, then output that string to the file
5024 instead of any buffer contents; END is ignored.
5026 This does character code conversion and applies annotations
5027 like `write-region' does."
5032 "Return most recent backup file for FILENAME or nil if no backups exist."
5033 ;; `make-backup-file-name' will get us the right directory for
5034 ;; ordinary or numeric backups. It might create a directory for
5035 ;; backups as a side-effect, according to `backup-directory-alist'.
5042 tem)
5051 newest))
5054 "Rename current buffer to a similar name not already taken.
5055 This function is useful for creating multiple shell process buffers
5056 or multiple mail buffers, etc.
5058 Note that some commands, in particular those based on `compilation-mode'
5059 \(`compile', `grep', etc.) will reuse the current buffer if it has the
5060 appropriate mode even if it has been renamed. So as well as renaming
5061 the buffer, you also need to switch buffers before running another
5062 instance of such commands."
5070 ;; If the existing buffer name has a <NNN>,
5071 ;; which isn't part of the file name (if any),
5072 ;; then get rid of that.
5078 "Create the directory DIR and optionally any nonexistent parent dirs.
5079 If DIR already exists as a directory, signal an error, unless
5080 PARENTS is non-nil.
5082 Interactively, the default choice of directory to create is the
5083 current buffer's default directory. That is useful when you have
5084 visited a file in a nonexistent directory.
5086 Noninteractively, the second (optional) argument PARENTS, if
5087 non-nil, says whether to create parent directories that don't
5088 exist. Interactively, this happens by default.
5090 If creating the directory or directories fail, an error will be
5091 raised."
5094 nil nil)
5095 t))
5096 ;; If default-directory is a remote directory,
5097 ;; make sure we find its make-directory handler.
5105 create-list)
5107 ;; If directory is its own parent, then we can't
5108 ;; keep looping forever
5123 "Delete the directory named DIRECTORY. Does not follow symlinks.
5124 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
5125 TRASH non-nil means to trash the directory instead, provided
5126 `delete-by-moving-to-trash' is non-nil.
5128 When called interactively, TRASH is t if no prefix argument is
5129 given. With a prefix argument, TRASH is nil."
5136 "Move directory to trash: "
5138 default-directory default-directory nil nil))))
5144 nil)
5146 ;; If default-directory is a remote directory, make sure we find its
5147 ;; delete-directory handler.
5154 ;; Only move non-empty dir to trash if recursive deletion was
5155 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5156 ;; case, where the operation fails in delete-directory-internal.
5157 ;; As `move-file-to-trash' trashes directories (empty or
5158 ;; otherwise) as a unit, we do not need to recurse here.
5160 ;; Check if directory is empty apart from "." and "..".
5165 ;; Otherwise, call ourselves recursively if needed.
5169 ;; This test is equivalent to
5170 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
5171 ;; but more efficient
5175 ;; We do not want to delete "." and "..".
5181 "Return non-nil if files FILE1 and FILE2 name the same file.
5182 If FILE1 or FILE2 does not exist, the return value is unspecified."
5193 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5195 Return nil if DIR is not an existing directory."
5217 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5218 This function always sets the file modes of the output files to match
5219 the corresponding input file.
5221 The third arg KEEP-TIME non-nil means give the output files the same
5222 last-modified time as the old ones. (This works on only some systems.)
5224 A prefix arg makes KEEP-TIME non-nil.
5226 Noninteractively, the last argument PARENTS says whether to
5227 create parent directories if they don't exist. Interactively,
5228 this happens by default.
5230 If NEWNAME names an existing directory, copy DIRECTORY as a
5231 subdirectory there. However, if called from Lisp with a non-nil
5232 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5233 directly into NEWNAME instead."
5240 default-directory default-directory nil nil)
5241 current-prefix-arg t nil)))
5244 directory newname))
5245 ;; If default-directory is a remote directory, make sure we find its
5246 ;; copy-directory handler.
5251 newname keep-time parents copy-contents)
5253 ;; Compute target name.
5258 ;; If NEWNAME is not an existing directory, create it;
5259 ;; that is where we will copy the files of DIRECTORY.
5261 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5262 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5267 newname))
5271 newname))
5274 ;; Copy recursively.
5276 ;; We do not want to copy "." and "..".
5278 directory-files-no-dot-files-regexp))
5288 ;; Set directory attributes.
5294 \f
5295 ;; At time of writing, only info uses this.
5297 "Return a copy of DIRS with all non-existent directories removed.
5298 The optional argument KEEP is a list of directories to retain even if
5299 they don't exist, and REJECT is a list of directories to remove from
5300 DIRS, even if they exist; REJECT takes precedence over KEEP.
5302 Note that membership in REJECT and KEEP is checked using simple string
5303 comparison."
5309 dirs)))
5311 \f
5314 "Function to use to revert this buffer, or nil to do the default.
5315 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5316 which are the arguments that `revert-buffer' received.
5317 It also has access to the `preserve-modes' argument of `revert-buffer'
5322 #'revert-buffer-insert-file-contents--default-function
5323 "Function to use to insert contents when reverting this buffer.
5324 Gets two args, first the nominal file name to use,
5325 and second, t if reading the auto-save file.
5335 "Function to check whether a non-file buffer needs reverting.
5336 This should be a function with one optional argument NOCONFIRM.
5337 Auto Revert Mode passes t for NOCONFIRM. The function should return
5338 non-nil if the buffer should be reverted. A return value of
5339 `fast' means that the need for reverting was not checked, but
5340 that reverting the buffer is fast. The buffer is current when
5341 this function is called.
5343 The idea behind the NOCONFIRM argument is that it should be
5344 non-nil if the buffer is going to be reverted without asking the
5345 user. In such situations, one has to be careful with potentially
5346 time consuming operations.
5348 For more information on how this variable is used by Auto Revert mode,
5352 "Normal hook for `revert-buffer' to run before reverting.
5353 If `revert-buffer-function' is used to override the normal revert
5357 "Normal hook for `revert-buffer' to run after reverting.
5358 Note that the hook value that it runs is the value that was in effect
5359 before reverting; that makes a difference if you have buffer-local
5360 hook functions.
5362 If `revert-buffer-function' is used to override the normal revert
5366 "Non-nil if a `revert-buffer' operation is in progress, nil otherwise.
5371 ;; `revert-buffer-function' was defined long ago to be a function of only
5372 ;; 2 arguments, so we have to use a dynbind variable to pass the
5373 ;; `preserve-modes' argument of `revert-buffer'.
5377 "Replace current buffer text with the text of the visited file on disk.
5378 This undoes all changes since the file was visited or saved.
5379 With a prefix argument, offer to revert from latest auto-save file, if
5380 that is more recent than the visited file.
5382 This command also implements an interface for special buffers
5383 that contain text which doesn't come from a file, but reflects
5384 some other data instead (e.g. Dired buffers, `buffer-list'
5385 buffers). This is done via the variable `revert-buffer-function'.
5386 In these cases, it should reconstruct the buffer contents from the
5387 appropriate data.
5389 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5390 to revert from the auto-save file when this is nil. Note that the
5391 sense of this argument is the reverse of the prefix argument, for the
5392 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5393 to nil.
5395 Optional second argument NOCONFIRM means don't ask for confirmation
5396 at all. (The variable `revert-without-query' offers another way to
5397 revert buffers without querying for confirmation.)
5399 Optional third argument PRESERVE-MODES non-nil means don't alter
5400 the files modes. Normally we reinitialize them using `normal-mode'.
5402 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5404 If the value of `revert-buffer-function' is non-nil, it is called to
5405 do all the work for this command. Otherwise, the hooks
5406 `before-revert-hook' and `after-revert-hook' are run at the beginning
5407 and the end, and if `revert-buffer-insert-file-contents-function' is
5408 non-nil, it is called instead of rereading visited file contents."
5410 ;; I admit it's odd to reverse the sense of the prefix argument, but
5411 ;; there is a lot of code out there which assumes that the first
5412 ;; argument should be t to avoid consulting the auto-save file, and
5413 ;; there's no straightforward way to encourage authors to notice a
5414 ;; reversal of the argument sense. So I'm just changing the user
5415 ;; interface, but leaving the programmatic interface the same.
5420 ignore-auto noconfirm)))
5426 buffer-auto-save-file-name
5431 buffer-auto-save-file-name
5432 buffer-file-name)))
5442 file-name)))
5444 ;; If file was backed up but has changed since,
5445 ;; we should make another backup.
5449 ;; Effectively copy the after-revert-hook status,
5450 ;; since after-find-file will clobber it.
5453 after-revert-hook))
5455 ;; FIXME: Throw away undo-log when preserve-modes is nil?
5459 file-name auto-save-p)
5460 ;; Recompute the truename in case changes in symlinks
5461 ;; have changed the truename.
5465 ;; Run after-revert-hook as it was before we reverted.
5469 local-hook)
5472 t)))))
5478 "File %s no longer exists!"
5480 file-name))
5483 "File %s no longer readable!"
5485 file-name))
5487 ;; Bind buffer-file-name to nil
5488 ;; so that we don't try to lock the file.
5494 ;; Auto-saved file should be read by Emacs's
5495 ;; internal coding.
5499 buffer-file-coding-system-explicit
5502 coding-system-for-read
5504 coding-system-for-read)
5506 ;; As a coding system suitable for multibyte
5507 ;; buffer is specified, make the current
5508 ;; buffer multibyte.
5511 ;; This force after-insert-file-set-coding
5512 ;; (called from insert-file-contents) to set
5513 ;; buffer-file-coding-system to a proper value.
5516 ;; Note that this preserves point in an intelligent way.
5520 nil nil t))
5522 nil nil t))))))
5525 "Recover the visited file--get contents from its last auto-save file."
5530 "Visit file FILE, but get contents from its last auto-save file."
5531 ;; Actually putting the file name in the minibuffer should be used
5532 ;; only rarely.
5533 ;; Not just because users often use the default.
5546 "*Directory*" nil
5557 ;; Use insert-directory-safely, not insert-directory,
5558 ;; because these files might not exist. In particular,
5559 ;; FILE might not exist if the auto-save file was for
5560 ;; a buffer that didn't visit a file, such as "*mail*".
5561 ;; The code in v20.x called `ls' directly, so we need
5562 ;; to emulate what `ls' did in that case.
5567 ;; Keep the current buffer-file-coding-system.
5569 ;; Auto-saved file should be read with special coding.
5578 "Recover auto save files from a previous Emacs session.
5579 This command first displays a Dired buffer showing you the
5580 previous sessions that you could recover from.
5581 To choose one, move point to the proper line and then type C-c C-c.
5582 Then you'll be asked about a number of files to recover."
5592 auto-save-list-file-prefix)))
5593 t)
5604 ;; Each line starts with a space
5605 ;; so that Font Lock mode won't highlight the first character.
5608 " To delete a session file, type \
5614 "Choose one saved session to recover auto-save files from.
5615 This command is used in the special Dired buffer created by
5618 ;; Get the name of the session file to recover from.
5620 files
5626 ;; Read in the auto-save-list file.
5629 ;; Loop thru the text of that file
5630 ;; and get out the names of the files to recover.
5634 ;; This is a pair of lines for a non-file-visiting buffer.
5635 ;; Get the auto-save file name and manufacture
5636 ;; a "visited file name" from that.
5639 ;; If there is no auto-save file name, the
5640 ;; auto-save-list file is probably corrupted.
5653 ;; This pair of lines is a file-visiting
5654 ;; buffer. Use the visited file name.
5664 ;; Ignore a file if its auto-save file does not exist now.
5668 ;; The file contains a pair of line for each auto-saved buffer.
5669 ;; The first line of the pair contains the visited file name
5670 ;; or is empty if the buffer was not visiting a file.
5671 ;; The second line is the auto-save file name.
5679 files
5685 "Kill BUFFER if confirmed."
5693 "Kill some buffers. Asks the user whether to kill each one of them.
5694 Non-interactively, if optional argument LIST is non-nil, it
5695 specifies the list of buffers to kill, asking for approval for each one."
5703 ; if we killed the base buffer.
5710 "Kill buffers whose name matches the specified REGEXP.
5711 The optional second argument indicates whether to kill internal buffers too."
5720 \f
5722 "Adjust current buffer's auto save file name for current conditions.
5723 Also rename any existing auto save file, if it was made in this session."
5735 "Return file name to use for auto-saves of current buffer.
5736 Does not consider `auto-save-visited-file-name' as that variable is checked
5737 before calling this function. You can redefine this for customization.
5738 See also `auto-save-file-name-p'."
5746 result uniq)
5747 ;; Apply user-specified translations
5748 ;; to the file name.
5752 filename)
5762 filename))))
5767 ;; We truncate the file name to DOS 8+3 limits
5768 ;; before doing anything else, because the regexp
5769 ;; passed to string-match below cannot handle
5770 ;; extensions longer than 3 characters, multiple
5771 ;; dots, and other atrocities.
5776 fn)
5781 "#"
5784 ;; Make sure auto-save file names don't contain characters
5785 ;; invalid for the underlying filesystem.
5787 ;; Don't modify remote (ange-ftp) filenames
5790 result))))
5792 ;; Deal with buffers that don't have any associated files. (Mail
5793 ;; mode tends to create a good number of these.)
5797 file-name)
5798 ;; Restrict the characters used in the file name to those which
5799 ;; are known to be safe on all filesystems, url-encoding the
5800 ;; rest.
5801 ;; We do this on all platforms, because even if we are not
5802 ;; running on DOS/Windows, the current directory may be on a
5803 ;; mounted VFAT filesystem, such as a USB memory stick.
5807 ;; For multibyte characters, this will produce more than
5808 ;; 2 hex digits, so is not true URL encoding.
5812 ;; Generate the file name.
5818 ;; Try a few alternative directories, to get one we can
5819 ;; write it.
5825 ;; Don't modify remote (ange-ftp) filenames
5827 ;; The call to convert-standard-filename is in case
5828 ;; buffer-name includes characters not allowed by the
5829 ;; DOS/Windows filesystems. make-temp-file writes to the
5830 ;; file it creates, so we must fix the file name _before_
5831 ;; make-temp-file is called.
5833 fname))
5835 ;; make-temp-file creates the file,
5836 ;; but we don't want it to exist until we do an auto-save.
5840 file-name)))
5843 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5844 FILENAME should lack slashes. You can redefine this for customization."
5846 \f
5848 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5849 The generated regexp will match a filename only if the filename
5850 matches that wildcard according to shell rules. Only wildcards known
5851 by `sh' are supported."
5853 ;; Copy the initial run of non-special characters.
5856 ;; If no special characters, we're almost done.
5860 j)
5862 result
5883 ;; Found "[^". Insert a `\0' character
5884 ;; (which cannot happen in a filename)
5885 ;; into the character class, so that `^'
5886 ;; is not the first character after `[',
5887 ;; and thus non-special in a regexp.
5892 ;; I don't think `]' can appear in a
5893 ;; character class in a wildcard, but
5894 ;; let's be general here.
5901 i
5914 ;; Shell wildcards should match the entire filename,
5915 ;; not its part. Make the regexp say so.
5917 \f
5920 "Switches for `list-directory' to pass to `ls' for brief listing."
5926 "Switches for `list-directory' to pass to `ls' for verbose listing."
5931 "Expand wildcard pattern PATTERN.
5932 This returns a list of file names which match the pattern.
5934 If PATTERN is written as an absolute file name,
5935 the values are absolute also.
5937 If PATTERN is written as a relative file name, it is interpreted
5938 relative to the current default directory, `default-directory'.
5939 The file names returned are normally also relative to the current
5940 default directory. However, if FULL is non-nil, they are absolute."
5944 ;; A list of all dirs that DIRPART specifies.
5945 ;; This can be more than one dir
5946 ;; if DIRPART contains wildcards.
5950 dirpart)))
5954 contents)
5960 ;; Filter out "." and ".."
5965 name))
5972 this-dir-contents)
5973 this-dir-contents)
5974 contents))))
5976 contents)))
5978 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5982 "Display a list of files in or matching DIRNAME, a la `ls'.
5983 DIRNAME is globbed by the shell if necessary.
5984 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5985 Actions controlled by variables `list-directory-brief-switches'
5986 and `list-directory-verbose-switches'."
5990 nil default-directory nil)
5991 pfx)))
5993 list-directory-brief-switches))
5994 buffer)
6006 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
6014 "Quote characters special to the shell in PATTERN, leave wildcards alone.
6016 PATTERN is assumed to represent a file-name wildcard suitable for the
6017 underlying filesystem. For Unix and GNU/Linux, each character from the
6019 the parts of the pattern which don't include wildcard characters are
6020 quoted with double quotes.
6023 on Windows), so PATTERN can use them to quote wildcard characters that
6024 need to be passed verbatim to shell commands."
6028 ;; DOS/Windows don't allow `"' in file names. So if the
6029 ;; argument has quotes, we can safely assume it is already
6030 ;; quoted by the caller.
6032 ;; We quote [&()#$'] in case their shell is a port of a
6033 ;; Unixy shell. We quote [,=+] because stock DOS and
6034 ;; Windows shells require that in some cases, such as
6035 ;; passing arguments to batch files that use positional
6036 ;; arguments like %1.
6038 pattern
6041 end)
6058 pattern))))
6065 "Program to get the amount of free space on a file system.
6066 We assume the output has the format of `df'.
6067 The value of this variable must be just a command name or file name;
6068 if you want to specify options, use `directory-free-space-args'.
6070 A value of nil disables this feature.
6072 If the function `file-system-info' is defined, it is always used in
6073 preference to the program given by this variable."
6079 "Options to use when running `directory-free-space-program'."
6084 "Return the amount of free space on directory DIR's file system.
6085 The return value is a string describing the amount of free
6086 space (normally, the number of free 1KB blocks).
6088 This function calls `file-system-info' if it is available, or
6089 invokes the program specified by `directory-free-space-program'
6090 and `directory-free-space-args'. If the system call or program
6091 is unsuccessful, or if DIR is a remote directory, this function
6092 returns nil."
6094 ;; Try to find the number of free blocks. Non-Posix systems don't
6095 ;; always have df, but might have an equivalent system call.
6104 ;; Avoid failure if the default directory does
6105 ;; not exist (Bug#2631, Bug#3911).
6109 nil t nil
6110 directory-free-space-args
6113 ;; Assume that the "available" column is before the
6114 ;; "capacity" column. Find the "%" and scan backward.
6118 "[[:space:]]+[^[:space:]]+%[^%]*$"
6125 ;; The following expression replaces `dired-move-to-filename-regexp'.
6129 ;; In some locales, month abbreviations are as short as 2 letters,
6130 ;; and they can be followed by ".".
6131 ;; In Breton, a month name can include a quote character.
6144 s "+"
6147 ;; Japanese MS-Windows ls-lisp has one-digit months, and
6148 ;; omits the Kanji characters after month and day-of-month.
6149 ;; On Mac OS X 10.3, the date format in East Asian locales is
6150 ;; day-of-month digits followed by month digits.
6156 ;; The "[0-9]" below requires the previous column to end in a digit.
6157 ;; This avoids recognizing `1 may 1997' as a date in the line:
6158 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
6160 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
6162 ;; For non-iso date formats, we add the ".*" in order to find
6163 ;; the last possible match. This avoids recognizing
6164 ;; `jservice 10 1024' as a date in the line:
6165 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6167 ;; vc dired listings provide the state or blanks between file
6168 ;; permissions and date. The state is always surrounded by
6169 ;; parentheses:
6170 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6171 ;; This is not supported yet.
6176 "Regular expression to match up to the file name in a directory listing.
6177 The default value is designed to recognize dates and times
6182 ;; insert-directory
6183 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6184 ;; FULL-DIRECTORY-P is nil.
6185 ;; The single line of output must display FILE's name as it was
6186 ;; given, namely, an absolute path name.
6187 ;; - must insert exactly one line for each file if WILDCARD or
6188 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6189 ;; before the file lines, plus optional text after the file lines.
6190 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6191 ;; allowed.
6192 ;; File lines should display the basename.
6193 ;; - must be consistent with
6194 ;; - functions dired-move-to-filename, (these two define what a file line is)
6195 ;; dired-move-to-end-of-filename,
6196 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6197 ;; dired-insert-headerline
6198 ;; dired-after-subdir-garbage (defines what a "total" line is)
6199 ;; - variable dired-subdir-regexp
6200 ;; - may be passed "--dired" as the first argument in SWITCHES.
6201 ;; Filename handlers might have to remove this switch if their
6202 ;; "ls" command does not support it.
6204 "Insert directory listing for FILE, formatted according to SWITCHES.
6205 Leaves point after the inserted text.
6206 SWITCHES may be a string of options, or a list of strings
6207 representing individual options.
6208 Optional third arg WILDCARD means treat FILE as shell wildcard.
6209 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6210 switches do not contain `d', so that a full listing is expected.
6212 This works by running a directory listing program
6213 whose name is in the variable `insert-directory-program'.
6214 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6216 When SWITCHES contains the long `--dired' option, this function
6217 treats it specially, for the sake of dired. However, the
6218 normally equivalent short `-D' option is just passed on to
6219 `insert-directory-program', as any other option."
6220 ;; We need the directory in order to find the right handler.
6225 wildcard full-directory-p)
6228 ;; Read the actual directory using `insert-directory-program'.
6229 ;; RESULT gets the status code.
6231 ;; putting text property `dired-filename, decode one
6232 ;; bunch by one to preserve that property.
6234 ;; This is to control encoding the arguments in call-process.
6238 default-file-name-coding-system))))
6241 ;; Run ls in the directory part of the file pattern
6242 ;; using the last component as argument.
6248 ;; NB since switches is passed to the shell, be
6249 ;; careful of malicious values, eg "-l;reboot".
6250 ;; See eg dired-safe-switches-p.
6252 shell-file-name nil t nil
6253 "-c"
6255 ""
6257 insert-directory-program
6258 " -d "
6260 switches
6262 " -- "
6263 ;; Quote some characters that have
6264 ;; special meanings in shells; but
6265 ;; don't quote the wildcards--we want
6266 ;; them to be special. We also
6267 ;; currently don't quote the quoting
6268 ;; characters in case people want to
6269 ;; use them explicitly to quote
6270 ;; wildcard characters.
6272 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6273 ;; directory if FILE is a symbolic link.
6281 insert-directory-program nil t nil
6285 ;; Split the switches at any spaces so we can
6286 ;; pass separate options as separate args.
6288 ;; Avoid lossage if FILE starts with `-'.
6296 file))))))))
6298 ;; If we got "//DIRED//" in the output, it means we got a real
6299 ;; directory listing, even if `ls' returned nonzero.
6300 ;; So ignore any errors.
6313 ;; The first time ls returns an error,
6314 ;; find the version numbers of ls,
6315 ;; and set insert-directory-ls-version
6316 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6317 ;; is equal or if the info cannot be obtained.
6318 ;; (That can mean it isn't GNU ls.)
6328 comparison)
6344 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6348 ;; If `insert-directory-program' failed, signal an error.
6350 ;; Delete the error message it may have output.
6352 ;; On non-Posix systems, we cannot open a directory, so
6353 ;; don't even try, because that will always result in
6354 ;; the ubiquitous "Access denied". Instead, show the
6355 ;; command line so the user can try to guess what went wrong.
6360 insert-directory-program
6362 file result)
6363 ;; Unix. Access the file to get a suitable error.
6370 ;; The following overshoots by one line for an empty
6371 ;; directory listed with "--dired", but without "-a"
6372 ;; switch, where the ls output contains a
6373 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6374 ;; We take care of that case later.
6382 error-lines)
6383 ;; Find all the lines that are error messages,
6384 ;; and record the bounds of each one.
6391 ;; Now read the numeric positions of file names.
6398 error-lines))
6401 error-lines)))
6403 ;; End is followed by \n or by " -> ".
6405 ;; It seems that we can't trust ls's output as to
6406 ;; byte positions of filenames.
6412 ;; Take care of the case where the ls output contains a
6413 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6414 ;; and we went one line too far back (see above).
6419 ;; Now decode what read if necessary.
6421 file-name-coding-system
6422 default-file-name-coding-system
6424 coding-no-eol
6425 val pos)
6429 ;; If no coding system is specified or detection is
6430 ;; requested, detect the coding.
6444 ;; Force no eol conversion on a file name, so
6445 ;; that CR is preserved.
6453 ;; Try to insert the amount of free space.
6456 ;; First find the line to put it on.
6460 ;; Replace "total" with "used", to avoid confusion.
6466 "Convert `ls --dired' file name position value POS to a buffer position.
6467 File name position values returned in ls --dired output
6468 count only stdout; they don't count the error messages sent to stderr.
6469 So this function converts to them to real buffer positions.
6470 ERROR-LINES is a list of buffer positions of error message lines,
6471 of the form (START END)."
6475 pos)
6479 "Insert directory listing for FILE, formatted according to SWITCHES.
6481 Like `insert-directory', but if FILE does not exist, it inserts a
6482 message to that effect instead of signaling an error."
6485 ;; Simulate the message printed by `ls'.
6489 "Functions to call with no arguments to query about killing Emacs.
6490 If any of these functions returns nil, killing Emacs is canceled.
6491 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6495 "How to ask for confirmation when leaving Emacs.
6496 If nil, the default, don't ask at all. If the value is non-nil, it should
6497 be a predicate function such as `yes-or-no-p'."
6505 "Offer to save each buffer, then kill this Emacs process.
6506 With prefix ARG, silently save all file-visiting buffers without asking.
6507 If there are active processes where `process-query-on-exit-flag'
6508 returns non-nil, asks whether processes should be killed.
6509 Runs the members of `kill-emacs-query-functions' in turn and stops
6510 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6519 ;; process-list is not defined on MSDOS.
6521 active)
6537 ;; Query the user for other things, perhaps.
6544 "Offer to save each buffer, then kill the current connection.
6545 If the current frame has no client, kill Emacs itself.
6547 With prefix ARG, silently save all file-visiting buffers, then kill.
6549 If emacsclient was started with a list of filenames to edit, then
6550 only these files will be asked to be saved."
6555 \f
6556 ;; We use /: as a prefix to "quote" a file name
6557 ;; so that magic file name handlers will not apply to it.
6561 file-name-handler-alist))
6563 ;; We depend on being the last handler on the list,
6564 ;; so that anything else which does need handling
6565 ;; has been handled already.
6566 ;; So it is safe for us to inhibit *all* magic file name handlers.
6575 default-directory))
6576 ;; Get a list of the indices of the args which are file names.
6579 ;; The first six are special because they
6580 ;; return a file name. We want to include the /:
6581 ;; in the return value.
6582 ;; So just avoid stripping it in the first place.
6589 ;; `identity' means just return the first arg
6590 ;; not stripped of its quoting.
6592 ;; `add' means add "/:" to the result.
6595 ;; `unquote-then-quote' means set buffer-file-name
6596 ;; temporarily to unquoted filename.
6598 ;; List the arguments which are filenames.
6606 ;; For all other operations, treat the first argument only
6607 ;; as the file name.
6609 method
6610 ;; Copy ARGUMENTS so we can replace elements in it.
6614 ;; Strip off the /: from the file names that have it.
6622 "/"
6628 (`insert-file-contents
6634 (`unquote-then-quote
6639 \f
6640 ;; Symbolic modes and read-file-modes.
6643 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6644 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6645 Others, or All) for whom to produce the mask.
6646 The bit-mask that is returned extracts from mode bits the access rights
6647 for the specified category of users."
6655 "Convert CHAR to a numeric value of mode bits.
6656 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6657 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6664 ;; Rights relative to the previous file modes.
6675 "Convert a symbolic mode string specification to an equivalent number.
6677 WHO-MASK is the bit-mask specifying the category of users to which to
6678 apply the access permissions. See `file-modes-char-to-who'.
6679 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6680 RIGHTS request to add, remove, or set permissions based on existing ones,
6687 char-right)
6694 num-rights
6698 op char-right)))
6699 num-rights))
6702 "Convert symbolic file modes to numeric file modes.
6703 MODES is the string to convert, it should match
6705 See Info node `(coreutils)File permissions' for more information on this
6706 notation.
6707 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6708 MODES request to add, remove, or set permissions based on existing ones,
6722 num-who num-modes)
6725 num-modes)))
6728 "Read file modes in octal or symbolic notation and return its numeric value.
6729 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6730 ORIG-FILE is the name of a file on whose mode bits to base returned
6731 permissions if what user types requests to add, remove, or set permissions
6747 nil nil default)))
6756 ;; Trashcan handling.
6758 "Directory for `move-file-to-trash' to move files and directories to.
6759 This directory is only used when the function `system-move-file-to-trash'
6760 is not defined.
6761 Relative paths are interpreted relative to `default-directory'.
6762 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6772 "Move the file (or directory) named FILENAME to the trash.
6773 When `delete-by-moving-to-trash' is non-nil, this function is
6774 called by `delete-file' and `delete-directory' instead of
6775 deleting files outright.
6777 If the function `system-move-file-to-trash' is defined, call it
6778 with FILENAME as an argument.
6779 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6780 directory.
6781 Otherwise, trash FILENAME using the freedesktop.org conventions,
6782 like the GNOME, KDE and XFCE desktop environments. Emacs only
6786 ;; If `trash-directory' is non-nil, move the file there.
6790 trash-dir)))
6791 ;; We can't trash a parent directory of trash-directory.
6794 trash-dir filename))
6797 ;; Ensure that the trashed file-name is unique.
6804 ;; If `system-move-file-to-trash' is defined, use it.
6807 ;; Otherwise, use the freedesktop.org method, as specified at
6808 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6819 ;; Check if we have permissions to delete.
6823 ;; The trashed file cannot be the trash dir or its parent.
6826 trash-files-dir filename))
6829 trash-info-dir filename))
6831 ;; Ensure that the trash directory exists; otherwise, create it.
6842 ;; Try to move to trash with .trashinfo undo information
6847 ;; Perform url-encoding on FN. For compatibility with
6848 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6849 ;; for path separators.
6854 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6855 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6868 fn))
6873 ;; Attempt to make .trashinfo file, trying up to 5
6874 ;; times. The .trashinfo file is opened with O_EXCL,
6875 ;; as per trash-spec 0.7, even if that can be a problem
6876 ;; on old NFS versions...
6880 trash-files-dir))
6882 success info-fn)
6887 trash-info-dir))
6895 ;; Uniquify new-fn. (Some file managers do not
6896 ;; like Emacs-style backup file names---e.g. bug
6897 ;; 170956 in Konqueror bug tracker.)
6902 ;; Finally, try to move the file to the trashcan.
6906 \f
6931 ;;; files.el ends here