| blob | 499948c4176ee82930c7447e643bbe2b5cd38b3a |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 ;; 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
7 ;; Maintainer: FSF
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; Defines most of Emacs's file- and directory-handling functions,
27 ;; including basic file visiting, backup generation, link handling,
28 ;; ITS-id version control, load- and write-hook handling, and the like.
30 ;;; Code:
35 "Backups of edited data files."
39 "Finding files."
44 "Non-nil means delete auto-save file when a buffer is saved or killed.
46 Note that the auto-save file will not be deleted if the buffer is killed
47 when it has unsaved changes."
52 nil
53 "Alist of abbreviations for file directories.
54 A list of elements of the form (FROM . TO), each meaning to replace
55 FROM with TO when it appears in a directory name. This replacement is
56 done when setting up the default directory of a newly visited file.
57 *Every* FROM string should start with `^'.
59 FROM and TO should be equivalent names, which refer to the
60 same directory. Do not use `~' in the TO strings;
61 they should be ordinary absolute directory names.
63 Use this feature when you have directories which you normally refer to
64 via absolute symbolic links. Make TO the name of the link, and FROM
65 the name it is linked to."
74 "Non-nil means make a backup of a file the first time it is saved.
75 This can be done by renaming the file or by copying.
77 Renaming means that Emacs renames the existing file so that it is a
78 backup file, then writes the buffer into a new file. Any other names
79 that the old file had will now refer to the backup file. The new file
80 is owned by you and its group is defaulted.
82 Copying means that Emacs copies the existing file into the backup
83 file, then writes the buffer on top of the existing file. Any other
84 names that the old file had will now refer to the new (edited) file.
85 The file's owner and group are unchanged.
87 The choice of renaming or copying is controlled by the variables
88 `backup-by-copying', `backup-by-copying-when-linked',
89 `backup-by-copying-when-mismatch' and
90 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
94 ;; Do this so that local variables based on the file name
95 ;; are not overridden by the major mode.
97 "Non-nil means don't make a backup, regardless of the other parameters.
98 This variable is intended for use by making it local to a buffer.
103 "Non-nil means always use copying to create backup files.
104 See documentation of variable `make-backup-files'."
109 "Non-nil means use copying to create backups for files with multiple names.
110 This causes the alternate names to refer to the latest version as edited.
111 This variable is relevant only if `backup-by-copying' is nil."
116 "Non-nil means create backups by copying if this preserves owner or group.
117 Renaming may still be used (subject to control of other variables)
118 when it would not result in changing the owner or group of the file;
119 that is, for files which are owned by you and whose group matches
120 the default for a new file created there by you.
121 This variable is relevant only if `backup-by-copying' is nil."
126 "Non-nil means create backups by copying to preserve a privileged owner.
127 Renaming may still be used (subject to control of other variables)
128 when it would not result in changing the owner of the file or if the owner
129 has a user id greater than the value of this variable. This is useful
130 when low-numbered uid's are used for special system users (such as root)
131 that must maintain ownership of certain files.
132 This variable is relevant only if `backup-by-copying' and
133 `backup-by-copying-when-mismatch' are nil."
138 "Predicate that looks at a file name and decides whether to make backups.
142 "Non-nil in a buffer means always offer to save buffer on exit.
143 Do so even if the buffer is not visiting a file.
144 Automatically local in all buffers."
150 "Non-nil means find a file under alternative names, in existing buffers.
151 This means if any existing buffer is visiting the file you want
152 under another name, you get the existing buffer instead of a new buffer."
157 "Non-nil means visit a file under its truename.
158 The truename of a file is found by chasing all links
159 both at the file level and at the levels of the containing directories."
165 "Specify which files should be reverted without query.
166 The value is a list of regular expressions.
167 If the file name matches one of these regular expressions,
168 then `revert-buffer' reverts the file without querying
169 if the file has changed on disk and you have not edited the buffer."
174 "The device number and file number of the file visited in the current buffer.
175 The value is a list of the form (FILENUM DEVNUM).
176 This pair of numbers uniquely identifies the file.
194 "The directory for writing temporary files."
200 "The directory for writing small temporary files.
201 If non-nil, this directory is used instead of `temporary-file-directory'
202 by programs that create small temporary files. This is for systems that
203 have fast storage with limited space, such as a RAM disk."
207 ;; The system null device. (Should reference NULL_DEVICE from C.)
233 "Non-nil means protect against I/O errors while saving files.
234 Some modes set this non-nil in particular buffers.
236 This feature works by writing the new contents into a temporary file
237 and then renaming the temporary file to replace the original.
238 In this way, any I/O error in writing leaves the original untouched,
239 and there is never any instant where the file is nonexistent.
241 Note that this feature forces backups to be made by copying.
242 Yet, at the same time, saving a precious file
243 breaks any hard links between it and other files.
245 This feature is advisory: for example, if the directory in which the
246 file is being saved is not writable, Emacs may ignore a non-nil value
247 of `file-precious-flag' and write directly into the file.
249 See also: `break-hardlink-on-save'."
254 "Non-nil means when saving a file that exists under several names
255 \(i.e., has multiple hardlinks), break the hardlink associated with
256 `buffer-file-name' and write to a new file, so that the other
257 instances of the file are not affected by the save.
259 If `buffer-file-name' refers to a symlink, do not break the symlink.
261 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
262 For example, if the directory in which a file is being saved is not
263 itself writable, then error instead of saving in some
264 hardlink-nonbreaking way.
266 See also `backup-by-copying' and `backup-by-copying-when-linked'."
272 "Control use of version numbers for backup files.
273 When t, make numeric backup versions unconditionally.
274 When nil, make them for files that have some already.
275 The value `never' means do not make them."
285 "When cleaning directory, number of versions to keep."
291 "If t, delete excess backup versions silently.
292 If nil, ask confirmation. Any other value prevents any trimming."
299 "Number of oldest versions to keep when a new numbered backup is made."
305 "Number of newest versions to keep when a new numbered backup is made.
306 Includes the new backup. Must be > 0"
312 "Whether to add a newline automatically at the end of the file.
314 A value of t means do this only when the file is about to be saved.
315 A value of `visit' means do this right after the file is visited.
316 A value of `visit-save' means do it at both of those times.
317 Any other non-nil value means ask user whether to add a newline, when saving.
318 A value of nil means don't add newlines.
320 Certain major modes set this locally to the value obtained
321 from `mode-require-final-newline'."
330 "Whether to add a newline at end of file, in certain major modes.
331 Those modes set `require-final-newline' to this value when you enable them.
332 They do so because they are often used for files that are supposed
333 to end in newlines, and the question is how to arrange that.
335 A value of t means do this only when the file is about to be saved.
336 A value of `visit' means do this right after the file is visited.
337 A value of `visit-save' means do it at both of those times.
338 Any other non-nil value means ask user whether to add a newline, when saving.
340 A value of nil means do not add newlines. That is a risky choice in this
341 variable since this value is used for modes for files that ought to have
342 final newlines. So if you set this to nil, you must explicitly check and
343 add a final newline, whenever you save a file that really needs one."
353 "Non-nil says by default do auto-saving of every file-visiting buffer."
359 ;; Don't put "\\2" inside expand-file-name, since it will be
360 ;; transformed to "/2" on DOS/Windows.
362 "Transforms to apply to buffer file name before making auto-save file name.
363 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
364 REGEXP is a regular expression to match against the file name.
365 If it matches, `replace-match' is used to replace the
366 matching part with REPLACEMENT.
367 If the optional element UNIQUIFY is non-nil, the auto-save file name is
368 constructed by taking the directory part of the replaced file-name,
369 concatenated with the buffer file name with all directory separators
370 changed to `!' to prevent clashes. This will not work
371 correctly if your filesystem truncates the resulting name.
373 All the transforms in the list are tried, in the order they are listed.
374 When one transform applies, its result is final;
375 no further transforms are tried.
377 The default value is set up to put the auto-save file into the
378 temporary directory (see the variable `temporary-file-directory') for
379 editing a remote file.
381 On MS-DOS filesystems without long names this variable is always
382 ignored."
389 "Non-nil means save word abbrevs too when files are saved.
390 If `silently', don't ask the user before saving."
395 "Non-nil means allow `find-file' to visit directories.
396 To visit the directory, `find-file' runs `find-directory-functions'."
401 "List of functions to try in sequence to visit a directory.
402 Each function is called with the directory name as the sole argument
403 and should return either a buffer or nil."
407 ;;;It is not useful to make this a local variable.
408 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
410 "List of functions to be called for `find-file' on nonexistent file.
411 These functions are called as soon as the error is detected.
412 Variable `buffer-file-name' is already set up.
417 ;;;It is not useful to make this a local variable.
418 ;;;(put 'find-file-hooks 'permanent-local t)
421 "List of functions to be called after a buffer is loaded from a file.
422 The buffer's local variables (if any) will have been processed before the
423 functions are called."
430 "List of functions to be called before writing out a buffer to a file.
431 If one of them returns non-nil, the file is considered already written
432 and the rest are not called.
433 These hooks are considered to pertain to the visited file.
434 So any buffer-local binding of this variable is discarded if you change
436 change the major mode.
438 This hook is not run if any of the functions in
439 `write-contents-functions' returns non-nil. Both hooks pertain
440 to how to save a buffer to file, for instance, choosing a suitable
441 coding system and setting mode bits. (See Info
442 node `(elisp)Saving Buffers'.) To perform various checks or
453 "List of functions to be called before writing out a buffer to a file.
454 If one of them returns non-nil, the file is considered already written
455 and the rest are not called and neither are the functions in
456 `write-file-functions'.
458 This variable is meant to be used for hooks that pertain to the
459 buffer's contents, not to the particular visited file; thus,
460 `set-visited-file-name' does not clear this variable; but changing the
461 major mode does clear it.
463 For hooks that _do_ pertain to the particular visited file, use
464 `write-file-functions'. Both this variable and
465 `write-file-functions' relate to how a buffer is saved to file.
466 To perform various checks or updates before the buffer is saved,
473 "Control use of local variables in files you visit.
474 The value can be t, nil, :safe, :all, or something else.
476 A value of t means file local variables specifications are obeyed
477 if all the specified variable values are safe; if any values are
478 not safe, Emacs queries you, once, whether to set them all.
479 \(When you say yes to certain values, they are remembered as safe.)
481 :safe means set the safe variables, and ignore the rest.
482 :all means set all variables, whether safe or not.
483 (Don't set it permanently to :all.)
484 A value of nil means always ignore the file local variables.
486 Any other value means always query you once whether to set them all.
487 \(When you say yes to certain values, they are remembered as safe, but
490 This variable also controls use of major modes specified in
491 a -*- line.
494 always obeys file local variable specifications and the -*- line,
495 and ignores this variable."
504 "Like `enable-local-variables' but meant for buffer-local bindings.
505 The meaningful values are nil and non-nil. The default is non-nil.
506 If a major mode sets this to nil, buffer-locally, then any local
507 variables list in the file will be ignored.
509 This variable does not affect the use of major modes
514 The value can be t, nil or something else.
515 A value of t means obey `eval' variables.
516 A value of nil means ignore them; anything else means query."
522 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
531 "Non-nil means buffers visiting files read-only do so in view mode.
532 In fact, this means that all read-only buffers normally have
533 View mode enabled, including buffers that are read-only because
534 you visit a file you cannot alter, and buffers you make read-only
540 "History list of file names entered in the minibuffer.
542 Maximum length of the history list is determined by the value
544 \f
547 "Provides support for ange-ftp host name completion.
548 Runs the usual ange-ftp hook, but only for completion operations."
549 ;; Having this here avoids the need to load ange-ftp when it's not
550 ;; really in use.
556 inhibit-file-name-handlers)))
561 "Convert a standard file's name to something suitable for the OS.
562 This means to guarantee valid names and perhaps to canonicalize
563 certain patterns.
565 FILENAME should be an absolute file name since the conversion rules
566 sometimes vary depending on the position in the file name. E.g. c:/foo
567 is a valid DOS file name, but c:/bar/c:/foo is not.
569 This function's standard definition is trivial; it just returns
570 the argument. However, on Windows and DOS, replace invalid
571 characters. On DOS, make sure to obey the 8.3 limitations.
572 In the native Windows build, turn Cygwin names into native names,
573 and also turn slashes into backslashes if the shell requires it (see
574 `w32-shell-dos-semantics').
576 See Info node `(elisp)Standard File Names' for more details."
580 ;; Replace invalid filename characters with !
584 name)
585 filename))
588 "Read directory name, prompting with PROMPT and completing in directory DIR.
589 Value is not expanded---you must call `expand-file-name' yourself.
590 Default name to DEFAULT-DIRNAME if user exits with the same
591 non-empty string that was inserted by this function.
592 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
593 or just DIR if INITIAL is nil.)
594 If the user exits with an empty minibuffer, this function returns
595 an empty string. (This can only happen if the user erased the
596 pre-inserted contents or if `insert-default-directory' is nil.)
597 Fourth arg MUSTMATCH non-nil means require existing directory's name.
598 Non-nil and non-t means also require confirmation after completion.
599 Fifth arg INITIAL specifies text to start with.
600 DIR should be an absolute directory name. It defaults to
601 the value of `default-directory'."
606 dir))
607 mustmatch initial
610 \f
612 "Show the current default directory."
617 "Value of the CDPATH environment variable, as a list.
621 "Explode a search path into a list of directory names.
622 Directories are separated by occurrences of `path-separator'
623 \(which is colon in GNU and GNU-like systems)."
624 ;; We could use split-string here.
632 nil
637 cd-list)))
640 "Change current directory to given absolute file name DIR."
641 ;; Put the name into directory syntax now,
642 ;; because otherwise expand-file-name may give some bad results.
655 "Make DIR become the current buffer's default directory.
656 If your environment includes a `CDPATH' variable, try each one of
657 that list of directories (separated by occurrences of
658 `path-separator') when resolving a relative directory name.
659 The path separator is colon in GNU and GNU-like systems."
662 default-directory default-directory
678 cd-path)
679 nil))
683 "Load the Lisp file named FILE."
684 ;; This is a case where .elc makes a lot of sense.
691 "Search for FILENAME through PATH.
692 If found, return the absolute file name of FILENAME, with its suffixes;
693 otherwise return nil.
694 PATH should be a list of directories to look in, like the lists in
695 `exec-path' or `load-path'.
696 If SUFFIXES is non-nil, it should be a list of suffixes to append to
699 If non-nil, PREDICATE is used instead of `file-readable-p'.
700 PREDICATE can also be an integer to pass to the `access' system call,
701 in which case file-name handlers are ignored. This usage is deprecated.
703 For compatibility, PREDICATE can also be one of the symbols
704 `executable', `readable', `writable', or `exists', or a list of
705 one or more of those symbols."
716 "Do completion for file names passed to `locate-file'."
737 "Do completion for file names passed to `locate-file'.
738 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
741 string nil action))
746 "Regexp of directory names which stop the search in `locate-dominating-file'.
747 Any directory whose name matches this regexp will be treated like
748 a kind of root directory by `locate-dominating-file' which will stop its search
749 when it bumps into it.
750 The default regexp prevents fruitless and time-consuming attempts to find
751 special files in directories in which filenames are interpreted as hostnames,
754 ;; (defun locate-dominating-files (file regexp)
755 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
756 ;; Stop at the first parent where a matching file is found and return the list
757 ;; of files that that match in this directory."
758 ;; (catch 'found
759 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
760 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
761 ;; (let ((user nil)
762 ;; ;; Abbreviate, so as to stop when we cross ~/.
763 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
764 ;; files)
765 ;; (while (and dir
766 ;; ;; As a heuristic, we stop looking up the hierarchy of
767 ;; ;; directories as soon as we find a directory belonging to
768 ;; ;; another user. This should save us from looking in
769 ;; ;; things like /net and /afs. This assumes that all the
770 ;; ;; files inside a project belong to the same user.
771 ;; (let ((prev-user user))
772 ;; (setq user (nth 2 (file-attributes dir)))
773 ;; (or (null prev-user) (equal user prev-user))))
774 ;; (if (setq files (condition-case nil
775 ;; (directory-files dir 'full regexp 'nosort)
776 ;; (error nil)))
777 ;; (throw 'found files)
778 ;; (if (equal dir
779 ;; (setq dir (file-name-directory
780 ;; (directory-file-name dir))))
781 ;; (setq dir nil))))
782 ;; nil)))
785 "Look up the directory hierarchy from FILE for a file named NAME.
786 Stop at the first parent directory containing a file NAME,
787 and return the directory. Return nil if not found."
788 ;; We used to use the above locate-dominating-files code, but the
789 ;; directory-files call is very costly, so we're much better off doing
790 ;; multiple calls using the code in here.
791 ;;
792 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
793 ;; `name' in /home or in /.
797 ;; `user' is not initialized outside the loop because
798 ;; `file' may not exist, so we may have to walk up part of the
799 ;; hierarchy before we find the "initial UID".
801 try)
804 ;; FIXME: Disabled this heuristic because it is sometimes
805 ;; inappropriate.
806 ;; As a heuristic, we stop looking up the hierarchy of
807 ;; directories as soon as we find a directory belonging
808 ;; to another user. This should save us from looking in
809 ;; things like /net and /afs. This assumes that all the
810 ;; files inside a project belong to the same user.
811 ;; (let ((prev-user user))
812 ;; (setq user (nth 2 (file-attributes file)))
813 ;; (and prev-user (not (equal user prev-user))))
821 root))
825 "Search for COMMAND in `exec-path' and return the absolute file name.
826 Return nil if COMMAND is not found anywhere in `exec-path'."
827 ;; Use 1 rather than file-executable-p to better match the behavior of
828 ;; call-process.
832 "Load the library named LIBRARY.
834 LIBRARY should be a relative file name of the library, a string.
835 It can omit the suffix (a.k.a. file-name extension).
837 This is an interface to the function `load'."
841 load-path
846 "Test whether FILE specifies a location on a remote system.
847 Returns nil or a string identifying the remote connection (ideally
848 a prefix of FILE). For example, the remote identification for filename
851 less reliable than accessing local files.
852 Furthermore, relative file names do not work across remote connections.
854 IDENTIFICATION specifies which part of the identification shall
855 be returned as string. IDENTIFICATION can be the symbol
856 `method', `user', `host' or `localname'; any other value is
857 handled like nil and means to return the complete identification
858 string.
860 If CONNECTED is non-nil, the function returns an identification only
861 if FILE is located on a remote system, and a connection is established
862 to that remote system.
864 `file-remote-p' will never open a connection on its own."
868 nil)))
871 "Copy the file FILE into a temporary file on this machine.
872 Returns the name of the local copy, or nil, if FILE is directly
873 accessible."
874 ;; This formerly had an optional BUFFER argument that wasn't used by
875 ;; anything.
879 nil)))
882 "Return the truename of FILENAME, which should be absolute.
883 The truename of a file name is found by chasing symbolic links
884 both at the level of the file and at the level of the directories
885 containing it, until no links are left at any level.
888 ;; COUNTER and PREV-DIRS are only used in recursive calls.
889 ;; COUNTER can be a cons cell whose car is the count of how many
890 ;; more links to chase before getting an error.
891 ;; PREV-DIRS can be a cons cell whose car is an alist
892 ;; of truenames we've just recently computed.
906 ;; For speed, remove the ange-ftp completion handler from the list.
907 ;; We know it's not needed here.
908 ;; For even more speed, do this only on the outermost call.
915 ;; andrewi@harlequin.co.uk - none of the following code (except for
916 ;; invoking the file-name handler) currently applies on Windows
917 ;; (ie. there are no native symlinks), but there is an issue with
918 ;; case differences being ignored by the OS, and short "8.3 DOS"
919 ;; name aliases existing for all files. (The short names are not
920 ;; reported by directory-files, but can be used to refer to files.)
921 ;; It seems appropriate for file-truename to resolve these issues in
922 ;; the most natural way, which on Windows is to call the function
923 ;; `w32-long-file-name' - this returns the exact name of a file as
924 ;; it is stored on disk (expanding short name aliases with the full
925 ;; name in the process).
928 ;; For file name that has a special handler, call handler.
929 ;; This is so that ange-ftp can save time by doing a no-op.
932 ;; If filename contains a wildcard, newname will be the old name.
934 ;; If filename exists, use the long name. If it doesn't exist,
935 ;; drill down until we find a directory that exists, and use
936 ;; the long name of that, with the extra non-existent path
937 ;; components concatenated.
939 missing rest)
942 ;; Include the preceding directory separator in the missing
943 ;; part so subsequent recursion on the rest works.
948 ""
953 ;; If this file directly leads to a link, process that iteratively
954 ;; so that we don't use lots of stack.
960 ;; For file name that has a special handler, call handler.
961 ;; This is so that ange-ftp can save time by doing a no-op.
964 done t)
966 target dirfile)
967 ;; Get the truename of the directory.
969 ;; If these are equal, we have the (or a) root directory.
971 ;; If this is the same dir we last got the truename for,
972 ;; save time--don't recalculate.
982 done t)
985 done t)
986 ;; Put it back on the file name.
988 ;; Is the file name the name of a link?
991 ;; Yes => chase that link, then start all over
992 ;; since the link may point to a directory name that uses links.
993 ;; We can't safely use expand-file-name here
994 ;; since target might look like foo/../bar where foo
995 ;; is itself a link. Instead, we handle . and .. above.
998 target
1000 done nil)
1001 ;; No, we are done!
1003 filename))
1006 "Chase links in FILENAME until a name that is not a link.
1007 Unlike `file-truename', this does not check whether a parent
1008 directory name is a symbolic link.
1009 If the optional argument LIMIT is a number,
1010 it means chase no more than that many links and then stop."
1018 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1021 ;; Handle `..' by hand, since it needs to work in the
1022 ;; target of any directory symlink.
1023 ;; This code is not quite complete; it does not handle
1024 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1028 ;; Chase links in the default dir of the symlink.
1032 ;; Now find the parent of that dir.
1036 newname))
1039 "Create a temporary file.
1040 The returned file name (created by appending some random characters at the end
1041 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1042 is guaranteed to point to a newly created empty file.
1043 You can then use `write-region' to write new data into the file.
1045 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1047 If SUFFIX is non-nil, add that at the end of the file name."
1049 file)
1052 ;; Create temp files with strict access rights. It's easy to
1053 ;; loosen them later, whereas it's impossible to close the
1054 ;; time-window of loose permissions otherwise.
1062 temporary-file-directory)
1064 temporary-file-directory))))
1070 nil)
1072 ;; the file was somehow created by someone else between
1073 ;; `make-temp-name' and `write-region', let's try again.
1074 nil)
1075 file)
1076 ;; Reset the umask.
1080 "Change the encoding of FILE's name from CODING to NEW-CODING.
1081 The value is a new name of FILE.
1082 Signals a `file-already-exists' error if a file of the new name
1083 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1084 is non-nil. A number as fourth arg means request confirmation if
1085 the new name already exists. This is what happens in interactive
1086 use with M-x."
1089 default-file-name-coding-system))
1091 from-coding to-coding)
1093 ;; We provide the default coding only when it seems that
1094 ;; the filename is correctly decoded by the default
1095 ;; coding.
1101 filename default-coding)
1102 default-coding))
1106 ;; We provide the default coding only when a user is going to
1107 ;; change the encoding not from the default coding.
1111 filename from-coding)))
1114 filename from-coding default-coding)
1115 default-coding)))
1119 default-file-name-coding-system))
1120 ;; FILE should have been decoded by DEFAULT-CODING.
1124 ;; Suppress further encoding.
1129 newname))
1130 \f
1132 "Whether confirmation is requested before visiting a new file or buffer.
1133 If nil, confirmation is not requested.
1134 If the value is `after-completion', confirmation is only
1135 requested if the user called `minibuffer-complete' right before
1136 `minibuffer-complete-and-exit'.
1137 Any other non-nil value means to request confirmation.
1139 This affects commands like `switch-to-buffer' and `find-file'."
1147 "Whether to request confirmation before visiting a new file or buffer.
1148 The variable `confirm-nonexistent-file-or-buffer' determines the
1149 return value, which may be passed as the REQUIRE-MATCH arg to
1150 `read-buffer' or `find-file-read-args'."
1158 "Read the name of a buffer to switch to and return as a string.
1159 It is intended for `switch-to-buffer' family of commands since they
1160 need to omit the name of current buffer from the list of completions
1161 and default values."
1166 ;; Since rbts-completion-table is built dynamically, we
1167 ;; can't just add it to the default value of
1168 ;; icomplete-with-completion-tables, so we add it
1169 ;; here manually.
1174 icomplete-with-completion-tables))))
1179 "Select the buffer specified by BUFFER-OR-NAME in another window.
1180 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1181 nil. Return the buffer switched to.
1183 If called interactively, prompt for the buffer name using the
1184 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1185 determines whether to request confirmation before creating a new
1186 buffer.
1188 If BUFFER-OR-NAME is a string and does not identify an existing
1189 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1190 nil, switch to the buffer returned by `other-buffer'.
1192 Optional second argument NORECORD non-nil means do not put this
1193 buffer at the front of the list of recently selected ones.
1195 This uses the function `display-buffer' as a subroutine; see its
1196 documentation for additional customization information."
1200 same-window-buffer-names same-window-regexps)
1204 "Switch to buffer BUFFER-OR-NAME in another frame.
1205 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1206 nil. Return the buffer switched to.
1208 If called interactively, prompt for the buffer name using the
1209 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1210 determines whether to request confirmation before creating a new
1211 buffer.
1213 If BUFFER-OR-NAME is a string and does not identify an existing
1214 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1215 nil, switch to the buffer returned by `other-buffer'.
1217 Optional second arg NORECORD non-nil means do not put this
1218 buffer at the front of the list of recently selected ones.
1220 This uses the function `display-buffer' as a subroutine; see its
1221 documentation for additional customization information."
1225 same-window-buffer-names same-window-regexps)
1229 "Display buffer BUFFER in another frame.
1230 This uses the function `display-buffer' as a subroutine; see
1231 its documentation for additional customization information."
1234 same-window-buffer-names same-window-regexps
1236 new-window)
1238 ;; This may have been here in order to prevent the new frame from hiding
1239 ;; the old frame. But it does more harm than good.
1240 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1241 ;;(lower-frame (window-frame new-window))
1243 ;; This may have been here in order to make sure the old-frame gets the
1244 ;; focus. But not only can it cause an annoying flicker, with some
1245 ;; window-managers it just makes the window invisible, with no easy
1246 ;; way to recover it. --Stef
1247 ;;(make-frame-invisible (window-frame old-window))
1248 ;;(make-frame-visible (window-frame old-window))
1249 ))
1255 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1256 BODY should use the minibuffer at most once.
1257 Recursive uses of the minibuffer will not be affected."
1263 ;; Clear out this hook so it does not interfere
1264 ;; with any recursive minibuffer usage.
1280 t))
1283 "Edit file FILENAME.
1284 Switch to a buffer visiting file FILENAME,
1285 creating one if none already exists.
1286 Interactively, the default if you just type RET is the current directory,
1287 but the visited file name is available through the minibuffer history:
1288 type M-n to pull it into the minibuffer.
1290 You can visit files on remote machines by specifying something
1291 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1292 also visit local files as a different user by specifying
1293 /sudo::FILE for the file name.
1294 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1295 manual, for more about this.
1297 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1298 expand wildcards (if any) and visit multiple files. You can
1299 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1301 To visit a file without any kind of conversion and without
1312 "Edit file FILENAME, in another window.
1315 an existing one. See the function `display-buffer'.
1317 Interactively, the default if you just type RET is the current directory,
1318 but the visited file name is available through the minibuffer history:
1319 type M-n to pull it into the minibuffer.
1321 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1322 expand wildcards (if any) and visit multiple files."
1335 "Edit file FILENAME, in another frame.
1338 an existing one. See the function `display-buffer'.
1340 Interactively, the default if you just type RET is the current directory,
1341 but the visited file name is available through the minibuffer history:
1342 type M-n to pull it into the minibuffer.
1344 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1345 expand wildcards (if any) and visit multiple files."
1358 "Edit the existing file FILENAME.
1360 file names with wildcards."
1368 "Edit file FILENAME but don't allow changes.
1382 value))
1385 "Edit file FILENAME in another window but don't allow changes.
1399 value))
1402 "Edit file FILENAME in another frame but don't allow changes.
1416 value))
1419 "Find file FILENAME as a replacement for the file in the next window.
1420 This command does not select that window.
1424 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1425 expand wildcards (if any) and replace the file with multiple files."
1437 t))))
1445 "Find file FILENAME, select its buffer, kill previous buffer.
1446 If the current buffer now contains an empty file that you just visited
1447 \(presumably by mistake), use this command to visit the file you really want.
1451 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1452 expand wildcards (if any) and replace the file with multiple files.
1454 If the current buffer is an indirect buffer, or the base buffer
1455 for one or more indirect buffers, the other buffer(s) are not
1456 killed."
1466 t)))
1487 ;; This prevents us from finding the same buffer
1488 ;; if we specified the same file again.
1492 ;; Likewise for dired buffers.
1496 ;; This executes if find-file gets an error
1497 ;; and does not really find anything.
1498 ;; We put things back as they were.
1499 ;; If find-file actually finds something, we kill obuf below.
1508 ;; We already asked; don't ask again.
1511 \f
1513 "Create a suitably named buffer for visiting FILENAME, and return it.
1514 FILENAME (sans directory) is used unchanged if that name is free;
1515 otherwise a string <2> or <3> or ... is appended to get an unused name.
1516 Spaces at the start of FILENAME (sans directory) are removed."
1525 "Create and return a buffer with a name based on NAME.
1526 Choose the buffer's name using `generate-new-buffer-name'."
1530 "Regexp to match the automounter prefix in a directory name."
1538 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1540 home directory is a root directory) and removes automounter prefixes
1541 \(see the variable `automount-dir-prefix')."
1542 ;; Get rid of the prefixes added by the automounter.
1549 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1550 ;; To fix this right, we need a `file-name-case-sensitive-p'
1551 ;; function, but we don't have that yet, so just guess.
1554 ;; If any elt of directory-abbrev-alist matches this name,
1555 ;; abbreviate accordingly.
1561 ;; Compute and save the abbreviated homedir name.
1562 ;; We defer computing this until the first time it's needed, to
1563 ;; give time for directory-abbrev-alist to be set properly.
1564 ;; We include a slash at the end, to avoid spurious matches
1565 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1572 ;; If FILENAME starts with the abbreviated homedir,
1573 ;; make it start with `~' instead.
1575 ;; If the home dir is just /, don't change it.
1578 ;; MS-DOS root directories can come with a drive letter;
1579 ;; Novell Netware allows drive letters beyond `Z:'.
1589 filename)))
1592 "List of logical names for which visiting shouldn't save the true dirname."
1597 "Return the buffer visiting file FILENAME (a string).
1598 This is like `get-file-buffer', except that it checks for any buffer
1599 visiting the same file, possibly under a different name.
1600 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1601 and others are ignored.
1602 If there is no such live buffer, return nil."
1616 found)
1626 ;; Verify this buffer's file number
1627 ;; still belongs to its file.
1630 attributes)
1634 found))))
1635 \f
1637 "Non-nil means file-visiting commands should handle wildcards.
1638 For example, if you specify `*.c', that would visit all the files
1639 whose names match the pattern."
1645 "Non-nil means suppress warning messages for symlinked files.
1646 When nil, Emacs prints a warning when visiting a file that is already
1647 visited, but with a different name. Setting this option to t
1648 suppresses this warning."
1654 "Maximum size of file above which a confirmation is requested.
1655 When nil, never request confirmation."
1662 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1663 OP-TYPE specifies the file operation being performed (for message to user)."
1673 "Read file FILENAME into a buffer and return the buffer.
1674 If a buffer exists visiting FILENAME, return that one, but
1675 verify that the file has not changed since visited or saved.
1676 The buffer is not selected, just returned to the caller.
1677 Optional second arg NOWARN non-nil means suppress any warning messages.
1678 Optional third arg RAWFILE non-nil means the file is read literally.
1679 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1680 and visit all the matching files. When wildcards are actually
1681 used and expanded, return a list of buffers that are visiting
1682 the various files."
1689 'find-directory-functions
1692 filename)))
1695 find-file-wildcards
1709 ;; Find any buffer for a file which has same truename.
1711 ;; Let user know if there is a buffer with the same truename.
1715 find-file-suppress-same-file-warnings
1719 ;; Optionally also find that buffer.
1722 ;; Check to see if the file looks uncommonly large.
1726 ;; We are using an existing buffer.
1733 ;; Certain files should be reverted automatically
1734 ;; if they have changed on disk and not in the buffer.
1742 found))
1752 "File %s changed on disk. Discard your edits? "
1757 "File %s changed on disk. Discard your edits in %s? "
1765 ;; Check if a formerly read-only file has become
1766 ;; writable and vice versa, but if the buffer agrees
1767 ;; with the new state of the file, that is ok too.
1775 buffer-file-name
1784 ;; It is confusing to ask whether to visit
1785 ;; non-literally if they have the file in
1786 ;; hexl-mode.
1792 "The file %s is already visited normally,
1793 and you have edited the buffer. Now you have asked to visit it literally,
1794 meaning no coding system handling, format conversion, or local variables.
1795 Emacs can only visit a file in one way at a time.
1797 Do you want to save the file, and visit it literally instead? "
1798 "The file %s is already visited literally,
1799 meaning no coding system handling, format conversion, or local variables.
1800 You have edited the buffer. Now you have asked to visit the file normally,
1801 but Emacs can only visit a file in one way at a time.
1808 rawfile truename number))
1812 "\
1813 Do you want to discard your changes, and visit the file literally now? "
1814 "\
1817 rawfile truename number)
1823 "The file %s is already visited normally.
1824 You have asked to visit it literally,
1825 meaning no coding system decoding, format conversion, or local variables.
1826 But Emacs can only visit a file in one way at a time.
1828 Do you want to revisit the file literally now? "
1829 "The file %s is already visited literally,
1830 meaning no coding system decoding, format conversion, or local variables.
1831 You have asked to visit it normally,
1832 but Emacs can only visit a file in one way at a time.
1837 rawfile truename number)
1840 ;; Return the buffer we are using.
1841 buf)
1842 ;; Create a new buffer.
1844 ;; find-file-noselect-1 may use a different buffer.
1846 rawfile truename number))))))
1852 ;; Needed in case we are re-visiting the file with a different
1853 ;; text representation.
1870 filename)))
1871 ;; Unconditionally set error
1881 filename)))
1882 ;; Run find-file-not-found-functions until one returns non-nil.
1884 ;; If they fail too, set error.
1886 ;; Record the file's truename, and maybe use that as visited name.
1894 ;; Set buffer's default directory to that of the file.
1896 ;; Turn off backup files for certain file names. Since
1897 ;; this is a permanent local, the major mode won't eliminate it.
1912 \f
1914 "Like `insert-file-contents', but only reads in the file literally.
1915 A buffer may be modified in several ways after reading into the buffer,
1916 to Emacs features such as format decoding, character code
1917 conversion, `find-file-hook', automatic uncompression, etc.
1919 This function ensures that none of these modifications will take place."
1927 nil))
1930 inhibit-file-name-handlers))
1943 filename)))
1944 ;; Check whether the file is uncommonly large
1955 "Insert contents of file FILENAME into buffer after point with no conversion.
1957 This function is meant for the user to run interactively.
1958 Don't call it from programs! Use `insert-file-contents-literally' instead.
1959 \(Its calling sequence is different; see its documentation)."
1964 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1969 "Visit file FILENAME with no conversion of any kind.
1970 Format conversion and character code conversion are both disabled,
1971 and multibyte characters are disabled in the resulting buffer.
1972 The major mode used is Fundamental mode regardless of the file name,
1973 and local variable specifications in the file are ignored.
1974 Automatic uncompression and adding a newline at the end of the
1975 file due to `require-final-newline' is also disabled.
1977 You cannot absolutely rely on this function to result in
1978 visiting the file literally. If Emacs already has a buffer
1979 which is visiting the file, you get the existing buffer,
1980 regardless of whether it was created literally or not.
1982 In a Lisp program, if you want to be sure of accessing a file's
1983 contents literally, you should create a temporary buffer and then read
1984 the file contents into it using `insert-file-contents-literally'."
1987 \f
1991 after-find-file-from-revert-buffer
1992 nomodes)
1993 "Called after finding a file and by the default revert function.
1994 Sets buffer mode, parses local variables.
1995 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1996 error in reading the file. WARN non-nil means warn if there
1997 exists an auto-save file more recent than the visited file.
1998 NOAUTO means don't mess with auto-save mode.
1999 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2000 means this call was from `revert-buffer'.
2001 Fifth arg NOMODES non-nil means don't alter the file's modes.
2002 Finishes by calling the functions in `find-file-hook'
2003 unless NOMODES is non-nil."
2006 nil
2016 ;; No need to warn if buffer is auto-saved
2017 ;; under the name of the visited file.
2019 auto-save-visited-file-name))
2022 buffer-file-name))
2042 ;; Make people do a little extra work (C-x C-q)
2043 ;; before altering a backup file.
2046 ;; When a file is marked read-only,
2047 ;; make the buffer read-only even if root is looking at it.
2055 ;; If requested, add a newline at the end of the file.
2065 view-read-only
2071 "Eval BODY and turn any error into a FORMAT message.
2072 FORMAT can have a %s escape which will be replaced with the actual error.
2073 If `debug-on-error' is set, errors are not caught, so that you can
2074 debug them.
2075 Avoid using a large BODY since it is duplicated."
2084 "Choose the major mode for this buffer automatically.
2085 Also sets up any specified local variables of the file.
2086 Uses the visited file name, the -*- line, and the local variables spec.
2088 This function is called automatically from `find-file'. In that case,
2089 we may set up the file-specified mode and local variables,
2090 depending on the value of `enable-local-variables'.
2091 In addition, if `local-enable-local-variables' is nil, we do
2092 not set local variables (though we do notice a mode specified with -*-.)
2094 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2095 or from Lisp without specifying the optional argument FIND-FILE;
2096 in that case, this function acts as if `enable-local-variables' were t."
2104 ;; Turn font lock off and on, to make sure it takes account of
2105 ;; whatever file local variables are relevant to it.
2107 ;; Font-lock-mode (now in font-core.el) can be ON when
2108 ;; font-lock.el still hasn't been loaded.
2118 "Non-nil means to try second pass through `auto-mode-alist'.
2119 This means that if the first case-sensitive search through the alist fails
2120 to find a matching major mode, a second case-insensitive search is made.
2121 On systems with case-insensitive file names, this variable is ignored,
2122 since only a single case-insensitive search through the alist is made."
2128 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2129 ;; c++-mode, java-mode and more) are added through autoload
2130 ;; directives in that file. That way is discouraged since it
2131 ;; spreads out the definition of the initial value.
2164 ;; Less common extensions come here
2165 ;; so more common ones above are found faster.
2204 ;; The list of archive file extensions should be in sync with
2205 ;; `auto-coding-alist' with `no-conversion' coding system.
2211 ;; Mailer puts message to be edited in
2212 ;; /tmp/Re.... or Message
2216 ;; some news reader is reported to use this
2225 ;; .emacs or .gnus or .viper following a directory delimiter in
2226 ;; Unix, MSDOG or VMS syntax.
2229 ;; _emacs following a directory delimiter
2230 ;; in MsDos syntax
2234 ;; Common Lisp ASDF package system.
2253 ;; Windows candidates may be opened case sensitively on Unix
2259 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2261 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2262 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2263 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2264 ;; this has lower priority to avoid matching changelog.sgml etc.
2266 ;; either user's dot-files or under /etc or some such
2268 ;; alas not all ~/.*rc files are like this
2269 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2274 ;; this contains everything twice, with space and with colon :-(
2276 ;; Get rid of any trailing .n.m and try again.
2277 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2278 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2279 ;; Using mode nil rather than `ignore' would let the search continue
2280 ;; through this list (with the shortened name) rather than start over.
2282 ;; The following should come after the ChangeLog pattern
2283 ;; for the sake of ChangeLog.1, etc.
2284 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2287 "Alist of filename patterns vs corresponding major mode functions.
2288 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2289 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2290 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2291 mode function to use. FUNCTION will be called, unless it is nil.
2293 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2294 calling FUNCTION (if it's not nil), we delete the suffix that matched
2295 REGEXP and search the list again for another match.
2297 If the file name matches `inhibit-first-line-modes-regexps',
2298 then `auto-mode-alist' is not processed.
2300 The extensions whose FUNCTION is `archive-mode' should also
2301 appear in `auto-coding-alist' with `no-conversion' coding system.
2303 See also `interpreter-mode-alist', which detects executable script modes
2304 based on the interpreters they specify to run,
2308 "Select Conf mode or XML mode according to start of file."
2318 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2319 ;; and pike-mode) are added through autoload directives in that
2320 ;; file. That way is discouraged since it spreads out the
2321 ;; definition of the initial value.
2359 "Alist mapping interpreter names to major modes.
2360 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2361 Each element looks like (INTERPRETER . MODE).
2362 If INTERPRETER matches the name of the interpreter specified in the first line
2363 of a script, mode MODE is enabled.
2371 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2372 When checking `inhibit-first-line-modes-regexps', we first discard
2378 "Regexp matching interpreters, for file mode determination.
2379 This regular expression is matched against the first line of a file
2380 to determine the file's mode in `set-auto-mode'. If it matches, the file
2381 is assumed to be interpreted by the interpreter matched by the second group
2382 of the regular expression. The mode is then determined as the mode
2386 "Alist of buffer beginnings vs. corresponding major mode functions.
2387 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2388 After visiting a file, if REGEXP matches the text at the beginning of the
2389 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2390 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2391 major mode.
2393 If FUNCTION is nil, then it is not called. (That is a way of saying
2399 ;; The < comes before the groups (but the first) to reduce backtracking.
2400 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2401 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2405 comment-re "*"
2408 . html-mode)
2410 ;; These two must come after html, because they are more general:
2415 . sgml-mode)
2418 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2419 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2420 After visiting a file, if REGEXP matches the text at the beginning of the
2421 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2422 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2423 have not specified a mode for this file.
2429 "Upper limit on `magic-mode-alist' regexp matches.
2433 "Select major mode appropriate for current buffer.
2435 To find the right major mode, this function checks for a -*- mode tag,
2436 checks if it uses an interpreter listed in `interpreter-mode-alist',
2437 matches the buffer beginning against `magic-mode-alist',
2438 compares the filename against the entries in `auto-mode-alist',
2439 then matches the buffer beginning against `magic-fallback-mode-alist'.
2441 It does not check for the `mode:' local variable in the
2442 Local Variables section of the file; for that, use `hack-local-variables'.
2444 If `enable-local-variables' is nil, this function does not check for a
2445 -*- mode tag.
2447 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2448 set the major mode only if that would change it. In other words
2449 we don't actually set it to the same mode the buffer already has."
2450 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2452 ;; Find a -*- mode tag
2459 ;; Find all specifications for the `mode:' variable
2460 ;; and execute them left to right.
2472 modes)))
2473 ;; Simple -*-MODE-*- case.
2476 modes))))
2477 ;; If we found modes to use, invoke them now, outside the save-excursion.
2485 ;; continuing would call minor modes again, toggling them off
2487 ;; If we didn't, look for an interpreter specified in the first line.
2488 ;; As a special case, allow for things like "#!/bin/env perl", which
2489 ;; finds the interpreter anywhere in $PATH.
2496 ;; Map interpreter name to a mode, signalling we're done at the
2497 ;; same time.
2499 interpreter-mode-alist))
2500 ;; If we found an interpreter mode to use, invoke it now.
2503 ;; Next try matching the buffer beginning against magic-mode-alist.
2517 ;; Next compare the filename against the entries in auto-mode-alist.
2522 ;; Remove remote file name identification.
2526 ;; Remove backup-suffixes from file name.
2529 ;; Find first matching alist entry.
2532 ;; System is case-insensitive.
2536 ;; System is case-sensitive.
2538 ;; First match case-sensitively.
2542 ;; Fallback to case-insensitive match.
2556 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2571 ;; When `keep-mode-if-same' is set, we are working on behalf of
2572 ;; set-visited-file-name. In that case, if the major mode specified is the
2573 ;; same one we already have, don't actually reset it. We don't want to lose
2574 ;; minor modes such as Font Lock.
2576 "Apply MODE and return it.
2577 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2578 any aliases and compared to current major mode. If they are the
2579 same, do nothing and return nil."
2585 mode)))
2588 "Find the -*- spec in the buffer.
2589 Call with point at the place to start searching from.
2590 If one is found, set point to the beginning
2591 and return the position of the end.
2592 Otherwise, return nil; point may be changed."
2595 ;; Don't look for -*- if this file name matches any
2596 ;; of the regexps in inhibit-first-line-modes-regexps.
2604 sufs)
2612 ;; If the file begins with "#!"
2613 ;; (exec interpreter magic), look
2614 ;; for mode frobs in the first two
2615 ;; lines. You cannot necessarily
2616 ;; put them in the first line of
2617 ;; such a file without screwing up
2618 ;; the interpreter invocation.
2619 ;; The same holds for
2620 ;; '\"
2621 ;; in man pages (preprocessor
2622 ;; magic for the `man' program).
2633 end))))
2634 \f
2635 ;;; Handling file local variables
2639 file-local-variables-alist)
2643 "Normal hook run after processing a file's local variables specs.
2644 Major modes can use this to examine user-specified local variables
2648 "List variable-value pairs that are considered safe.
2649 Each element is a cons cell (VAR . VAL), where VAR is a variable
2650 symbol and VAL is a value that is considered safe."
2655 "Expressions that are considered safe in an `eval:' local variable.
2656 Add expressions to this list if you want Emacs to evaluate them, when
2657 they appear in an `eval' local variable specification, without first
2658 asking you for confirmation."
2663 ;; Risky local variables:
2666 auto-mode-alist
2667 buffer-auto-save-file-name
2668 buffer-file-name
2669 buffer-file-truename
2670 buffer-undo-list
2671 dabbrev-case-fold-search
2672 dabbrev-case-replace
2673 debugger
2674 default-text-properties
2675 display-time-string
2676 enable-local-eval
2677 enable-local-variables
2678 eval
2679 exec-directory
2680 exec-path
2681 file-name-handler-alist
2682 font-lock-defaults
2683 format-alist
2684 frame-title-format
2685 global-mode-string
2686 header-line-format
2687 icon-title-format
2688 ignored-local-variables
2689 imenu--index-alist
2690 imenu-generic-expression
2691 inhibit-quit
2692 input-method-alist
2693 load-path
2694 max-lisp-eval-depth
2695 max-specpdl-size
2696 minor-mode-alist
2697 minor-mode-map-alist
2698 minor-mode-overriding-map-alist
2699 mode-line-buffer-identification
2700 mode-line-format
2701 mode-line-client
2702 mode-line-modes
2703 mode-line-modified
2704 mode-line-mule-info
2705 mode-line-position
2706 mode-line-process
2707 mode-line-remote
2708 mode-name
2709 outline-level
2710 overriding-local-map
2711 overriding-terminal-local-map
2712 parse-time-rules
2713 process-environment
2714 rmail-output-file-alist
2715 safe-local-variable-values
2716 safe-local-eval-forms
2717 save-some-buffers-action-alist
2718 special-display-buffer-names
2719 standard-input
2720 standard-output
2721 unread-command-events
2722 vc-mode))
2724 ;; Safe local variables:
2725 ;;
2726 ;; For variables defined by major modes, the safety declarations can go into
2727 ;; the major mode's file, since that will be loaded before file variables are
2728 ;; processed.
2729 ;;
2730 ;; For variables defined by minor modes, put the safety declarations in the
2731 ;; file defining the minor mode after the defcustom/defvar using an autoload
2732 ;; cookie, e.g.:
2733 ;;
2734 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2735 ;;
2736 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2737 ;; minor mode file may not be loaded yet.
2738 ;;
2739 ;; For variables defined in the C source code the declaration should go here:
2755 "Alist of file-local variable settings in the current buffer.
2756 Each element in this list has the form (VAR . VALUE), where VAR
2757 is a file-local variable (a symbol) and VALUE is the value
2758 specified. The actual value in the buffer may differ from VALUE,
2763 "Normal hook run before setting file-local variables.
2764 It is called after checking for unsafe/risky variables and
2765 setting `file-local-variables-alist', and before applying the
2766 variables stored in `file-local-variables-alist'. A hook
2767 function is allowed to change the contents of this alist.
2769 This hook is called only if there is at least one file-local
2773 "Get confirmation before setting up local variable values.
2774 ALL-VARS is the list of all variables to be set up.
2775 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2776 RISKY-VARS is the list of those that are marked as risky.
2777 DIR-NAME is a directory name if these settings come from
2778 directory-local variables, or nil otherwise."
2780 nil
2786 prompt char)
2796 ", and variables that are risky (**)."
2803 y -- to apply the local variables list.
2807 ! -- to apply the local variables list, and permanently mark these
2819 ;; Make strings with embedded whitespace easier to read.
2827 ""
2834 done)
2843 ;; read-event returns -1 if we are in a kbd
2844 ;; macro and there are no more events in the
2845 ;; macro. In that case, attempt to get an
2846 ;; event interactively.
2854 ;; When this is called from desktop-restore-file-buffer,
2855 ;; coding-system-for-read may be non-nil. Reset it before
2856 ;; writing to .emacs.
2860 'safe-local-variable-values
2861 safe-local-variable-values))))
2868 "Return local variables specified in the -*- line.
2869 Ignore any specification for `mode:' and `coding:';
2870 `set-auto-mode' should already have handled `mode:',
2871 `set-auto-coding' should already have handled `coding:'.
2873 If MODE-ONLY is non-nil, all we do is check whether the major
2874 mode is specified, returning t if it is specified. Otherwise,
2875 return an alist of elements (VAR . VAL), where VAR is a variable
2876 and VAL is the specified value."
2880 result mode-specified)
2881 ;; Parse the -*- line into the RESULT alist.
2882 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2884 nil)
2886 ;; Simple form: "-*- MODENAME -*-". Already handled.
2888 nil)
2890 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2891 ;; (last ";" is optional).
2896 ;; There used to be a downcase here,
2897 ;; but the manual didn't say so,
2898 ;; and people want to set var names that aren't all lc.
2903 ;; It is traditional to ignore
2904 ;; case when checking for `mode' in set-auto-mode,
2905 ;; so we must do that here as well.
2906 ;; That is inconsistent, but we're stuck with it.
2907 ;; The same can be said for `coding' in set-auto-coding.
2913 'eval
2920 mode-specified
2921 result))))
2924 "Filter local variable settings, querying the user if necessary.
2925 VARIABLES is the alist of variable-value settings. This alist is
2926 filtered based on the values of `ignored-local-variables',
2927 `enable-local-eval', `enable-local-variables', and (if necessary)
2928 user interaction. The results are added to
2929 `file-local-variables-alist', without applying them.
2930 DIR-NAME is a directory name if these settings come from
2931 directory-local variables, or nil otherwise."
2932 ;; Strip any variables that are in `ignored-local-variables'.
2935 ;; If `enable-local-eval' is nil, strip eval "variables".
2940 ;; Find those variables that we may want to save to
2941 ;; `safe-local-variable-values'.
2946 ;; Don't query about the fake variables.
2957 ;; If caller wants only safe variables, store only these.
2962 ;; Query, unless all are known safe or the user wants no
2963 ;; querying.
2969 variables unsafe-vars risky-vars dir-name))
2974 "Parse and put into effect this buffer's local variables spec.
2975 If MODE-ONLY is non-nil, all we do is check whether the major mode
2976 is specified, returning t if it is specified."
2979 result)
2986 ;; Look for "Local variables:" line in last page.
2994 ;; suffix is what comes after "local variables:" in its line.
2995 ;; prefix is what comes before "local variables:" in its line.
3005 beg)
3009 endpos
3015 nil t))
3016 ;; This used to be an error, but really all it means is
3017 ;; that this may simply not be a local-variables section,
3018 ;; so just ignore it.
3028 ;; Discard the prefix.
3033 ;; Discard the suffix.
3041 ;; Find the variable name; strip whitespace.
3049 val)
3050 ;; Read the variable value.
3060 'eval
3065 ;; Now we've read all the local variables.
3066 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3068 ;; Otherwise, set the variables.
3080 "Non-nil if SYM is safe as a file-local variable with value VAL.
3081 It is safe if any of these conditions are met:
3083 * There is a matching entry (SYM . VAL) in the
3084 `safe-local-variable-values' user option.
3086 * The `safe-local-variable' property of SYM is a function that
3087 evaluates to a non-nil value with VAL as an argument."
3093 "Non-nil if SYM could be dangerous as a file-local variable.
3094 It is dangerous if either of these conditions are met:
3096 * Its `risky-local-variable' property is non-nil.
3102 ;; If this is an alias, check the base name.
3122 "Return t if it is safe to eval EXP when it is found in a file."
3124 ;; Detect certain `put' expressions.
3131 lisp-indent-function
3132 scheme-indent-function))
3133 ;; Only allow safe values (not functions).
3138 ;; Only allow indirect form specs.
3139 ;; During bootstrapping, edebug-basic-spec might not be
3140 ;; defined yet.
3144 ;; Allow expressions that the user requested.
3146 ;; Certain functions can be allowed with safe arguments
3147 ;; or can specify verification functions to try.
3155 ok))
3163 ok)))))))
3166 "Set local variable VAR with value VAL.
3167 If VAR is `mode', call `VAL-mode' as a function unless it's
3168 already the major mode."
3178 ;; Make sure the string has no text properties.
3179 ;; Some text properties can get evaluated in various ways,
3180 ;; so it is risky to put them on with a local variable list.
3184 \f
3185 ;;; Handling directory-local variables, aka project settings.
3194 "Return the variable list for CLASS."
3198 "Collect directory-local variables from MODE-VARIABLES.
3199 VARIABLES is the initial list of variables.
3200 Returns the new list."
3207 ;; Need a new cons in case we setcdr later.
3211 "Collect entries from CLASS-VARIABLES into VARIABLES.
3212 ROOT is the root directory of the project.
3213 Return the new variables list."
3221 ;; Don't include this in the previous condition, because we
3222 ;; want to filter all strings before the next condition.
3234 "Declare that the DIRECTORY root is an instance of CLASS.
3235 DIRECTORY is the name of a directory, a string.
3236 CLASS is the name of a project class, a symbol.
3238 When a file beneath DIRECTORY is visited, the mode-specific
3239 variables from CLASS will be applied to the buffer. The variables
3240 for a class are defined using `dir-locals-set-class-variables'."
3247 "Map the type CLASS to a list of variable settings.
3248 CLASS is the project class, a symbol. VARIABLES is a list
3249 that declares directory-local variables for the class.
3250 An element in VARIABLES is either of the form:
3251 (MAJOR-MODE . ALIST)
3252 or
3253 (DIRECTORY . LIST)
3255 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3256 whose elements are of the form (VARIABLE . VALUE).
3258 In the second form, DIRECTORY is a directory name (a string), and
3259 LIST is a list of the form accepted by the function.
3261 When a file is visited, the file's class is found. A directory
3262 may be assigned a class using `dir-locals-set-directory-class'.
3263 Then variables are set in the file's buffer according to the
3264 class' LIST. The list is processed in order.
3266 * If the element is of the form (MAJOR-MODE . ALIST), and the
3267 buffer's major mode is derived from MAJOR-MODE (as determined
3268 by `derived-mode-p'), then all the variables in ALIST are
3269 applied. A MAJOR-MODE of nil may be used to match any buffer.
3270 `make-local-variable' is called for each variable before it is
3271 set.
3273 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3274 is an initial substring of the file's directory, then LIST is
3275 applied by recursively following these rules."
3282 "File that contains directory-local variables.
3283 It has to be constant to enforce uniform values
3287 "Find the directory-local variables FILE.
3288 This searches upward in the directory tree.
3289 If a local variables file is found, the file name is returned.
3290 If the file is already registered, a cons from
3291 `dir-locals-directory-alist' is returned.
3292 Otherwise this returns nil."
3297 dir-locals-file))
3300 ;; `locate-dominating-file' may have abbreviated the name.
3313 locals-file
3314 dir-elt)
3318 "Load a variables FILE and register a new class and instance.
3319 FILE is the name of the file holding the variables to apply.
3320 The new class name is the same as the directory in which FILE
3321 is found. Returns the new class name."
3323 ;; We should probably store the modtime of FILE and then
3324 ;; reload it whenever it changes.
3331 class-name)))
3336 "Read per-directory local variables for the current buffer.
3337 Store the directory-local variables in `file-local-variables-alist',
3338 without applying them."
3342 ;; Find the variables file.
3360 \f
3363 However, the mode will not be changed if
3364 \(1) a local variables list or the `-*-' line specifies a major mode, or
3366 \ not suitable for ordinary files, or
3367 \(3) the new file name does not particularly specify any mode."
3372 "Change name of file visited in current buffer to FILENAME.
3373 This also renames the buffer to correspond to the new file.
3374 The next time the buffer is saved it will go in the newly specified file.
3375 FILENAME nil or an empty string means mark buffer as not visiting any file.
3376 Remember to delete the initial contents of the minibuffer
3377 if you wish to pass an empty string as the argument.
3379 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3380 confirmation in the case where another buffer is already visiting FILENAME.
3382 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3383 the old visited file has been renamed to the new name FILENAME."
3391 nil
3406 filename)))
3416 ;; If new-name == old-name, renaming would add a spurious <2>
3417 ;; and it's considered as a feature in rename-buffer.
3423 ;; Abbreviate the file names of the buffer.
3432 nil)))
3433 ;; write-file-functions is normally used for things like ftp-find-file
3434 ;; that visit things that are not local files as if they were files.
3435 ;; Changing to visit an ordinary local file instead should flush the hook.
3440 ;; If buffer was read-only because of version control,
3441 ;; that reason is gone now, so make it writable.
3445 ;; Turn off backup files for certain file names.
3446 ;; Since this is a permanent local, the major mode won't eliminate it.
3448 backup-enable-predicate
3454 ;; If auto-save was not already on, turn it on if appropriate.
3458 ;; If auto save is on, start using a new name.
3459 ;; We deliberately don't rename or delete the old auto save
3460 ;; for the old visited file name. This is because perhaps
3461 ;; the user wants to save the new state and then compare with the
3462 ;; previous state from the auto save file.
3465 ;; Rename the old auto save file if any.
3472 ;; Update the major mode, if the file name determines it.
3474 ;; Don't change the mode if it is special.
3477 ;; Don't change the mode if the local variable list specifies it.
3483 "Write current buffer into file FILENAME.
3484 This makes the buffer visit that file, and marks it as not modified.
3486 If you specify just a directory name as FILENAME, that means to use
3487 the default file name but in that directory. You can also yank
3488 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3490 If the buffer is not already visiting a file, the default file name
3491 for the output file is the buffer name.
3493 If optional second arg CONFIRM is non-nil, this function
3494 asks for confirmation before overwriting an existing file.
3495 Interactively, confirmation is required unless you supply a prefix argument."
3496 ;; (interactive "FWrite file: ")
3500 nil nil nil nil)
3504 default-directory)
3505 nil nil))
3509 ;; If arg is just a directory,
3510 ;; use the default file name, but in that directory.
3521 ;; Make buffer writable if file is writable.
3526 ;; It's likely that the VC status at the new location is different from
3527 ;; the one at the old location.
3529 \f
3531 "Make a backup of the disk file visited by the current buffer, if appropriate.
3532 This is normally done before saving the buffer the first time.
3534 A backup may be done by renaming or by copying; see documentation of
3535 variable `make-backup-files'. If it's done by renaming, then the file is
3536 no longer accessible under its old name.
3538 The value is non-nil after a backup was made by renaming.
3539 It has the form (MODES . BACKUPNAME).
3540 MODES is the result of `file-modes' on the original
3541 file; this means that the caller, after saving the buffer, should change
3542 the modes of the new file to agree with the old modes.
3543 BACKUPNAME is the backup file name, which is the old file renamed."
3550 backup-info backupname targets setmodes)
3551 ;; If specified name is a symbolic link, chase it to the target.
3552 ;; Thus we make the backups in the directory where the real file is.
3557 ;; (if (file-directory-p buffer-file-name)
3558 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3562 ;; If have old versions to maybe delete,
3563 ;; ask the user to confirm now, before doing anything.
3564 ;; But don't actually delete til later.
3569 real-file-name)))))
3571 ;; Actually write the back up file.
3574 ; (file-symlink-p buffer-file-name)
3575 backup-by-copying
3576 ;; Don't rename a suid or sgid file.
3591 ;; rename-file should delete old backup.
3595 ;; If trouble writing the backup, write it in ~.
3600 backupname)
3604 ;; Now delete the old versions, if desired.
3611 setmodes)
3618 ;; Create temp files with strict access rights. It's easy to
3619 ;; loosen them later, whereas it's impossible to close the
3620 ;; time-window of loose permissions otherwise.
3623 ;; Try to overwrite old backup first.
3631 nil)
3633 ;; The file was somehow created by someone else between
3634 ;; `delete-file' and `copy-file', so let's try again.
3635 ;; rms says "I think there is also a possible race
3636 ;; condition for making backup files" (emacs-devel 20070821).
3637 nil)))
3638 ;; Reset the umask.
3644 "Return file NAME sans backup versions or strings.
3645 This is a separate procedure so your site-init or startup file can
3646 redefine it.
3647 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3648 we do not remove backup version numbers, only true file version numbers."
3660 "Return t if deleting FILE and rewriting it would preserve the owner."
3665 ;; Return t if the file doesn't exist, since it's true that no
3666 ;; information would be lost by an (attempted) delete and create.
3672 The extension, in a file name, is the part that follows the last `.',
3673 except that a leading `.', if any, doesn't count."
3676 directory)
3680 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3681 ;; we don't want to expand it.
3684 filename))))
3688 The extension, in a file name, is the part that follows the last `.',
3689 excluding version numbers and backup suffixes,
3690 except that a leading `.', if any, doesn't count.
3691 Return nil for extensionless file names such as `foo'.
3692 Return the empty string for file names such as `foo.'.
3694 If PERIOD is non-nil, then the returned value includes the period
3695 that delimits the extension, and if FILENAME has no extension,
3706 "A function to use instead of the default `make-backup-file-name'.
3707 A value of nil gives the default `make-backup-file-name' behavior.
3709 This could be buffer-local to do something special for specific
3710 files. If you define it, you may need to change `backup-file-name-p'
3711 and `file-name-sans-versions' too.
3713 See also `backup-directory-alist'."
3719 "Alist of filename patterns and backup directory names.
3720 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3721 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3722 relative or absolute. If it is absolute, so that all matching files
3723 are backed up into the same directory, the file names in this
3724 directory will be the full name of the file backed up with all
3725 directory separators changed to `!' to prevent clashes. This will not
3726 work correctly if your filesystem truncates the resulting name.
3728 For the common case of all backups going into one directory, the alist
3730 directory name.
3732 If this variable is nil, or it fails to match a filename, the backup
3733 is made in the original file's directory.
3735 On MS-DOS filesystems without long names this variable is always
3736 ignored."
3742 "Default `backup-enable-predicate' function.
3743 Checks for files in `temporary-file-directory',
3744 `small-temporary-file-directory', and /tmp."
3747 ;; Directory is under temporary-file-directory.
3752 ;; Directory is under /tmp.
3757 0 nil
3759 ;; Directory is under small-temporary-file-directory.
3764 "Create the non-numeric backup file name for FILE.
3765 Normally this will just be the file's name with `~' appended.
3766 Customization hooks are provided as follows.
3768 If the variable `make-backup-file-name-function' is non-nil, its value
3769 should be a function which will be called with FILE as its argument;
3770 the resulting name is used.
3772 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3773 the documentation of that variable. If the directory for the backup
3774 doesn't exist, it is created."
3788 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3790 elt backup-directory abs-backup-directory)
3795 alist nil)))
3796 ;; If backup-directory is relative, it should be relative to the
3797 ;; file's directory. By expanding explicitly here, we avoid
3798 ;; depending on default-directory.
3807 abs-backup-directory nil))))
3809 file
3813 ;; Normalize DOSish file names: downcase the drive
3814 ;; letter, if any, and replace the leading "x:" with
3815 ;; "/drive_x".
3818 ;; Replace any invalid file-name characters (for the
3819 ;; case of backing up remote files).
3823 "drive_"
3826 ""
3829 ;; Make the name unique by substituting directory
3830 ;; separators. It may not really be worth bothering about
3831 ;; doubling `!'s in the original name...
3836 backup-directory))
3841 "Return non-nil if FILE is a backup file name (numeric or not).
3842 This is a separate function so you can redefine it for customization.
3843 You may need to redefine `file-name-sans-versions' as well."
3848 ;; This is used in various files.
3849 ;; The usage of backup-extract-version-start is not very clean,
3850 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3852 "Given the name of a numeric backup file, FN, return the backup number.
3853 Uses the free variable `backup-extract-version-start', whose value should be
3854 the index in the name where the version number begins."
3861 "Find a file name for a backup file FN, and suggestions for deletions.
3862 Value is a list whose car is the name for the backup file
3863 and whose cdr is a list of old versions to consider deleting now.
3864 If the value is nil, don't make a backup.
3865 Uses `backup-directory-alist' in the same way as does
3866 `make-backup-file-name'."
3868 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3872 ;; We don't support numbered backups on plain MS-DOS
3873 ;; when long file names are unavailable.
3883 possibilities deserve-versions-p versions)
3886 base-versions
3889 possibilities)
3890 #'<)
3895 kept-old-versions
3896 kept-new-versions
3903 ;; Delete nothing if there is overflow
3904 ;; in the number of versions to keep.
3910 v))))))))))
3913 "Return number of names file FILENAME has."
3916 ;; (defun file-relative-name (filename &optional directory)
3917 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3918 ;; This function returns a relative file name which is equivalent to FILENAME
3919 ;; when used with that default directory as the default.
3920 ;; If this is impossible (which can happen on MSDOS and Windows
3921 ;; when the file name and directory use different drive names)
3922 ;; then it returns FILENAME."
3923 ;; (save-match-data
3924 ;; (let ((fname (expand-file-name filename)))
3925 ;; (setq directory (file-name-as-directory
3926 ;; (expand-file-name (or directory default-directory))))
3927 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3928 ;; ;; drive names, they can't be relative, so return the absolute name.
3929 ;; (if (and (or (eq system-type 'ms-dos)
3930 ;; (eq system-type 'cygwin)
3931 ;; (eq system-type 'windows-nt))
3932 ;; (not (string-equal (substring fname 0 2)
3933 ;; (substring directory 0 2))))
3934 ;; filename
3935 ;; (let ((ancestor ".")
3936 ;; (fname-dir (file-name-as-directory fname)))
3937 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3938 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3939 ;; (setq directory (file-name-directory (substring directory 0 -1))
3940 ;; ancestor (if (equal ancestor ".")
3941 ;; ".."
3942 ;; (concat "../" ancestor))))
3943 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3944 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3945 ;; ;; We matched within FNAME's directory part.
3946 ;; ;; Add the rest of FNAME onto ANCESTOR.
3947 ;; (let ((rest (substring fname (match-end 0))))
3948 ;; (if (and (equal ancestor ".")
3949 ;; (not (equal rest "")))
3950 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3951 ;; rest
3952 ;; (concat (file-name-as-directory ancestor) rest)))
3953 ;; ;; We matched FNAME's directory equivalent.
3954 ;; ancestor))))))
3957 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3958 This function returns a relative file name which is equivalent to FILENAME
3959 when used with that default directory as the default.
3960 If FILENAME and DIRECTORY lie on different machines or on different drives
3961 on a DOS/Windows machine, it returns FILENAME in expanded form."
3965 default-directory))))
3971 ;; Test for different drives on DOS/Windows
3973 ;; Should `cygwin' really be included here? --stef
3976 ;; Test for different remote file system identification
3978 filename
3984 directory nil nil case-fold-search))
3986 directory nil nil case-fold-search))))
3989 ".."
3991 ;; Now ancestor is empty, or .., or ../.., etc.
3993 directory nil nil case-fold-search))
3994 ;; We matched within FILENAME's directory part.
3995 ;; Add the rest of FILENAME onto ANCESTOR.
3998 ;; But don't bother with ANCESTOR if it would give us `./'.
3999 rest
4001 ;; We matched FILENAME's directory equivalent.
4002 ancestor))))))
4003 \f
4005 "Save current buffer in visited file if modified.
4006 Variations are described below.
4008 By default, makes the previous version into a backup file
4009 if previously requested or if this is the first save.
4011 to become a backup when the next save is done.
4013 unconditionally makes the previous version into a backup file.
4015 to become a backup when the next save is done,
4016 and unconditionally makes the previous version into a backup file.
4018 With a numeric argument of 0, never make the previous version
4019 into a backup file.
4021 If a file's name is FOO, the names of its numbered backup versions are
4022 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4023 Numeric backups (rather than FOO~) will be made if value of
4024 `version-control' is not the atom `never' and either there are already
4025 numeric versions of the file being backed up, or `version-control' is
4026 non-nil.
4027 We don't want excessive versions piling up, so there are variables
4028 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4029 and `kept-new-versions', which tells how many newest versions to keep.
4030 Defaults are 2 old versions and 2 new.
4031 `dired-kept-versions' controls dired's clean-directory (.) command.
4032 If `delete-old-versions' is nil, system will query user
4033 before trimming versions. Otherwise it does it silently.
4035 If `vc-make-backup-files' is nil, which is the default,
4036 no backup files are made for files managed by version control.
4037 (This is because the version control system itself records previous versions.)
4039 See the subroutine `basic-save-buffer' for more information."
4045 ;; We used to display the message below only for files > 50KB, but
4046 ;; then Rmail-mbox never displays it due to buffer swapping. If
4047 ;; the test is ever re-introduced, be sure to handle saving of
4048 ;; Rmail files.
4055 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4056 Normally delete only if the file was written by this Emacs since
4057 the last real save, but optional arg FORCE non-nil means delete anyway."
4071 "Normal hook that is run before a buffer is saved to its file."
4077 "Normal hook that is run after a buffer is saved to its file."
4083 "If non-nil, use this coding system for saving the buffer.
4084 More precisely, use this coding system in place of the
4085 value of `buffer-file-coding-system', when saving the buffer.
4086 Calling `write-region' for any purpose other than saving the buffer
4087 will still use `buffer-file-coding-system'; this variable has no effect
4094 "Save the current buffer in its visited file, if it has been modified.
4095 The hooks `write-contents-functions' and `write-file-functions' get a chance
4096 to do the job of saving; if they do not, then the buffer is saved in
4097 the visited file in the usual way.
4098 Before and after saving the buffer, this function runs
4099 `before-save-hook' and `after-save-hook', respectively."
4102 ;; In an indirect buffer, save its base buffer instead.
4107 setmodes)
4108 ;; If buffer has no file name, ask user for one.
4115 ;; Signal an error if the user specified the name of an
4116 ;; existing directory.
4119 filename))
4121 ;; Signal an error if the specified name refers to a
4122 ;; non-existing directory.
4152 ;; Support VC version backups.
4158 ;; If a hook returned t, file is already "written".
4159 ;; Otherwise, write it the usual way now.
4161 ;; Now we have saved the current buffer. Let's make sure
4162 ;; that buffer-file-coding-system is fixed to what
4163 ;; actually used for saving by binding it locally.
4173 ;; If the auto-save file was recent before this command,
4174 ;; delete it now.
4176 ;; Support VC `implicit' locking.
4181 ;; This does the "real job" of writing a buffer into its visited file
4182 ;; and making a backup file. This is what is normally done
4183 ;; but inhibited if one of write-file-functions returns non-nil.
4184 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4196 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4210 buffer-file-name)))
4224 ;; Write temp name, then rename it.
4225 ;; This requires write access to the containing dir,
4226 ;; which is why we don't try it if we don't have that access.
4228 tempname succeed
4231 ;; Create temp files with strict access rights. It's easy to
4232 ;; loosen them later, whereas it's impossible to close the
4233 ;; time-window of loose permissions otherwise.
4238 ;; Try various temporary names.
4239 ;; This code follows the example of make-temp-file,
4240 ;; but it calls write-region in the appropriate way
4241 ;; for saving the buffer.
4247 ;; Pass in nil&nil rather than point-min&max
4248 ;; cause we're saving the whole buffer.
4249 ;; write-region-annotate-functions may use it.
4251 tempname nil realname
4253 nil)
4255 ;; The file was somehow created by someone else between
4256 ;; `make-temp-name' and `write-region', let's try again.
4257 nil)
4259 ;; Reset the umask.
4261 ;; If we failed, restore the buffer's modtime.
4264 ;; Since we have created an entirely new file,
4265 ;; make sure it gets the right permission bits set.
4269 buffer-file-name)))
4270 ;; We succeeded in writing the temp file,
4271 ;; so rename it.
4273 ;; If file not writable, see if we can make it writable
4274 ;; temporarily while we write it.
4275 ;; But no need to do so if we have just backed it up
4276 ;; (setmodes is set) because that says we're superseding.
4278 ;; Change the mode back, after writing.
4284 ;; Pass in nil&nil rather than point-min&max to indicate
4285 ;; we're saving the buffer rather than just a region.
4286 ;; write-region-annotate-functions may make us of it.
4288 buffer-file-name nil t buffer-file-truename)
4290 ;; If we get an error writing the new file, and we made
4291 ;; the backup by renaming, undo the backing-up.
4296 setmodes))
4299 "View the differences between BUFFER and its associated file.
4300 This requires the external program `diff' to be in your `exec-path'."
4314 ;; Display that message for 1 second so that user can read it
4315 ;; in the minibuffer.
4317 ;; return always nil, so that save-buffers-kill-emacs will not move
4318 ;; over to the next unsaved buffer when calling `d'.
4319 nil)
4322 `((?\C-r
4329 ;; Return nil to ask about BUF again.
4330 nil)
4342 ;; Return nil to ask about BUF again.
4343 nil)
4352 "Save some modified file-visiting buffers. Asks user about each one.
4353 You can answer `y' to save, `n' not to save, `C-r' to look at the
4354 buffer in question with `view-buffer' before deciding or `d' to
4355 view the differences using `diff-buffer-with-file'.
4357 Optional argument (the prefix) non-nil means save all with no questions.
4358 Optional second argument PRED determines which buffers are considered:
4359 If PRED is nil, all the file-visiting buffers are considered.
4360 If PRED is t, then certain non-file buffers will also be considered.
4361 If PRED is a zero-argument function, it indicates for each buffer whether
4362 to consider it or not when called with that buffer current.
4364 See `save-some-buffers-action-alist' if you want to
4365 change the additional actions you can take on files."
4369 files-done abbrevs-done)
4371 ;; First save any buffers that we're supposed to save unconditionally.
4372 ;; That way the following code won't ask about them.
4377 ;; Ask about those buffers that merit it,
4378 ;; and record the number thus saved.
4382 ;; Note that killing some buffers may kill others via
4383 ;; hooks (e.g. Rmail and its viewing buffer).
4396 t
4408 save-some-buffers-action-alist))
4409 ;; Maybe to save abbrevs, and record whether
4410 ;; we either saved them or asked to.
4416 abbrev-file-name)))
4418 ;; Don't keep bothering user if he says no.
4423 "(Some special files were saved without asking)"
4425 \f
4427 "Mark current buffer as unmodified, not needing to be saved.
4430 It is not a good idea to use this function in Lisp programs, because it
4431 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4438 "Change whether this buffer is read-only.
4439 With prefix argument ARG, make the buffer read-only if ARG is
4440 positive, otherwise make it writable. If buffer is read-only
4441 and `view-read-only' is non-nil, enter view mode."
4446 nil ; do nothing.
4447 ;; Toggle.
4454 ;; If view-mode is already active, `view-mode-enter' is a nop.
4466 "Insert contents of file FILENAME into buffer after point.
4467 Set mark after the inserted text.
4469 This function is meant for the user to run interactively.
4470 Don't call it from programs! Use `insert-file-contents' instead.
4471 \(Its calling sequence is different; see its documentation)."
4476 "Append the contents of the region to the end of file FILENAME.
4477 When called from a function, expects three arguments,
4478 START, END and FILENAME. START and END are normally buffer positions
4479 specifying the part of the buffer to write.
4480 If START is nil, that means to use the entire buffer contents.
4481 If START is a string, then output that string to the file
4482 instead of any buffer contents; END is ignored.
4484 This does character code conversion and applies annotations
4485 like `write-region' does."
4490 "Return most recent backup file for FILENAME or nil if no backups exist."
4491 ;; `make-backup-file-name' will get us the right directory for
4492 ;; ordinary or numeric backups. It might create a directory for
4493 ;; backups as a side-effect, according to `backup-directory-alist'.
4500 tem)
4509 newest))
4512 "Rename current buffer to a similar name not already taken.
4513 This function is useful for creating multiple shell process buffers
4514 or multiple mail buffers, etc."
4522 ;; If the existing buffer name has a <NNN>,
4523 ;; which isn't part of the file name (if any),
4524 ;; then get rid of that.
4530 "Create the directory DIR and any nonexistent parent dirs.
4531 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4533 Interactively, the default choice of directory to create
4534 is the current default directory for file names.
4535 That is useful when you have visited a file in a nonexistent directory.
4537 Noninteractively, the second (optional) argument PARENTS says whether
4538 to create parent directories if they don't exist. Interactively,
4539 this happens by default."
4542 nil nil)
4543 t))
4544 ;; If default-directory is a remote directory,
4545 ;; make sure we find its make-directory handler.
4553 create-list)
4555 ;; If directory is its own parent, then we can't
4556 ;; keep looping forever
4565 \f
4568 "Function to use to revert this buffer, or nil to do the default.
4569 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4574 "Function to use to insert contents when reverting this buffer.
4575 Gets two args, first the nominal file name to use,
4576 and second, t if reading the auto-save file.
4581 "Function to check whether a non-file buffer needs reverting.
4582 This should be a function with one optional argument NOCONFIRM.
4583 Auto Revert Mode passes t for NOCONFIRM. The function should return
4584 non-nil if the buffer should be reverted. A return value of
4585 `fast' means that the need for reverting was not checked, but
4586 that reverting the buffer is fast. The buffer is current when
4587 this function is called.
4589 The idea behind the NOCONFIRM argument is that it should be
4590 non-nil if the buffer is going to be reverted without asking the
4591 user. In such situations, one has to be careful with potentially
4592 time consuming operations.
4594 For more information on how this variable is used by Auto Revert mode,
4598 "Normal hook for `revert-buffer' to run before reverting.
4599 If `revert-buffer-function' is used to override the normal revert
4603 "Normal hook for `revert-buffer' to run after reverting.
4604 Note that the hook value that it runs is the value that was in effect
4605 before reverting; that makes a difference if you have buffer-local
4606 hook functions.
4608 If `revert-buffer-function' is used to override the normal revert
4614 "Replace current buffer text with the text of the visited file on disk.
4615 This undoes all changes since the file was visited or saved.
4616 With a prefix argument, offer to revert from latest auto-save file, if
4617 that is more recent than the visited file.
4619 This command also implements an interface for special buffers
4620 that contain text which doesn't come from a file, but reflects
4621 some other data instead (e.g. Dired buffers, `buffer-list'
4622 buffers). This is done via the variable `revert-buffer-function'.
4623 In these cases, it should reconstruct the buffer contents from the
4624 appropriate data.
4626 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4627 to revert from the auto-save file when this is nil. Note that the
4628 sense of this argument is the reverse of the prefix argument, for the
4629 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4630 to nil.
4632 Optional second argument NOCONFIRM means don't ask for confirmation
4633 at all. \(The variable `revert-without-query' offers another way to
4634 revert buffers without querying for confirmation.)
4636 Optional third argument PRESERVE-MODES non-nil means don't alter
4637 the files modes. Normally we reinitialize them using `normal-mode'.
4639 If the value of `revert-buffer-function' is non-nil, it is called to
4640 do all the work for this command. Otherwise, the hooks
4641 `before-revert-hook' and `after-revert-hook' are run at the beginning
4642 and the end, and if `revert-buffer-insert-file-contents-function' is
4643 non-nil, it is called instead of rereading visited file contents."
4645 ;; I admit it's odd to reverse the sense of the prefix argument, but
4646 ;; there is a lot of code out there which assumes that the first
4647 ;; argument should be t to avoid consulting the auto-save file, and
4648 ;; there's no straightforward way to encourage authors to notice a
4649 ;; reversal of the argument sense. So I'm just changing the user
4650 ;; interface, but leaving the programmatic interface the same.
4658 buffer-auto-save-file-name
4663 buffer-auto-save-file-name
4664 buffer-file-name)))
4674 file-name)))
4676 ;; If file was backed up but has changed since,
4677 ;; we shd make another backup.
4681 ;; Effectively copy the after-revert-hook status,
4682 ;; since after-find-file will clobber it.
4685 after-revert-hook))
4690 ;; Get rid of all undo records for this buffer.
4692 ;; Don't make undo records for the reversion.
4695 file-name auto-save-p)))
4698 "File %s no longer exists!"
4700 file-name))
4703 "File %s no longer readable!"
4705 file-name))
4707 ;; Bind buffer-file-name to nil
4708 ;; so that we don't try to lock the file.
4714 ;; Auto-saved file should be read by Emacs'
4715 ;; internal coding.
4719 buffer-file-coding-system-explicit
4722 coding-system-for-read
4724 coding-system-for-read)
4726 ;; As a coding system suitable for multibyte
4727 ;; buffer is specified, make the current
4728 ;; buffer multibyte.
4731 ;; This force after-insert-file-set-coding
4732 ;; (called from insert-file-contents) to set
4733 ;; buffer-file-coding-system to a proper value.
4736 ;; Note that this preserves point in an intelligent way.
4740 nil nil t))
4742 nil nil t)))))
4743 ;; Recompute the truename in case changes in symlinks
4744 ;; have changed the truename.
4748 ;; Run after-revert-hook as it was before we reverted.
4752 local-hook)
4755 t))))))
4758 "Recover the visited file--get contents from its last auto-save file."
4763 "Visit file FILE, but get contents from its last auto-save file."
4764 ;; Actually putting the file name in the minibuffer should be used
4765 ;; only rarely.
4766 ;; Not just because users often use the default.
4786 ;; Use insert-directory-safely, not insert-directory,
4787 ;; because these files might not exist. In particular,
4788 ;; FILE might not exist if the auto-save file was for
4789 ;; a buffer that didn't visit a file, such as "*mail*".
4790 ;; The code in v20.x called `ls' directly, so we need
4791 ;; to emulate what `ls' did in that case.
4797 ;; Keep the current buffer-file-coding-system.
4799 ;; Auto-saved file should be read with special coding.
4808 "Recover auto save files from a previous Emacs session.
4809 This command first displays a Dired buffer showing you the
4810 previous sessions that you could recover from.
4811 To choose one, move point to the proper line and then type C-c C-c.
4812 Then you'll be asked about a number of files to recover."
4822 auto-save-list-file-prefix)))
4823 t)
4832 ;; Each line starts with a space
4833 ;; so that Font Lock mode won't highlight the first character.
4842 "Choose one saved session to recover auto-save files from.
4843 This command is used in the special Dired buffer created by
4846 ;; Get the name of the session file to recover from.
4848 files
4854 ;; Read in the auto-save-list file.
4858 ;; Loop thru the text of that file
4859 ;; and get out the names of the files to recover.
4863 ;; This is a pair of lines for a non-file-visiting buffer.
4864 ;; Get the auto-save file name and manufacture
4865 ;; a "visited file name" from that.
4868 ;; If there is no auto-save file name, the
4869 ;; auto-save-list file is probably corrupted.
4882 ;; This pair of lines is a file-visiting
4883 ;; buffer. Use the visited file name.
4893 ;; Ignore a file if its auto-save file does not exist now.
4897 ;; The file contains a pair of line for each auto-saved buffer.
4898 ;; The first line of the pair contains the visited file name
4899 ;; or is empty if the buffer was not visiting a file.
4900 ;; The second line is the auto-save file name.
4908 files
4914 "Kill BUFFER if confirmed."
4922 "Kill some buffers. Asks the user whether to kill each one of them.
4923 Non-interactively, if optional argument LIST is non-nil, it
4924 specifies the list of buffers to kill, asking for approval for each one."
4932 ; if we killed the base buffer.
4939 "Kill buffers whose name matches the specified REGEXP.
4940 The optional second argument indicates whether to kill internal buffers too."
4949 \f
4951 "Toggle auto-saving of contents of current buffer.
4952 With prefix argument ARG, turn auto-saving on if positive, else off."
4957 ;; If auto-save is off because buffer has shrunk,
4958 ;; then toggling should turn it on.
4963 buffer-file-name
4965 ;; If -1 was stored here, to temporarily turn off saving,
4966 ;; turn it back on.
4972 buffer-auto-save-file-name)
4975 "Adjust current buffer's auto save file name for current conditions.
4976 Also rename any existing auto save file, if it was made in this session."
4988 "Return file name to use for auto-saves of current buffer.
4989 Does not consider `auto-save-visited-file-name' as that variable is checked
4990 before calling this function. You can redefine this for customization.
4991 See also `auto-save-file-name-p'."
4999 result uniq)
5000 ;; Apply user-specified translations
5001 ;; to the file name.
5005 filename)
5015 filename))))
5020 ;; We truncate the file name to DOS 8+3 limits
5021 ;; before doing anything else, because the regexp
5022 ;; passed to string-match below cannot handle
5023 ;; extensions longer than 3 characters, multiple
5024 ;; dots, and other atrocities.
5029 fn)
5034 "#"
5037 ;; Make sure auto-save file names don't contain characters
5038 ;; invalid for the underlying filesystem.
5040 ;; Don't modify remote (ange-ftp) filenames
5043 result))))
5045 ;; Deal with buffers that don't have any associated files. (Mail
5046 ;; mode tends to create a good number of these.)
5050 file-name)
5051 ;; Restrict the characters used in the file name to those which
5052 ;; are known to be safe on all filesystems, url-encoding the
5053 ;; rest.
5054 ;; We do this on all platforms, because even if we are not
5055 ;; running on DOS/Windows, the current directory may be on a
5056 ;; mounted VFAT filesystem, such as a USB memory stick.
5060 ;; For multibyte characters, this will produce more than
5061 ;; 2 hex digits, so is not true URL encoding.
5065 ;; Generate the file name.
5071 ;; Try a few alternative directories, to get one we can
5072 ;; write it.
5078 ;; Don't modify remote (ange-ftp) filenames
5080 ;; The call to convert-standard-filename is in case
5081 ;; buffer-name includes characters not allowed by the
5082 ;; DOS/Windows filesystems. make-temp-file writes to the
5083 ;; file it creates, so we must fix the file name _before_
5084 ;; make-temp-file is called.
5086 fname))
5088 ;; make-temp-file creates the file,
5089 ;; but we don't want it to exist until we do an auto-save.
5093 file-name)))
5096 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5097 FILENAME should lack slashes. You can redefine this for customization."
5099 \f
5101 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5102 The generated regexp will match a filename only if the filename
5103 matches that wildcard according to shell rules. Only wildcards known
5104 by `sh' are supported."
5106 ;; Copy the initial run of non-special characters.
5109 ;; If no special characters, we're almost done.
5113 j)
5115 result
5136 ;; Found "[^". Insert a `\0' character
5137 ;; (which cannot happen in a filename)
5138 ;; into the character class, so that `^'
5139 ;; is not the first character after `[',
5140 ;; and thus non-special in a regexp.
5145 ;; I don't think `]' can appear in a
5146 ;; character class in a wildcard, but
5147 ;; let's be general here.
5154 i
5167 ;; Shell wildcards should match the entire filename,
5168 ;; not its part. Make the regexp say so.
5170 \f
5172 "-CF"
5173 "Switches for `list-directory' to pass to `ls' for brief listing."
5178 "-l"
5179 "Switches for `list-directory' to pass to `ls' for verbose listing."
5184 "Expand wildcard pattern PATTERN.
5185 This returns a list of file names which match the pattern.
5187 If PATTERN is written as an absolute file name,
5188 the values are absolute also.
5190 If PATTERN is written as a relative file name, it is interpreted
5191 relative to the current default directory, `default-directory'.
5192 The file names returned are normally also relative to the current
5193 default directory. However, if FULL is non-nil, they are absolute."
5197 ;; A list of all dirs that DIRPART specifies.
5198 ;; This can be more than one dir
5199 ;; if DIRPART contains wildcards.
5204 contents)
5209 ;; Filter out "." and ".."
5214 name))
5221 this-dir-contents)
5222 this-dir-contents)
5223 contents))))
5225 contents)))
5228 "Display a list of files in or matching DIRNAME, a la `ls'.
5229 DIRNAME is globbed by the shell if necessary.
5230 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5231 Actions controlled by variables `list-directory-brief-switches'
5232 and `list-directory-verbose-switches'."
5236 nil default-directory nil)
5237 pfx)))
5239 list-directory-brief-switches))
5240 buffer)
5253 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5261 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5263 PATTERN is assumed to represent a file-name wildcard suitable for the
5264 underlying filesystem. For Unix and GNU/Linux, each character from the
5266 the parts of the pattern which don't include wildcard characters are
5267 quoted with double quotes.
5270 on Windows), so PATTERN can use them to quote wildcard characters that
5271 need to be passed verbatim to shell commands."
5275 ;; DOS/Windows don't allow `"' in file names. So if the
5276 ;; argument has quotes, we can safely assume it is already
5277 ;; quoted by the caller.
5279 ;; We quote [&()#$'] in case their shell is a port of a
5280 ;; Unixy shell. We quote [,=+] because stock DOS and
5281 ;; Windows shells require that in some cases, such as
5282 ;; passing arguments to batch files that use positional
5283 ;; arguments like %1.
5285 pattern
5288 end)
5305 pattern))))
5312 "Program to get the amount of free space on a file system.
5313 We assume the output has the format of `df'.
5314 The value of this variable must be just a command name or file name;
5315 if you want to specify options, use `directory-free-space-args'.
5317 A value of nil disables this feature.
5319 If the function `file-system-info' is defined, it is always used in
5320 preference to the program given by this variable."
5326 "Options to use when running `directory-free-space-program'."
5331 "Return the amount of free space on directory DIR's file system.
5332 The result is a string that gives the number of free 1KB blocks,
5333 or nil if the system call or the program which retrieve the information
5334 fail. It returns also nil when DIR is a remote directory.
5336 This function calls `file-system-info' if it is available, or invokes the
5337 program specified by `directory-free-space-program' if that is non-nil."
5339 ;; Try to find the number of free blocks. Non-Posix systems don't
5340 ;; always have df, but might have an equivalent system call.
5352 default-directory
5355 nil t nil
5356 directory-free-space-args
5357 dir)
5359 ;; Usual format is a header line followed by a line of
5360 ;; numbers.
5365 ;; Move to the end of the "available blocks" number.
5368 ;; Copy it into AVAILABLE.
5373 ;; The following expression replaces `dired-move-to-filename-regexp'.
5377 ;; In some locales, month abbreviations are as short as 2 letters,
5378 ;; and they can be followed by ".".
5379 ;; In Breton, a month name can include a quote character.
5392 s "+"
5395 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5396 ;; omits the Kanji characters after month and day-of-month.
5397 ;; On Mac OS X 10.3, the date format in East Asian locales is
5398 ;; day-of-month digits followed by month digits.
5404 ;; The "[0-9]" below requires the previous column to end in a digit.
5405 ;; This avoids recognizing `1 may 1997' as a date in the line:
5406 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5408 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5409 ;; The ".*" below finds the last match if there are multiple matches.
5410 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5411 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5413 ;; vc dired listings provide the state or blanks between file
5414 ;; permissions and date. The state is always surrounded by
5415 ;; parantheses:
5416 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5417 ;; This is not supported yet.
5421 "Regular expression to match up to the file name in a directory listing.
5422 The default value is designed to recognize dates and times
5427 ;; insert-directory
5428 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5429 ;; FULL-DIRECTORY-P is nil.
5430 ;; The single line of output must display FILE's name as it was
5431 ;; given, namely, an absolute path name.
5432 ;; - must insert exactly one line for each file if WILDCARD or
5433 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5434 ;; before the file lines, plus optional text after the file lines.
5435 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5436 ;; allowed.
5437 ;; File lines should display the basename.
5438 ;; - must be consistent with
5439 ;; - functions dired-move-to-filename, (these two define what a file line is)
5440 ;; dired-move-to-end-of-filename,
5441 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5442 ;; dired-insert-headerline
5443 ;; dired-after-subdir-garbage (defines what a "total" line is)
5444 ;; - variable dired-subdir-regexp
5445 ;; - may be passed "--dired" as the first argument in SWITCHES.
5446 ;; Filename handlers might have to remove this switch if their
5447 ;; "ls" command does not support it.
5449 "Insert directory listing for FILE, formatted according to SWITCHES.
5450 Leaves point after the inserted text.
5451 SWITCHES may be a string of options, or a list of strings
5452 representing individual options.
5453 Optional third arg WILDCARD means treat FILE as shell wildcard.
5454 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5455 switches do not contain `d', so that a full listing is expected.
5457 This works by running a directory listing program
5458 whose name is in the variable `insert-directory-program'.
5459 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5461 When SWITCHES contains the long `--dired' option, this function
5462 treats it specially, for the sake of dired. However, the
5463 normally equivalent short `-D' option is just passed on to
5464 `insert-directory-program', as any other option."
5465 ;; We need the directory in order to find the right handler.
5470 wildcard full-directory-p)
5473 ;; Read the actual directory using `insert-directory-program'.
5474 ;; RESULT gets the status code.
5476 ;; putting text property `dired-filename, decode one
5477 ;; bunch by one to preserve that property.
5479 ;; This is to control encoding the arguments in call-process.
5483 default-file-name-coding-system))))
5486 ;; Run ls in the directory part of the file pattern
5487 ;; using the last component as argument.
5494 shell-file-name nil t nil
5495 "-c"
5497 ""
5499 insert-directory-program
5500 " -d "
5502 switches
5504 " -- "
5505 ;; Quote some characters that have
5506 ;; special meanings in shells; but
5507 ;; don't quote the wildcards--we want
5508 ;; them to be special. We also
5509 ;; currently don't quote the quoting
5510 ;; characters in case people want to
5511 ;; use them explicitly to quote
5512 ;; wildcard characters.
5514 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5515 ;; directory if FILE is a symbolic link.
5517 insert-directory-program nil t nil
5521 ;; Split the switches at any spaces so we can
5522 ;; pass separate options as separate args.
5524 ;; Avoid lossage if FILE starts with `-'.
5532 file))))))))
5534 ;; If we got "//DIRED//" in the output, it means we got a real
5535 ;; directory listing, even if `ls' returned nonzero.
5536 ;; So ignore any errors.
5549 ;; The first time ls returns an error,
5550 ;; find the version numbers of ls,
5551 ;; and set insert-directory-ls-version
5552 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5553 ;; is equal or if the info cannot be obtained.
5554 ;; (That can mean it isn't GNU ls.)
5564 comparison)
5580 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5584 ;; If `insert-directory-program' failed, signal an error.
5586 ;; Delete the error message it may have output.
5588 ;; On non-Posix systems, we cannot open a directory, so
5589 ;; don't even try, because that will always result in
5590 ;; the ubiquitous "Access denied". Instead, show the
5591 ;; command line so the user can try to guess what went wrong.
5596 insert-directory-program
5598 file result)
5599 ;; Unix. Access the file to get a suitable error.
5606 ;; The following overshoots by one line for an empty
5607 ;; directory listed with "--dired", but without "-a"
5608 ;; switch, where the ls output contains a
5609 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5610 ;; We take care of that case later.
5618 error-lines)
5619 ;; Find all the lines that are error messages,
5620 ;; and record the bounds of each one.
5627 ;; Now read the numeric positions of file names.
5634 error-lines))
5637 error-lines)))
5639 ;; End is followed by \n or by " -> ".
5641 ;; It seems that we can't trust ls's output as to
5642 ;; byte positions of filenames.
5648 ;; Take care of the case where the ls output contains a
5649 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5650 ;; and we went one line too far back (see above).
5655 ;; Now decode what read if necessary.
5657 file-name-coding-system
5658 default-file-name-coding-system
5660 coding-no-eol
5661 val pos)
5665 ;; If no coding system is specified or detection is
5666 ;; requested, detect the coding.
5680 ;; Force no eol conversion on a file name, so
5681 ;; that CR is preserved.
5689 ;; Try to insert the amount of free space.
5692 ;; First find the line to put it on.
5696 ;; Replace "total" with "used", to avoid confusion.
5702 "Convert `ls --dired' file name position value POS to a buffer position.
5703 File name position values returned in ls --dired output
5704 count only stdout; they don't count the error messages sent to stderr.
5705 So this function converts to them to real buffer positions.
5706 ERROR-LINES is a list of buffer positions of error message lines,
5707 of the form (START END)."
5711 pos)
5715 "Insert directory listing for FILE, formatted according to SWITCHES.
5717 Like `insert-directory', but if FILE does not exist, it inserts a
5718 message to that effect instead of signaling an error."
5721 ;; Simulate the message printed by `ls'.
5725 "Functions to call with no arguments to query about killing Emacs.
5726 If any of these functions returns nil, killing Emacs is cancelled.
5727 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5731 "How to ask for confirmation when leaving Emacs.
5732 If nil, the default, don't ask at all. If the value is non-nil, it should
5733 be a predicate function such as `yes-or-no-p'."
5741 "Offer to save each buffer, then kill this Emacs process.
5742 With prefix ARG, silently save all file-visiting buffers, then kill."
5751 ;; process-list is not defined on MSDOS.
5753 active)
5762 ;; Query the user for other things, perhaps.
5769 "Offer to save each buffer, then kill the current connection.
5770 If the current frame has no client, kill Emacs itself.
5772 With prefix ARG, silently save all file-visiting buffers, then kill.
5774 If emacsclient was started with a list of filenames to edit, then
5775 only these files will be asked to be saved."
5780 \f
5781 ;; We use /: as a prefix to "quote" a file name
5782 ;; so that magic file name handlers will not apply to it.
5786 file-name-handler-alist))
5788 ;; We depend on being the last handler on the list,
5789 ;; so that anything else which does need handling
5790 ;; has been handled already.
5791 ;; So it is safe for us to inhibit *all* magic file name handlers.
5800 default-directory))
5801 ;; Get a list of the indices of the args which are file names.
5804 ;; The first six are special because they
5805 ;; return a file name. We want to include the /:
5806 ;; in the return value.
5807 ;; So just avoid stripping it in the first place.
5814 ;; `identity' means just return the first arg
5815 ;; not stripped of its quoting.
5817 ;; `add' means add "/:" to the result.
5819 ;; `quote' means add "/:" to buffer-file-name.
5821 ;; `unquote-then-quote' means set buffer-file-name
5822 ;; temporarily to unquoted filename.
5824 ;; List the arguments which are filenames.
5832 ;; For all other operations, treat the first argument only
5833 ;; as the file name.
5835 method
5836 ;; Copy ARGUMENTS so we can replace elements in it.
5840 ;; Strip off the /: from the file names that have it.
5848 "/"
5864 res))
5867 \f
5868 ;; Symbolic modes and read-file-modes.
5871 "Convert CHAR to a numeric bit-mask for extracting mode bits.
5872 CHAR is in [ugoa] and represents the category of users (Owner, Group,
5873 Others, or All) for whom to produce the mask.
5874 The bit-mask that is returned extracts from mode bits the access rights
5875 for the specified category of users."
5883 "Convert CHAR to a numeric value of mode bits.
5884 CHAR is in [rwxXstugo] and represents symbolic access permissions.
5885 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
5892 ;; Rights relative to the previous file modes.
5903 "Convert a symbolic mode string specification to an equivalent number.
5905 WHO-MASK is the bit-mask specifying the category of users to which to
5906 apply the access permissions. See `file-modes-char-to-who'.
5907 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5908 RIGHTS request to add, remove, or set permissions based on existing ones,
5915 char-right)
5922 num-rights
5926 op char-right)))
5927 num-rights))
5930 "Convert symbolic file modes to numeric file modes.
5931 MODES is the string to convert, it should match
5934 notation.
5935 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5936 MODES request to add, remove, or set permissions based on existing ones,
5950 num-who num-modes)
5953 num-modes)))
5956 "Read file modes in octal or symbolic notation and return its numeric value.
5957 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5958 ORIG-FILE is the name of a file on whose mode bits to base returned
5959 permissions if what user types requests to add, remove, or set permissions
5975 nil nil default)))
5981 \f
5982 ;; Trashcan handling.
5984 "Directory for `move-file-to-trash' to move files and directories to.
5985 This directory is only used when the function `system-move-file-to-trash' is
5986 not defined. Relative paths are interpreted relative to `default-directory'.
5987 See also `delete-by-moving-to-trash'."
5995 "Move file (or directory) name FILENAME to the trash.
5996 This function is called by `delete-file' and `delete-directory' when
5997 `delete-by-moving-to-trash' is non-nil. On platforms that define
5998 `system-move-file-to-trash', that function is used to move FILENAME to the
5999 system trash, otherwise FILENAME is moved to `trash-directory'.
6000 Returns nil on success."
6013 ;; make new-fn unique.
6014 ;; example: "~/.Trash/abc.txt" -> "~/.Trash/abc.txt.~1~"
6018 ;; stop processing if fn is same or parent directory of trash-dir.
6021 filename))
6025 \f
6050 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6051 ;;; files.el ends here