| blob | 5170bcd11e302dfb259d9dadf5d8a996dc9c80a7 |
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 86, 87, 92, 93,
4 ;; 94, 95, 96, 97, 98, 1999 Free Software Foundation, Inc.
6 ;; Maintainer: FSF
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; Defines most of Emacs's file- and directory-handling functions,
28 ;; including basic file visiting, backup generation, link handling,
29 ;; ITS-id version control, load- and write-hook handling, and the like.
31 ;;; Code:
34 "Backups of edited data files."
38 "Finding files."
43 "*Non-nil means delete auto-save file when a buffer is saved or killed.
45 Note that auto-save file will not be deleted if the buffer is killed
46 when it has unsaved changes."
51 nil
52 "*Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 FROM with TO when it appears in a directory name. This replacement is
55 done when setting up the default directory of a newly visited file.
56 *Every* FROM string should start with `^'.
58 Do not use `~' in the TO strings.
59 They should be ordinary absolute directory names.
61 Use this feature when you have directories which you normally refer to
62 via absolute symbolic links. Make TO the name of the link, and FROM
63 the name it is linked to."
71 ;;; Turn off backup files on VMS since it has version numbers.
73 "*Non-nil means make a backup of a file the first time it is saved.
74 This can be done by renaming the file or by copying.
76 Renaming means that Emacs renames the existing file so that it is a
77 backup file, then writes the buffer into a new file. Any other names
78 that the old file had will now refer to the backup file. The new file
79 is owned by you and its group is defaulted.
81 Copying means that Emacs copies the existing file into the backup
82 file, then writes the buffer on top of the existing file. Any other
83 names that the old file had will now refer to the new (edited) file.
84 The file's owner and group are unchanged.
86 The choice of renaming or copying is controlled by the variables
87 `backup-by-copying', `backup-by-copying-when-linked',
88 `backup-by-copying-when-mismatch' and
89 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
93 ;; Do this so that local variables based on the file name
94 ;; are not overridden by the major mode.
96 "Non-nil means don't make a backup, regardless of the other parameters.
97 This variable is intended for use by making it local to a buffer.
102 "*Non-nil means always use copying to create backup files.
103 See documentation of variable `make-backup-files'."
108 "*Non-nil means use copying to create backups for files with multiple names.
109 This causes the alternate names to refer to the latest version as edited.
110 This variable is relevant only if `backup-by-copying' is nil."
115 "*Non-nil means create backups by copying if this preserves owner or group.
116 Renaming may still be used (subject to control of other variables)
117 when it would not result in changing the owner or group of the file;
118 that is, for files which are owned by you and whose group matches
119 the default for a new file created there by you.
120 This variable is relevant only if `backup-by-copying' is nil."
125 "*Non-nil means create backups by copying to preserve a privileged owner.
126 Renaming may still be used (subject to control of other variables)
127 when it would not result in changing the owner of the file or if the owner
128 has a user id greater than the value of this variable. This is useful
129 when low-numbered uid's are used for special system users (such as root)
130 that must maintain ownership of certain files.
131 This variable is relevant only if `backup-by-copying' and
132 `backup-by-copying-when-mismatch' are nil."
140 "Predicate that looks at a file name and decides whether to make backups.
144 "*Non-nil in a buffer means offer to save the buffer on exit
145 even if the buffer is not visiting a file.
146 Automatically local in all buffers."
152 "*Non-nil means find a file under alternative names, in existing buffers.
153 This means if any existing buffer is visiting the file you want
154 under another name, you get the existing buffer instead of a new buffer."
159 "*Non-nil means visit a file under its truename.
160 The truename of a file is found by chasing all links
161 both at the file level and at the levels of the containing directories."
166 nil
167 "*Specify which files should be reverted without query.
168 The value is a list of regular expressions.
169 If the file name matches one of these regular expressions,
170 then `revert-buffer' reverts the file without querying
171 if the file has changed on disk and you have not edited the buffer."
176 "The device number and file number of the file visited in the current buffer.
177 The value is a list of the form (FILENUM DEVNUM).
178 This pair of numbers uniquely identifies the file.
200 "*Non-nil means protect against I/O errors while saving files.
201 Some modes set this non-nil in particular buffers.
203 This feature works by writing the new contents into a temporary file
204 and then renaming the temporary file to replace the original.
205 In this way, any I/O error in writing leaves the original untouched,
206 and there is never any instant where the file is nonexistent.
208 Note that this feature forces backups to be made by copying.
209 Yet, at the same time, saving a precious file
210 breaks any hard links between it and other files."
215 "*Control use of version numbers for backup files.
216 t means make numeric backup versions unconditionally.
217 nil means make them for files that have some already.
218 `never' means do not make them."
226 "*When cleaning directory, number of versions to keep."
232 "*If t, delete excess backup versions silently.
233 If nil, ask confirmation. Any other value prevents any trimming."
240 "*Number of oldest versions to keep when a new numbered backup is made."
245 "*Number of newest versions to keep when a new numbered backup is made.
246 Includes the new backup. Must be > 0"
251 "*Value of t says silently ensure a file ends in a newline when it is saved.
252 Non-nil but not t says ask user whether to add a newline when there isn't one.
253 nil means don't add newlines."
260 "*Non-nil says by default do auto-saving of every file-visiting buffer."
265 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
266 Normally auto-save files are written under other names."
271 "*Non-nil means save word abbrevs too when files are saved.
272 Loading an abbrev file sets this to t."
277 "*Non-nil means allow `find-file' to visit directories.
278 To visit the directory, `find-file' runs `find-directory-functions'."
283 "*List of functions to try in sequence to visit a directory.
284 Each function is called with the directory name as the sole argument
285 and should return either a buffer or nil."
289 ;;;It is not useful to make this a local variable.
290 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
292 "List of functions to be called for `find-file' on nonexistent file.
293 These functions are called as soon as the error is detected.
294 `buffer-file-name' is already set up.
297 ;;;It is not useful to make this a local variable.
298 ;;;(put 'find-file-hooks 'permanent-local t)
300 "List of functions to be called after a buffer is loaded from a file.
301 The buffer's local variables (if any) will have been processed before the
305 "List of functions to be called before writing out a buffer to a file.
306 If one of them returns non-nil, the file is considered already written
307 and the rest are not called.
308 These hooks are considered to pertain to the visited file.
309 So any buffer-local binding of `write-file-hooks' is
312 Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
314 ;;; However, in case someone does make it local...
318 "Just like `write-file-hooks', except intended for per-buffer use.
319 The functions in this list are called before the ones in
320 `write-file-hooks'.
322 This variable is meant to be used for hooks that have to do with a
323 particular visited file. Therefore, it is a permanent local, so that
324 changing the major mode does not clear it. However, calling
330 "List of functions to be called before writing out a buffer to a file.
331 If one of them returns non-nil, the file is considered already written
332 and the rest are not called.
334 This variable is meant to be used for hooks that pertain to the
335 buffer's contents, not to the particular visited file; thus,
336 `set-visited-file-name' does not clear this variable; but changing the
337 major mode does clear it.
339 This variable automatically becomes buffer-local whenever it is set.
340 If you use `add-hook' to add elements to the list, use nil for the
341 LOCAL argument.
347 "*Control use of local variables in files you visit.
348 The value can be t, nil or something else.
349 A value of t means file local variables specifications are obeyed;
350 nil means they are ignored; anything else means query.
351 This variable also controls use of major modes specified in
352 a -*- line.
355 always obeys file local variable specifications and the -*- line,
356 and ignores this variable."
363 "Like `enable-local-variables' but meant for buffer-local bindings.
364 The meaningful values are nil and non-nil. The default is non-nil.
365 If a major mode sets this to nil, buffer-locally, then any local
366 variables list in the file will be ignored.
368 This variable does not affect the use of major modes
373 The value can be t, nil or something else.
374 A value of t means obey `eval' variables;
375 nil means ignore them; anything else means query.
378 and ignores this variable."
384 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
407 "The directory for writing small temporary files.
408 If non-nil, this directory is used instead of `temporary-file-directory'
409 by programs that create small temporary files. This is for systems that
412 ;; The system null device. (Should reference NULL_DEVICE from C.)
415 ;; This hook function provides support for ange-ftp host name
416 ;; completion. It runs the usual ange-ftp hook, but only for
417 ;; completion operations. Having this here avoids the need
418 ;; to load ange-ftp when it's not really in use.
425 inhibit-file-name-handlers)))
430 "Convert a standard file's name to something suitable for the current OS.
431 This function's standard definition is trivial; it just returns the argument.
432 However, on some systems, the function is redefined
433 with a definition that really does change some file names."
434 filename)
435 \f
437 "Show the current default directory."
442 "Value of the CDPATH environment variable, as a list.
446 "Explode a colon-separated search path into a list of directory names."
454 nil
459 cd-list)))
462 "Change current directory to given absolute file name DIR."
463 ;; Put the name into directory syntax now,
464 ;; because otherwise expand-file-name may give some bad results.
477 "Make DIR become the current buffer's default directory.
478 If your environment includes a `CDPATH' variable, try each one of that
479 colon-separated list of directories when resolving a relative directory name."
482 default-directory default-directory
498 cd-path)
499 nil))
503 "Load the Lisp file named FILE."
510 "Load the library named LIBRARY.
511 This is an interface to the function `load'."
516 "Copy the file FILE into a temporary file on this machine.
517 Returns the name of the local copy, or nil, if FILE is directly
518 accessible."
519 ;; This formerly had an optional BUFFER argument that wasn't used by
520 ;; anything.
524 nil)))
527 "Return the truename of FILENAME, which should be absolute.
528 The truename of a file name is found by chasing symbolic links
529 both at the level of the file and at the level of the directories
530 containing it, until no links are left at any level.
532 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
533 Do not specify them in other calls."
534 ;; COUNTER can be a cons cell whose car is the count of how many more links
535 ;; to chase before getting an error.
536 ;; PREV-DIRS can be a cons cell whose car is an alist
537 ;; of truenames we've just recently computed.
539 ;; The last test looks dubious, maybe `+' is meant here? --simon.
549 ;; For speed, remove the ange-ftp completion handler from the list.
550 ;; We know it's not needed here.
551 ;; For even more speed, do this only on the outermost call.
558 ;; andrewi@harlequin.co.uk - none of the following code (except for
559 ;; invoking the file-name handler) currently applies on Windows
560 ;; (ie. there are no native symlinks), but there is an issue with
561 ;; case differences being ignored by the OS, and short "8.3 DOS"
562 ;; name aliases existing for all files. (The short names are not
563 ;; reported by directory-files, but can be used to refer to files.)
564 ;; It seems appropriate for file-truename to resolve these issues in
565 ;; the most natural way, which on Windows is to call the function
566 ;; `w32-long-file-name' - this returns the exact name of a file as
567 ;; it is stored on disk (expanding short name aliases with the full
568 ;; name in the process).
571 newname)
572 ;; For file name that has a special handler, call handler.
573 ;; This is so that ange-ftp can save time by doing a no-op.
576 ;; If filename contains a wildcard, newname will be the old name.
579 ;; If filename doesn't exist, newname will be nil.
584 ;; If this file directly leads to a link, process that iteratively
585 ;; so that we don't use lots of stack.
591 ;; For file name that has a special handler, call handler.
592 ;; This is so that ange-ftp can save time by doing a no-op.
595 done t)
597 target dirfile)
598 ;; Get the truename of the directory.
600 ;; If these are equal, we have the (or a) root directory.
602 ;; If this is the same dir we last got the truename for,
603 ;; save time--don't recalculate.
613 done t)
616 done t)
617 ;; Put it back on the file name.
619 ;; Is the file name the name of a link?
622 ;; Yes => chase that link, then start all over
623 ;; since the link may point to a directory name that uses links.
624 ;; We can't safely use expand-file-name here
625 ;; since target might look like foo/../bar where foo
626 ;; is itself a link. Instead, we handle . and .. above.
629 target
631 done nil)
632 ;; No, we are done!
634 filename))
637 "Chase links in FILENAME until a name that is not a link.
638 Does not examine containing directories for links,
639 unlike `file-truename'."
645 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
648 ;; Handle `..' by hand, since it needs to work in the
649 ;; target of any directory symlink.
650 ;; This code is not quite complete; it does not handle
651 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
655 ;; Chase links in the default dir of the symlink.
659 ;; Now find the parent of that dir.
663 newname))
664 \f
666 "Select buffer BUFFER in another window.
667 Optional second arg NORECORD non-nil means
668 do not put this buffer at the front of the list of recently selected ones."
674 "Switch to buffer BUFFER in another frame.
675 Optional second arg NORECORD non-nil means
676 do not put this buffer at the front of the list of recently selected ones."
683 "Edit file FILENAME.
684 Switch to a buffer visiting file FILENAME,
685 creating one if none already exists.
686 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
687 expand wildcards (if any) and visit multiple files. Wildcard expansion
688 can be suppressed by setting `find-file-wildcards'."
696 "Edit file FILENAME, in another window.
697 May create a new window, or reuse an existing one.
698 See the function `display-buffer'.
699 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
700 expand wildcards (if any) and visit multiple files."
711 "Edit file FILENAME, in another frame.
712 May create a new frame, or reuse an existing one.
713 See the function `display-buffer'.
714 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
715 expand wildcards (if any) and visit multiple files."
726 "Edit file FILENAME but don't allow changes.
735 "Edit file FILENAME in another window but don't allow changes.
744 "Edit file FILENAME in another frame but don't allow changes.
753 "Find file FILENAME as a replacement for the file in the next window.
754 This command does not select that window."
773 "Find file FILENAME, select its buffer, kill previous buffer.
774 If the current buffer now contains an empty file that you just visited
775 \(presumably by mistake), use this command to visit the file you really want."
786 ;; (not buffer-read-only)
813 \f
815 "Create a suitably named buffer for visiting FILENAME, and return it.
816 FILENAME (sans directory) is used unchanged if that name is free;
817 otherwise a string <2> or <3> or ... is appended to get an unused name."
824 "Create and return a buffer with a name based on NAME.
825 Choose the buffer's name using `generate-new-buffer-name'."
835 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
838 ;; Get rid of the prefixes added by the automounter.
845 ;; If any elt of directory-abbrev-alist matches this name,
846 ;; abbreviate accordingly.
852 ;; Compute and save the abbreviated homedir name.
853 ;; We defer computing this until the first time it's needed, to
854 ;; give time for directory-abbrev-alist to be set properly.
855 ;; We include a slash at the end, to avoid spurious matches
856 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
863 ;; If FILENAME starts with the abbreviated homedir,
864 ;; make it start with `~' instead.
866 ;; If the home dir is just /, don't change it.
869 ;; MS-DOS root directories can come with a drive letter;
870 ;; Novell Netware allows drive letters beyond `Z:'.
879 filename))
882 "*List of logical names for which visiting shouldn't save the true dirname.
883 On VMS, when you visit a file using a logical name that searches a path,
884 you may or may not want the visited file name to record the specific
885 directory where the file was found. If you *do not* want that, add the logical
886 name to this list as a string."
891 "Return the buffer visiting file FILENAME (a string).
892 This is like `get-file-buffer', except that it checks for any buffer
893 visiting the same file, possibly under a different name.
894 If there is no such live buffer, return nil."
906 found)
910 number
916 ;; Verify this buffer's file number
917 ;; still belongs to its file.
920 number))
923 found))))
924 \f
926 "*Non-nil means file-visiting commands should handle wildcards.
927 For example, if you specify `*.c', that would visit all the files
928 whose names match the pattern."
933 "Read file FILENAME into a buffer and return the buffer.
934 If a buffer exists visiting FILENAME, return that one, but
935 verify that the file has not changed since visited or saved.
936 The buffer is not selected, just returned to the caller.
937 Optional first arg NOWARN non-nil means suppress any warning messages.
938 Optional second arg RAWFILE non-nil means the file is read literally.
939 Optional third arg WILDCARDS non-nil means do wildcard processing
940 and visit all the matching files. When wildcards are actually
941 used and expanded, the value is a list of buffers
942 that are visiting the various files."
949 'find-directory-functions
952 filename)))
955 find-file-wildcards
965 files))))
969 ;; Find any buffer for a file which has same truename.
971 ;; Let user know if there is a buffer with the same truename.
978 ;; Optionally also find that buffer.
982 ;; We are using an existing buffer.
988 ;; Certain files should be reverted automatically
989 ;; if they have changed on disk and not in the buffer.
997 found))
1007 "File %s changed on disk. Discard your edits? "
1012 "File %s changed on disk. Discard your edits in %s? "
1023 "Save file and revisit literally? "
1028 rawfile truename number))
1030 "Discard your edits and revisit file literally? "
1033 rawfile truename number)
1037 "Revisit file literally? "
1040 rawfile truename number)
1043 ;; Return the buffer we are using.
1044 buf)
1045 ;; Create a new buffer.
1048 ;; find-file-noselect-1 may use a different buffer.
1050 rawfile truename number))))))
1054 error)
1057 ;; Needed in case we are re-visiting the file with a different
1058 ;; text representation.
1072 filename)))
1073 ;; Unconditionally set error
1082 filename)))
1083 ;; Run find-file-not-found-hooks until one returns non-nil.
1085 ;; If they fail too, set error.
1087 ;; Record the file's truename, and maybe use that as visited name.
1093 ;; On VMS, we may want to remember which directory in a search list
1094 ;; the file was found in.
1106 ;; Set buffer's default directory to that of the file.
1108 ;; Turn off backup files for certain file names. Since
1109 ;; this is a permanent local, the major mode won't eliminate it.
1122 \f
1124 "Like `insert-file-contents', but only reads in the file literally.
1125 A buffer may be modified in several ways after reading into the buffer,
1126 to Emacs features such as format decoding, character code
1127 conversion, find-file-hooks, automatic uncompression, etc.
1129 This function ensures that none of these modifications will take place."
1138 nil)))
1148 "Insert contents of file FILENAME into buffer after point with no conversion.
1150 This function is meant for the user to run interactively.
1151 Don't call it from programs! Use `insert-file-contents-literally' instead.
1152 \(Its calling sequence is different; see its documentation)."
1156 filename)))
1161 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1166 "Visit file FILENAME with no conversion of any kind.
1167 Format conversion and character code conversion are both disabled,
1168 and multibyte characters are disabled in the resulting buffer.
1169 The major mode used is Fundamental mode regardless of the file name,
1170 and local variable specifications in the file are ignored.
1171 Automatic uncompression is also disabled.
1173 You cannot absolutely rely on this function to result in
1174 visiting the file literally. If Emacs already has a buffer
1175 which is visiting the file, you get the existing buffer,
1176 regardless of whether it was created literally or not.
1178 In a Lisp program, if you want to be sure of accessing a file's
1179 contents literally, you should create a temporary buffer and then read
1180 the file contents into it using `insert-file-contents-literally'."
1183 \f
1187 after-find-file-from-revert-buffer
1188 nomodes)
1189 "Called after finding a file and by the default revert function.
1190 Sets buffer mode, parses local variables.
1191 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1192 error in reading the file. WARN non-nil means warn if there
1193 exists an auto-save file more recent than the visited file.
1194 NOAUTO means don't mess with auto-save mode.
1195 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1196 means this call was from `revert-buffer'.
1197 Fifth arg NOMODES non-nil means don't alter the file's modes.
1198 Finishes by calling the functions in `find-file-hooks'
1199 unless NOMODES is non-nil."
1202 nil
1210 ;; No need to warn if buffer is auto-saved
1211 ;; under the name of the visited file.
1213 auto-save-visited-file-name))
1216 buffer-file-name))
1230 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1231 "Use M-x make-directory RET RET to create the directory"
1239 ;; Make people do a little extra work (C-x C-q)
1240 ;; before altering a backup file.
1244 nil
1254 "Choose the major mode for this buffer automatically.
1255 Also sets up any specified local variables of the file.
1256 Uses the visited file name, the -*- line, and the local variables spec.
1258 This function is called automatically from `find-file'. In that case,
1259 we may set up the file-specified mode and local variables,
1260 depending on the value of `enable-local-variables': if it is t, we do;
1261 if it is nil, we don't; otherwise, we query.
1262 In addition, if `local-enable-local-variables' is nil, we do
1263 not set local variables (though we do notice a mode specified with -*-.)
1265 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1266 or from Lisp without specifying the optional argument FIND-FILE;
1267 in that case, this function acts as if `enable-local-variables' were t."
1276 enable-local-variables)))
1314 ;;; Less common extensions come here
1315 ;;; so more common ones above are found faster.
1325 ;; for MSDOS and MS-Windows (which are case-insensitive)
1340 ;;; The following should come after the ChangeLog pattern
1341 ;;; for the sake of ChangeLog.1, etc.
1342 ;;; and after the .scm.[0-9] pattern too.
1373 ;; Mailer puts message to be edited in
1374 ;; /tmp/Re.... or Message
1379 ;; some news reader is reported to use this
1389 ;; .emacs following a directory delimiter
1390 ;; in Unix, MSDOG or VMS syntax.
1393 ;; _emacs following a directory delimiter
1394 ;; in MsDos syntax
1407 "\
1408 Alist of filename patterns vs corresponding major mode functions.
1409 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1410 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1411 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1412 mode function to use. FUNCTION will be called, unless it is nil.
1414 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1415 calling FUNCTION (if it's not nil), we delete the suffix that matched
1457 "Alist mapping interpreter names to major modes.
1458 This alist applies to files whose first line starts with `#!'.
1459 Each element looks like (INTERPRETER . MODE).
1460 The car of each element is compared with
1461 the name of the interpreter specified in the first line.
1468 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1469 When checking `inhibit-first-line-modes-regexps', we first discard
1473 "Select major mode appropriate for current buffer.
1474 This checks for a -*- mode tag in the buffer's text,
1475 compares the filename against the entries in `auto-mode-alist',
1476 or checks the interpreter that runs this file against
1477 `interpreter-mode-alist'.
1479 It does not check for the `mode:' local variable in the
1480 Local Variables section of the file; for that, use `hack-local-variables'.
1482 If `enable-local-variables' is nil, this function does not check for a
1483 -*- mode tag.
1485 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1486 then we do not set anything but the major mode,
1487 and we don't even do that unless it would come from the file name."
1488 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1494 ;; Don't look for -*- if this file name matches any
1495 ;; of the regexps in inhibit-first-line-modes-regexps.
1503 sufs)
1510 ;; If the file begins with "#!"
1511 ;; (exec interpreter magic), look
1512 ;; for mode frobs in the first two
1513 ;; lines. You cannot necessarily
1514 ;; put them in the first line of
1515 ;; such a file without screwing up
1516 ;; the interpreter invocation.
1524 t))
1531 ;; Find all specifications for the `mode:' variable
1532 ;; and execute them left to right.
1544 modes)))
1545 ;; Simple -*-MODE-*- case.
1548 modes))))))
1549 ;; If we found modes to use, invoke them now,
1550 ;; outside the save-excursion.
1555 ;; If we didn't find a mode from a -*- line, try using the file name.
1559 ;; Remove backup-suffixes from file name.
1565 ;; Find first matching alist entry.
1575 keep-going t))
1577 keep-going nil)))
1580 ;; When JUST-FROM-FILE-NAME is set,
1581 ;; we are working on behalf of set-visited-file-name.
1582 ;; In that case, if the major mode specified is the
1583 ;; same one we already have, don't actually reset it.
1584 ;; We don't want to lose minor modes such as Font Lock.
1587 ;; If we can't deduce a mode from the file name,
1588 ;; look for an interpreter specified in the first line.
1589 ;; As a special case, allow for things like "#!/bin/env perl",
1590 ;; which finds the interpreter anywhere in $PATH.
1598 elt)
1599 ;; Map interpreter name to a mode.
1601 interpreter-mode-alist))
1607 ;; Set local variables specified in the -*- line.
1608 ;; Ignore any specification for `mode:' and `coding:';
1609 ;; set-auto-mode should already have handled `mode:',
1610 ;; set-auto-coding should already have handled `coding:'.
1617 ;; Parse the -*- line into the `result' alist.
1619 ;; doesn't have one.
1620 nil)
1622 ;; Simple form: "-*- MODENAME -*-". Already handled.
1623 nil)
1625 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1626 ;; (last ";" is optional).
1635 ;; There used to be a downcase here,
1636 ;; but the manual didn't say so,
1637 ;; and people want to set var names that aren't all lc.
1644 ;; It is traditional to ignore
1645 ;; case when checking for `mode' in set-auto-mode,
1646 ;; so we must do that here as well.
1647 ;; That is inconsistent, but we're stuck with it.
1648 ;; The same can be said for `coding' in set-auto-coding.
1662 ;; If we fail to switch in the selected window,
1663 ;; it is probably a minibuffer.
1664 ;; So try another window.
1677 "Normal hook run after processing a file's local variables specs.
1678 Major modes can use this to examine user-specified local variables
1682 "Parse and put into effect this buffer's local variables spec.
1683 If MODE-ONLY is non-nil, all we do is check whether the major mode
1684 is specified, returning t if it is specified."
1687 ;; Look for "Local variables:" line in last page.
1697 mode-only
1707 buffer-file-name)
1711 prefix prefixlen suffix beg
1712 mode-specified
1714 ;; The prefix is what comes before "local variables:" in its line.
1715 ;; The suffix is what comes after "local variables:" in its line.
1730 ;; Look at next local variable spec.
1733 ;; Skip the prefix, if any.
1738 ;; Find the variable name; strip whitespace.
1746 val)
1747 ;; Setting variable named "end" means end of list.
1750 ;; Otherwise read the variable value.
1761 ;; Set the variable. "Variables" mode and eval are funny.
1765 mode-specified))
1771 ;; Get confirmation before setting these variables as locals in a file.
1788 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1792 ;; This one is safe because the user gets to check it before it is used.
1798 ;; "Set" one variable in a local variables spec.
1799 ;; A few variable names are treated specially.
1805 ;; We have already handled coding: tag in set-auto-coding.
1806 nil)
1808 nil)
1809 ;; "Setting" eval means either eval it or do nothing.
1810 ;; Likewise for setting hook variables.
1816 ;; Permit evalling a put of a harmless property.
1817 ;; if the args do nothing tricky.
1823 ;; Only allow safe values of lisp-indent-hook;
1824 ;; not functions.
1829 ;; Permit eval if not root and user says ok.
1848 ;; Ordinary variable, really set it.
1852 \f
1855 However, the mode will not be changed if
1856 \(1) a local variables list or the `-*-' line specifies a major mode, or
1858 \ not suitable for ordinary files, or
1859 \(3) the new file name does not particularly specify any mode."
1864 "Change name of file visited in current buffer to FILENAME.
1865 The next time the buffer is saved it will go in the newly specified file.
1866 nil or empty string as argument means make buffer not be visiting any file.
1867 Remember to delete the initial contents of the minibuffer
1868 if you wish to pass an empty string as the argument.
1870 The optional second argument NO-QUERY, if non-nil, inhibits asking for
1871 confirmation in the case where another buffer is already visiting FILENAME.
1873 The optional third argument ALONG-WITH-FILE, if non-nil, means that
1874 the old visited file has been renamed to the new name FILENAME."
1882 nil
1893 filename)))
1912 ;; Abbreviate the file names of the buffer.
1921 nil)))
1922 ;; write-file-hooks is normally used for things like ftp-find-file
1923 ;; that visit things that are not local files as if they were files.
1924 ;; Changing to visit an ordinary local file instead should flush the hook.
1929 ;; If buffer was read-only because of version control,
1930 ;; that reason is gone now, so make it writable.
1934 ;; Turn off backup files for certain file names.
1935 ;; Since this is a permanent local, the major mode won't eliminate it.
1942 ;; If auto-save was not already on, turn it on if appropriate.
1946 ;; If auto save is on, start using a new name.
1947 ;; We deliberately don't rename or delete the old auto save
1948 ;; for the old visited file name. This is because perhaps
1949 ;; the user wants to save the new state and then compare with the
1950 ;; previous state from the auto save file.
1953 ;; Rename the old auto save file if any.
1960 ;; Update the major mode, if the file name determines it.
1962 ;; Don't change the mode if it is special.
1965 ;; Don't change the mode if the local variable list specifies it.
1971 "Write current buffer into file FILENAME.
1972 This makes the buffer visit that file, and marks it as not modified.
1974 If you specify just a directory name as FILENAME, that means to use
1975 the default file name but in that directory. You can also yank
1976 the default file name into the minibuffer to edit it, using M-n.
1978 If the buffer is not already visiting a file, the default file name
1979 for the output file is the buffer name.
1981 If optional second arg CONFIRM is non-nil, this function
1982 asks for confirmation before overwriting an existing file.
1983 Interactively, confirmation is required unless you supply a prefix argument."
1984 ;; (interactive "FWrite file: ")
1988 nil nil nil nil)
1992 default-directory)
1993 nil nil))
1997 ;; If arg is just a directory,
1998 ;; use the default file name, but in that directory.
2009 ;; Make buffer writable if file is writable.
2014 \f
2016 "Make a backup of the disk file visited by the current buffer, if appropriate.
2017 This is normally done before saving the buffer the first time.
2018 If the value is non-nil, it is the result of `file-modes' on the original
2019 file; this means that the caller, after saving the buffer, should change
2020 the modes of the new file to agree with the old modes.
2022 A backup may be done by renaming or by copying; see documentation of
2023 variable `make-backup-files'. If it's done by renaming, then the file is
2024 no longer accessible under its old name."
2031 backup-info backupname targets setmodes)
2032 ;; If specified name is a symbolic link, chase it to the target.
2033 ;; Thus we make the backups in the directory where the real file is.
2038 ;;; (if (file-directory-p buffer-file-name)
2039 ;;; (error "Cannot save buffer in directory %s" buffer-file-name))
2043 ;; If have old versions to maybe delete,
2044 ;; ask the user to confirm now, before doing anything.
2045 ;; But don't actually delete til later.
2050 real-file-name))))))
2051 ;; Actually write the back up file.
2054 ; (file-symlink-p buffer-file-name)
2055 backup-by-copying
2070 ;; If copying fails because file BACKUPNAME
2071 ;; is not writable, delete that file and try again.
2076 ;; rename-file should delete old backup.
2080 ;; If trouble writing the backup, write it in ~.
2090 ;; If copying fails because file BACKUPNAME
2091 ;; is not writable, delete that file and try again.
2097 ;; Now delete the old versions, if desired.
2104 setmodes)
2108 "Return FILENAME sans backup versions or strings.
2109 This is a separate procedure so your site-init or startup file can
2110 redefine it.
2111 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2112 we do not remove backup version numbers, only true file version numbers."
2118 ;; VMS version number is (a) semicolon, optional
2119 ;; sign, zero or more digits or (b) period, option
2120 ;; sign, zero or more digits, provided this is the
2121 ;; second period encountered outside of the
2122 ;; device/directory part of the file name.
2125 name)
2135 "Returns t if deleting FILE and rewriting it would preserve the owner."
2140 ;; Return t if the file doesn't exist, since it's true that no
2141 ;; information would be lost by an (attempted) delete and create.
2147 The extension, in a file name, is the part that follows the last `.'."
2150 directory)
2154 directory)
2156 filename))))
2160 The extension, in a file name, is the part that follows the last `.'.
2161 Return nil for extensionless file names such as `foo'.
2162 Return the empty string for file names such as `foo.'.
2164 If PERIOD is non-nil, then the returned value includes the period
2165 that delimits the extension, and if FILENAME has no extension,
2175 "Create the non-numeric backup file name for FILE.
2176 This is a separate function so you can redefine it for customization."
2189 "Return non-nil if FILE is a backup file name (numeric or not).
2190 This is a separate function so you can redefine it for customization.
2191 You may need to redefine `file-name-sans-versions' as well."
2196 ;; This is used in various files.
2197 ;; The usage of backup-extract-version-start is not very clean,
2198 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2200 "Given the name of a numeric backup file, return the backup number.
2201 Uses the free variable `backup-extract-version-start', whose value should be
2202 the index in the name where the version number begins."
2208 ;; I believe there is no need to alter this behavior for VMS;
2209 ;; since backup files are not made on VMS, it should not get called.
2211 "Find a file name for a backup file, and suggestions for deletions.
2212 Value is a list whose car is the name for the backup file
2213 and whose cdr is a list of old versions to consider deleting now.
2214 If the value is nil, don't make a backup."
2216 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2223 possibilities
2230 base-versions
2234 possibilities)
2235 '<)
2247 ;; Delete nothing if there is overflow
2248 ;; in the number of versions to keep.
2254 v))))))))))
2257 "Return number of names file FILENAME has."
2261 "Convert FILENAME to be relative to DIRECTORY (default: default-directory).
2262 This function returns a relative file name which is equivalent to FILENAME
2263 when used with that default directory as the default.
2264 If this is impossible (which can happen on MSDOS and Windows
2265 when the file name and directory use different drive names)
2266 then it returns FILENAME."
2271 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2272 ;; drive names, they can't be relative, so return the absolute name.
2277 filename
2284 ".."
2286 ;; Now ancestor is empty, or .., or ../.., etc.
2288 ;; We matched within FNAME's directory part.
2289 ;; Add the rest of FNAME onto ANCESTOR.
2293 ;; But don't bother with ANCESTOR if it would give us `./'.
2294 rest
2296 ;; We matched FNAME's directory equivalent.
2297 ancestor))))))
2298 \f
2300 "Save current buffer in visited file if modified. Versions described below.
2301 By default, makes the previous version into a backup file
2302 if previously requested or if this is the first save.
2304 to become a backup when the next save is done.
2306 unconditionally makes the previous version into a backup file.
2308 to become a backup when the next save is done,
2309 and unconditionally makes the previous version into a backup file.
2311 With argument of 0, never make the previous version into a backup file.
2313 If a file's name is FOO, the names of its numbered backup versions are
2314 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2315 Numeric backups (rather than FOO~) will be made if value of
2316 `version-control' is not the atom `never' and either there are already
2317 numeric versions of the file being backed up, or `version-control' is
2318 non-nil.
2319 We don't want excessive versions piling up, so there are variables
2320 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2321 and `kept-new-versions', which tells how many newest versions to keep.
2322 Defaults are 2 old versions and 2 new.
2323 `dired-kept-versions' controls dired's clean-directory (.) command.
2324 If `delete-old-versions' is nil, system will query user
2325 before trimming versions. Otherwise it does it silently.
2327 If `vc-make-backup-files' is nil, which is the default,
2328 no backup files are made for files managed by version control.
2329 (This is because the version control system itself records previous versions.)
2331 See the subroutine `basic-save-buffer' for more information."
2343 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2344 Normally delete only if the file was written by this Emacs since
2345 the last real save, but optional arg FORCE non-nil means delete anyway."
2362 "If non-nil, use this coding system for saving the buffer.
2363 More precisely, use this coding system in place of the
2364 value of `buffer-file-coding-system', when saving the buffer.
2365 Calling `write-region' for any purpose other than saving the buffer
2366 will still use `buffer-file-coding-system'; this variable has no effect
2373 "Save the current buffer in its visited file, if it has been modified.
2374 The hooks `write-contents-hooks', `local-write-file-hooks' and
2375 `write-file-hooks' get a chance to do the job of saving; if they do not,
2376 then the buffer is saved in the visited file file in the usual way.
2377 After saving the buffer, this function runs `after-save-hook'."
2380 ;; In an indirect buffer, save its base buffer instead.
2385 setmodes tempsetmodes)
2386 ;; On VMS, rename file and buffer to get rid of version number.
2391 ;; Strip VMS version number before save.
2394 ;; Construct a (unique) buffer name to correspond.
2399 ;; If buffer has no file name, ask user for one.
2406 filename))
2433 ;; If a hook returned t, file is already "written".
2434 ;; Otherwise, write it the usual way now.
2436 ;; Now we have saved the current buffer. Let's make sure
2437 ;; that buffer-file-coding-system is fixed to what
2438 ;; actually used for saving by binding it locally.
2448 ;; If the auto-save file was recent before this command,
2449 ;; delete it now.
2451 ;; Support VC `implicit' locking.
2456 ;; This does the "real job" of writing a buffer into its visited file
2457 ;; and making a backup file. This is what is normally done
2458 ;; but inhibited if one of write-file-hooks returns non-nil.
2459 ;; It returns a value to store in setmodes.
2479 buffer-file-name)))
2487 ;; If file is precious, write temp name, then rename it.
2488 ;; This requires write access to the containing dir,
2489 ;; which is why we don't try it if we don't have that access.
2491 tempname temp nogood i succeed
2495 ;; Find the temporary name to write under.
2502 dir i))
2508 tempname nil realname
2509 buffer-file-truename)
2511 ;; If writing the temp file fails,
2512 ;; delete the temp file.
2517 ;; Since we have created an entirely new file
2518 ;; and renamed it, make sure it gets the
2519 ;; right permission bits set.
2521 ;; We succeeded in writing the temp file,
2522 ;; so rename it.
2524 ;; If file not writable, see if we can make it writable
2525 ;; temporarily while we write it.
2526 ;; But no need to do so if we have just backed it up
2527 ;; (setmodes is set) because that says we're superseding.
2529 ;; Change the mode back, after writing.
2533 buffer-file-name nil t buffer-file-truename)))
2534 setmodes))
2537 "Save some modified file-visiting buffers. Asks user about each one.
2538 Optional argument (the prefix) non-nil means save all with no questions.
2539 Optional second argument PRED determines which buffers are considered:
2540 If PRED is nil, all the file-visiting buffers are considered.
2541 If PRED is t, then certain non-file buffers will also be considered.
2542 If PRED is a zero-argument function, it indicates for each buffer whether
2543 to consider it or not."
2562 t
2581 ;; Return nil to ask about BUF again.
2582 nil)
2589 abbrev-file-name)))
2591 ;; Don't keep bothering user if he says no.
2593 t))))
2596 \f
2598 "Mark current buffer as unmodified, not needing to be saved.
2601 It is not a good idea to use this function in Lisp programs, because it
2602 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2609 "Change whether this buffer is visiting its file read-only.
2610 With arg, set read-only iff arg is positive.
2611 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
2617 ;; Toggle.
2629 "Insert contents of file FILENAME into buffer after point.
2630 Set mark after the inserted text.
2632 This function is meant for the user to run interactively.
2633 Don't call it from programs! Use `insert-file-contents' instead.
2634 \(Its calling sequence is different; see its documentation)."
2638 filename)))
2643 "Append the contents of the region to the end of file FILENAME.
2644 When called from a function, expects three arguments,
2645 START, END and FILENAME. START and END are buffer positions
2646 saying what text to write."
2651 "Return most recent backup file for FILENAME or nil if no backups exist."
2657 tem)
2667 newest))
2670 "Rename current buffer to a similar name not already taken.
2671 This function is useful for creating multiple shell process buffers
2672 or multiple mail buffers, etc."
2680 ;; If the existing buffer name has a <NNN>,
2681 ;; which isn't part of the file name (if any),
2682 ;; then get rid of that.
2688 "Create the directory DIR and any nonexistent parent dirs.
2689 Interactively, the default choice of directory to create
2690 is the current default directory for file names.
2691 That is useful when you have visited a file in a nonexistent directory.
2693 Noninteractively, the second (optional) argument PARENTS says whether
2694 to create parent directories if they don't exist."
2697 nil nil)
2698 t))
2705 create-list)
2712 \f
2715 "Function to use to revert this buffer, or nil to do the default.
2716 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2721 "Function to use to insert contents when reverting this buffer.
2722 Gets two args, first the nominal file name to use,
2723 and second, t if reading the auto-save file.
2728 "Normal hook for `revert-buffer' to run before reverting.
2729 If `revert-buffer-function' is used to override the normal revert
2733 "Normal hook for `revert-buffer' to run after reverting.
2734 Note that the hook value that it runs is the value that was in effect
2735 before reverting; that makes a difference if you have buffer-local
2736 hook functions.
2738 If `revert-buffer-function' is used to override the normal revert
2744 "Replace current buffer text with the text of the visited file on disk.
2745 This undoes all changes since the file was visited or saved.
2746 With a prefix argument, offer to revert from latest auto-save file, if
2747 that is more recent than the visited file.
2749 This command also works for special buffers that contain text which
2750 doesn't come from a file, but reflects some other data base instead:
2751 for example, Dired buffers and buffer-list buffers. In these cases,
2752 it reconstructs the buffer contents from the appropriate data base.
2754 When called from Lisp, the first argument is IGNORE-AUTO; only offer
2755 to revert from the auto-save file when this is nil. Note that the
2756 sense of this argument is the reverse of the prefix argument, for the
2757 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2758 to nil.
2760 Optional second argument NOCONFIRM means don't ask for confirmation at
2761 all. (The local variable `revert-without-query', if non-nil, prevents
2762 confirmation.)
2764 Optional third argument PRESERVE-MODES non-nil means don't alter
2765 the files modes. Normally we reinitialize them using `normal-mode'.
2767 If the value of `revert-buffer-function' is non-nil, it is called to
2768 do all the work for this command. Otherwise, the hooks
2769 `before-revert-hook' and `after-revert-hook' are run at the beginning
2770 and the end, and if `revert-buffer-insert-file-contents-function' is
2771 non-nil, it is called instead of rereading visited file contents."
2773 ;; I admit it's odd to reverse the sense of the prefix argument, but
2774 ;; there is a lot of code out there which assumes that the first
2775 ;; argument should be t to avoid consulting the auto-save file, and
2776 ;; there's no straightforward way to encourage authors to notice a
2777 ;; reversal of the argument sense. So I'm just changing the user
2778 ;; interface, but leaving the programmatic interface the same.
2784 buffer-auto-save-file-name
2789 buffer-auto-save-file-name
2790 buffer-file-name)))
2801 found))
2803 file-name)))
2805 ;; If file was backed up but has changed since,
2806 ;; we shd make another backup.
2810 ;; Get rid of all undo records for this buffer.
2813 ;; Effectively copy the after-revert-hook status,
2814 ;; since after-find-file will clobber it.
2818 after-revert-hook)))
2820 ;; Don't make undo records for the reversion.
2824 file-name auto-save-p)
2827 ;; Bind buffer-file-name to nil
2828 ;; so that we don't try to lock the file.
2834 ;; Auto-saved file shoule be read without
2835 ;; any code conversion.
2837 coding-system-for-read)))
2838 ;; Note that this preserves point in an intelligent way.
2840 nil nil t))))
2841 ;; Recompute the truename in case changes in symlinks
2842 ;; have changed the truename.
2846 ;; Run after-revert-hook as it was before we reverted.
2854 t)))))
2857 "Visit file FILE, but get contents from its last auto-save file."
2858 ;; Actually putting the file name in the minibuffer should be used
2859 ;; only rarely.
2860 ;; Not just because users often use the default.
2877 file file-name)))
2881 ;; Keep the current buffer-file-coding-system.
2883 ;; Auto-saved file shoule be read without any code conversion.
2892 "Recover auto save files from a previous Emacs session.
2893 This command first displays a Dired buffer showing you the
2894 previous sessions that you could recover from.
2895 To choose one, move point to the proper line and then type C-c C-c.
2896 Then you'll be asked about a number of files to recover."
2907 ;; Each line starts with a space
2908 ;; so that Font Lock mode won't highlight the first character.
2917 "Choose one saved session to recover auto-save files from.
2918 This command is used in the special Dired buffer created by
2921 ;; Get the name of the session file to recover from.
2923 files
2929 ;; Read in the auto-save-list file.
2933 ;; Loop thru the text of that file
2934 ;; and get out the names of the files to recover.
2938 ;; This is a pair of lines for a non-file-visiting buffer.
2939 ;; Get the auto-save file name and manufacture
2940 ;; a "visited file name" from that.
2956 ;; This pair of lines is a file-visiting
2957 ;; buffer. Use the visited file name.
2967 ;; Ignore a file if its auto-save file does not exist now.
2971 ;; The file contains a pair of line for each auto-saved buffer.
2972 ;; The first line of the pair contains the visited file name
2973 ;; or is empty if the buffer was not visiting a file.
2974 ;; The second line is the auto-save file name.
2982 files
2988 "For each buffer in LIST, ask whether to kill it.
2989 LIST defaults to all existing live buffers."
3000 name
3005 \f
3007 "Toggle auto-saving of contents of current buffer.
3008 With prefix argument ARG, turn auto-saving on if positive, else off."
3013 ;; If auto-save is off because buffer has shrunk,
3014 ;; then toggling should turn it on.
3019 buffer-file-name
3021 ;; If -1 was stored here, to temporarily turn off saving,
3022 ;; turn it back on.
3028 buffer-auto-save-file-name)
3031 "Adjust current buffer's auto save file name for current conditions.
3032 Also rename any existing auto save file, if it was made in this session."
3044 "Return file name to use for auto-saves of current buffer.
3045 Does not consider `auto-save-visited-file-name' as that variable is checked
3046 before calling this function. You can redefine this for customization.
3047 See also `auto-save-file-name-p'."
3057 "#"
3061 ;; Deal with buffers that don't have any associated files. (Mail
3062 ;; mode tends to create a good number of these.)
3066 ;; Eliminate all slashes and backslashes by
3067 ;; replacing them with sequences that start with %.
3068 ;; Quote % also, to keep distinct names distinct.
3077 ;; Generate the file name.
3080 ;; Try a few alternative directories, to get one we can write it.
3087 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3088 FILENAME should lack slashes. You can redefine this for customization."
3090 \f
3092 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3093 The generated regexp will match a filename iff the filename
3094 matches that wildcard according to shell rules. Only wildcards known
3095 by `sh' are supported."
3097 ;; Copy the initial run of non-special characters.
3100 ;; If no special characters, we're almost done.
3104 j)
3106 result
3127 ;; Found "[^". Insert a `\0' character
3128 ;; (which cannot happen in a filename)
3129 ;; into the character class, so that `^'
3130 ;; is not the first character after `[',
3131 ;; and thus non-special in a regexp.
3136 ;; I don't think `]' can appear in a
3137 ;; character class in a wildcard, but
3138 ;; let's be general here.
3145 i
3158 ;; Shell wildcards should match the entire filename,
3159 ;; not its part. Make the regexp say so.
3161 \f
3164 "*Switches for list-directory to pass to `ls' for brief listing,"
3170 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3172 "*Switches for list-directory to pass to `ls' for verbose listing,"
3177 "Expand wildcard pattern PATTERN.
3178 This returns a list of file names which match the pattern.
3180 If PATTERN is written as an absolute relative file name,
3181 the values are absolute also.
3183 If PATTERN is written as a relative file name, it is interpreted
3184 relative to the current default directory, `default-directory'.
3185 The file names returned are normally also relative to the current
3186 default directory. However, if FULL is non-nil, they are absolute."
3189 ;; A list of all dirs that DIRPART specifies.
3190 ;; This can be more than one dir
3191 ;; if DIRPART contains wildcards.
3196 contents)
3201 ;; Filter out "." and ".."
3206 name))
3213 this-dir-contents)
3214 this-dir-contents)
3215 contents))))
3217 contents))
3220 "Display a list of files in or matching DIRNAME, a la `ls'.
3221 DIRNAME is globbed by the shell if necessary.
3222 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3223 Actions controlled by variables `list-directory-brief-switches'
3224 and `list-directory-verbose-switches'."
3228 nil default-directory nil)
3229 pfx)))
3231 list-directory-brief-switches)))
3251 ;; insert-directory
3252 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3253 ;; FULL-DIRECTORY-P is nil.
3254 ;; The single line of output must display FILE's name as it was
3255 ;; given, namely, an absolute path name.
3256 ;; - must insert exactly one line for each file if WILDCARD or
3257 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
3258 ;; before the file lines, plus optional text after the file lines.
3259 ;; Lines are delimited by "\n", so filenames containing "\n" are not
3260 ;; allowed.
3261 ;; File lines should display the basename.
3262 ;; - must be consistent with
3263 ;; - functions dired-move-to-filename, (these two define what a file line is)
3264 ;; dired-move-to-end-of-filename,
3265 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3266 ;; dired-insert-headerline
3267 ;; dired-after-subdir-garbage (defines what a "total" line is)
3268 ;; - variable dired-subdir-regexp
3270 "Insert directory listing for FILE, formatted according to SWITCHES.
3271 Leaves point after the inserted text.
3272 SWITCHES may be a string of options, or a list of strings.
3273 Optional third arg WILDCARD means treat FILE as shell wildcard.
3274 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3275 switches do not contain `d', so that a full listing is expected.
3277 This works by running a directory listing program
3278 whose name is in the variable `insert-directory-program'.
3279 If WILDCARD, it also runs the shell specified by `shell-file-name'."
3280 ;; We need the directory in order to find the right handler.
3285 wildcard full-directory-p)
3291 default-file-name-coding-system)))
3292 ;; This is to control encoding the arguments in call-process.
3296 ;; Run ls in the directory of the file pattern we asked for.
3303 ;; Quote some characters that have special meanings in shells;
3304 ;; but don't quote the wildcards--we want them to be special.
3305 ;; We also currently don't quote the quoting characters
3306 ;; in case people want to use them explicitly to quote
3307 ;; wildcard characters.
3316 insert-directory-program
3317 " -d "
3319 switches
3321 " -- "
3322 pattern)))
3323 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3324 ;; directory if FILE is a symbolic link.
3326 insert-directory-program nil t nil
3332 ;; Split the switches at any spaces
3333 ;; so we can pass separate options as separate args.
3336 list)
3340 ;; Avoid lossage if FILE starts with `-'.
3348 file)))))))))
3350 ;; We get here if ls failed.
3351 ;; Access the file to get a suitable error.
3355 "Functions to call with no arguments to query about killing Emacs.
3356 If any of these functions returns nil, killing Emacs is cancelled.
3358 but `kill-emacs', the low level primitive, does not.
3362 "Offer to save each buffer, then kill this Emacs process.
3363 With prefix arg, silently save all file-visiting buffers, then kill."
3372 ;; process-list is not defined on VMS.
3374 active)
3379 val)
3385 ;; Query the user for other things, perhaps.
3388 \f
3389 ;; We use /: as a prefix to "quote" a file name
3390 ;; so that magic file name handlers will not apply to it.
3394 file-name-handler-alist))
3396 ;; We depend on being the last handler on the list,
3397 ;; so that anything else which does need handling
3398 ;; has been handled already.
3399 ;; So it is safe for us to inhibit *all* magic file name handlers.
3408 default-directory))
3409 ;; Get a list of the indices of the args which are file names.
3412 ;; The first four are special because they
3413 ;; return a file name. We want to include the /:
3414 ;; in the return value.
3415 ;; So just avoid stripping it in the first place.
3417 ;; `identity' means just return the first arg
3418 ;; as stripped of its quoting.
3429 ;; For all other operations, treat the first argument only
3430 ;; as the file name.
3432 ;; Copy ARGUMENTS so we can replace elements in it.
3434 ;; Strip off the /: from the file names that have this handler.
3442 "/"
3448 \f
3471 ;;; files.el ends here