Mercurial > emacs
annotate lispref/files.texi @ 28043:6070092c3b29
*** empty log message ***
author | Dave Love <fx@gnu.org> |
---|---|
date | Tue, 07 Mar 2000 20:31:06 +0000 |
parents | c41efa6c4be1 |
children | 25557ce6a3a0 |
rev | line source |
---|---|
6555 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
27189 | 3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999 |
4 @c Free Software Foundation, Inc. | |
6555 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/files | |
7 @node Files, Backups and Auto-Saving, Documentation, Top | |
8 @comment node-name, next, previous, up | |
9 @chapter Files | |
10 | |
11 In Emacs, you can find, create, view, save, and otherwise work with | |
12 files and file directories. This chapter describes most of the | |
13 file-related functions of Emacs Lisp, but a few others are described in | |
14 @ref{Buffers}, and those related to backups and auto-saving are | |
15 described in @ref{Backups and Auto-Saving}. | |
16 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
17 Many of the file functions take one or more arguments that are file |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
18 names. A file name is actually a string. Most of these functions |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
19 expand file name arguments by calling @code{expand-file-name}, so that |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
20 @file{~} is handled correctly, as are relative file names (including |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
21 @samp{../}). These functions don't recognize environment variable |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
22 substitutions such as @samp{$HOME}. @xref{File Name Expansion}. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
23 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
24 When file I/O functions signal Lisp errors, they usually use the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
25 condition @code{file-error} (@pxref{Handling Errors}). The error |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
26 message is in most cases obtained from the operating system, according |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
27 to locale @code{system-message-locale}, and decoded using coding system |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
28 @code{locale-coding-system} (@pxref{Locales}). |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
29 |
6555 | 30 @menu |
31 * Visiting Files:: Reading files into Emacs buffers for editing. | |
32 * Saving Buffers:: Writing changed buffers back into files. | |
33 * Reading from Files:: Reading files into buffers without visiting. | |
34 * Writing to Files:: Writing new files from parts of buffers. | |
35 * File Locks:: Locking and unlocking files, to prevent | |
36 simultaneous editing by two people. | |
37 * Information about Files:: Testing existence, accessibility, size of files. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
38 * Changing Files:: Renaming files, changing protection, etc. |
6555 | 39 * File Names:: Decomposing and expanding file names. |
40 * Contents of Directories:: Getting a list of the files in a directory. | |
41 * Create/Delete Dirs:: Creating and Deleting Directories. | |
42 * Magic File Names:: Defining "magic" special handling | |
43 for certain file names. | |
12067 | 44 * Format Conversion:: Conversion to and from various file formats. |
6555 | 45 @end menu |
46 | |
47 @node Visiting Files | |
48 @section Visiting Files | |
49 @cindex finding files | |
50 @cindex visiting files | |
51 | |
52 Visiting a file means reading a file into a buffer. Once this is | |
53 done, we say that the buffer is @dfn{visiting} that file, and call the | |
54 file ``the visited file'' of the buffer. | |
55 | |
56 A file and a buffer are two different things. A file is information | |
57 recorded permanently in the computer (unless you delete it). A buffer, | |
58 on the other hand, is information inside of Emacs that will vanish at | |
59 the end of the editing session (or when you kill the buffer). Usually, | |
60 a buffer contains information that you have copied from a file; then we | |
61 say the buffer is visiting that file. The copy in the buffer is what | |
62 you modify with editing commands. Such changes to the buffer do not | |
63 change the file; therefore, to make the changes permanent, you must | |
64 @dfn{save} the buffer, which means copying the altered buffer contents | |
65 back into the file. | |
66 | |
67 In spite of the distinction between files and buffers, people often | |
68 refer to a file when they mean a buffer and vice-versa. Indeed, we say, | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
69 ``I am editing a file,'' rather than, ``I am editing a buffer that I |
6555 | 70 will soon save as a file of the same name.'' Humans do not usually need |
71 to make the distinction explicit. When dealing with a computer program, | |
72 however, it is good to keep the distinction in mind. | |
73 | |
74 @menu | |
75 * Visiting Functions:: The usual interface functions for visiting. | |
76 * Subroutines of Visiting:: Lower-level subroutines that they use. | |
77 @end menu | |
78 | |
79 @node Visiting Functions | |
80 @subsection Functions for Visiting Files | |
81 | |
82 This section describes the functions normally used to visit files. | |
83 For historical reasons, these functions have names starting with | |
84 @samp{find-} rather than @samp{visit-}. @xref{Buffer File Name}, for | |
85 functions and variables that access the visited file name of a buffer or | |
86 that find an existing buffer by its visited file name. | |
87 | |
12098 | 88 In a Lisp program, if you want to look at the contents of a file but |
89 not alter it, the fastest way is to use @code{insert-file-contents} in a | |
90 temporary buffer. Visiting the file is not necessary and takes longer. | |
91 @xref{Reading from Files}. | |
92 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
93 @deffn Command find-file filename &optional wildcards |
6555 | 94 This command selects a buffer visiting the file @var{filename}, |
95 using an existing buffer if there is one, and otherwise creating a | |
96 new buffer and reading the file into it. It also returns that buffer. | |
97 | |
98 The body of the @code{find-file} function is very simple and looks | |
99 like this: | |
100 | |
101 @example | |
102 (switch-to-buffer (find-file-noselect filename)) | |
103 @end example | |
104 | |
105 @noindent | |
106 (See @code{switch-to-buffer} in @ref{Displaying Buffers}.) | |
107 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
108 If @var{wildcards} is non-@code{nil}, which is always true in an |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
109 interactive call, then @code{find-file} expands wildcard characters in |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
110 @var{filename} and visits all the matching files. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
111 |
6555 | 112 When @code{find-file} is called interactively, it prompts for |
113 @var{filename} in the minibuffer. | |
114 @end deffn | |
115 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
116 @defun find-file-noselect filename &optional nowarn rawfile wildcards |
6555 | 117 This function is the guts of all the file-visiting functions. It finds |
118 or creates a buffer visiting the file @var{filename}, and returns it. | |
119 It uses an existing buffer if there is one, and otherwise creates a new | |
120 buffer and reads the file into it. You may make the buffer current or | |
121 display it in a window if you wish, but this function does not do so. | |
122 | |
24952 | 123 If @var{wildcards} is non-@code{nil}, |
124 then @code{find-file-noselect} expands wildcard | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
125 characters in @var{filename} and visits all the matching files. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
126 |
6555 | 127 When @code{find-file-noselect} uses an existing buffer, it first |
128 verifies that the file has not changed since it was last visited or | |
129 saved in that buffer. If the file has changed, then this function asks | |
130 the user whether to reread the changed file. If the user says | |
131 @samp{yes}, any changes previously made in the buffer are lost. | |
132 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
133 This function displays warning or advisory messages in various peculiar |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
134 cases, unless the optional argument @var{nowarn} is non-@code{nil}. For |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
135 example, if it needs to create a buffer, and there is no file named |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
136 @var{filename}, it displays the message @samp{(New file)} in the echo |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
137 area, and leaves the buffer empty. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
138 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
139 The @code{find-file-noselect} function normally calls |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
140 @code{after-find-file} after reading the file (@pxref{Subroutines of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
141 Visiting}). That function sets the buffer major mode, parses local |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
142 variables, warns the user if there exists an auto-save file more recent |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
143 than the file just visited, and finishes by running the functions in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
144 @code{find-file-hooks}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
145 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
146 If the optional argument @var{rawfile} is non-@code{nil}, then |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
147 @code{after-find-file} is not called, and the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
148 @code{find-file-not-found-hooks} are not run in case of failure. What's |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
149 more, a non-@code{nil} @var{rawfile} value suppresses coding system |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
150 conversion (@pxref{Coding Systems}) and format conversion (@pxref{Format |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
151 Conversion}). |
6555 | 152 |
153 The @code{find-file-noselect} function returns the buffer that is | |
154 visiting the file @var{filename}. | |
155 | |
156 @example | |
157 @group | |
158 (find-file-noselect "/etc/fstab") | |
159 @result{} #<buffer fstab> | |
160 @end group | |
161 @end example | |
162 @end defun | |
163 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
164 @deffn Command find-file-other-window filename &optional wildcards |
6555 | 165 This command selects a buffer visiting the file @var{filename}, but |
166 does so in a window other than the selected window. It may use another | |
167 existing window or split a window; see @ref{Displaying Buffers}. | |
168 | |
169 When this command is called interactively, it prompts for | |
170 @var{filename}. | |
171 @end deffn | |
172 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
173 @deffn Command find-file-read-only filename &optional wildcards |
6555 | 174 This command selects a buffer visiting the file @var{filename}, like |
175 @code{find-file}, but it marks the buffer as read-only. @xref{Read Only | |
176 Buffers}, for related functions and variables. | |
177 | |
178 When this command is called interactively, it prompts for | |
179 @var{filename}. | |
180 @end deffn | |
181 | |
182 @deffn Command view-file filename | |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
183 This command visits @var{filename} using View mode, returning to the |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
184 previous buffer when you exit View mode. View mode is a minor mode that |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
185 provides commands to skim rapidly through the file, but does not let you |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
186 modify the text. Entering View mode runs the normal hook |
12098 | 187 @code{view-mode-hook}. @xref{Hooks}. |
6555 | 188 |
189 When @code{view-file} is called interactively, it prompts for | |
190 @var{filename}. | |
191 @end deffn | |
192 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
193 @tindex find-file-wildcards |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
194 @defvar find-file-wildcards |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
195 If this variable is non-@code{nil}, then the various @code{find-file} |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
196 commands check for wildcard characters and visit all the files that |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
197 match them. If this is @code{nil}, then wildcard characters are |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
198 not treated specially. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
199 @end defvar |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
200 |
6555 | 201 @defvar find-file-hooks |
202 The value of this variable is a list of functions to be called after a | |
203 file is visited. The file's local-variables specification (if any) will | |
204 have been processed before the hooks are run. The buffer visiting the | |
205 file is current when the hook functions are run. | |
206 | |
207 This variable works just like a normal hook, but we think that renaming | |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
208 it would not be advisable. @xref{Hooks}. |
6555 | 209 @end defvar |
210 | |
211 @defvar find-file-not-found-hooks | |
212 The value of this variable is a list of functions to be called when | |
213 @code{find-file} or @code{find-file-noselect} is passed a nonexistent | |
214 file name. @code{find-file-noselect} calls these functions as soon as | |
215 it detects a nonexistent file. It calls them in the order of the list, | |
216 until one of them returns non-@code{nil}. @code{buffer-file-name} is | |
217 already set up. | |
218 | |
219 This is not a normal hook because the values of the functions are | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
220 used, and in many cases only some of the functions are called. |
6555 | 221 @end defvar |
222 | |
223 @node Subroutines of Visiting | |
224 @comment node-name, next, previous, up | |
225 @subsection Subroutines of Visiting | |
226 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
227 The @code{find-file-noselect} function uses two important subroutines |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
228 which are sometimes useful in user Lisp code: @code{create-file-buffer} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
229 and @code{after-find-file}. This section explains how to use them. |
6555 | 230 |
231 @defun create-file-buffer filename | |
232 This function creates a suitably named buffer for visiting | |
233 @var{filename}, and returns it. It uses @var{filename} (sans directory) | |
234 as the name if that name is free; otherwise, it appends a string such as | |
235 @samp{<2>} to get an unused name. See also @ref{Creating Buffers}. | |
236 | |
237 @strong{Please note:} @code{create-file-buffer} does @emph{not} | |
238 associate the new buffer with a file and does not select the buffer. | |
12098 | 239 It also does not use the default major mode. |
6555 | 240 |
241 @example | |
242 @group | |
243 (create-file-buffer "foo") | |
244 @result{} #<buffer foo> | |
245 @end group | |
246 @group | |
247 (create-file-buffer "foo") | |
248 @result{} #<buffer foo<2>> | |
249 @end group | |
250 @group | |
251 (create-file-buffer "foo") | |
252 @result{} #<buffer foo<3>> | |
253 @end group | |
254 @end example | |
255 | |
256 This function is used by @code{find-file-noselect}. | |
257 It uses @code{generate-new-buffer} (@pxref{Creating Buffers}). | |
258 @end defun | |
259 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
260 @defun after-find-file &optional error warn noauto after-find-file-from-revert-buffer nomodes |
6555 | 261 This function sets the buffer major mode, and parses local variables |
262 (@pxref{Auto Major Mode}). It is called by @code{find-file-noselect} | |
263 and by the default revert function (@pxref{Reverting}). | |
264 | |
265 @cindex new file message | |
266 @cindex file open error | |
267 If reading the file got an error because the file does not exist, but | |
268 its directory does exist, the caller should pass a non-@code{nil} value | |
269 for @var{error}. In that case, @code{after-find-file} issues a warning: | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
270 @samp{(New file)}. For more serious errors, the caller should usually not |
6555 | 271 call @code{after-find-file}. |
272 | |
273 If @var{warn} is non-@code{nil}, then this function issues a warning | |
274 if an auto-save file exists and is more recent than the visited file. | |
275 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
276 If @var{noauto} is non-@code{nil}, that says not to enable or disable |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
277 Auto-Save mode. The mode remains enabled if it was enabled before. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
278 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
279 If @var{after-find-file-from-revert-buffer} is non-@code{nil}, that |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
280 means this call was from @code{revert-buffer}. This has no direct |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
281 effect, but some mode functions and hook functions check the value |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
282 of this variable. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
283 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
284 If @var{nomodes} is non-@code{nil}, that means don't alter the buffer's |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
285 major mode, don't process local variables specifications in the file, |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
286 and don't run @code{find-file-hooks}. This feature is used by |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
287 @code{revert-buffer} in some cases. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
288 |
6555 | 289 The last thing @code{after-find-file} does is call all the functions |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
290 in the list @code{find-file-hooks}. |
6555 | 291 @end defun |
292 | |
293 @node Saving Buffers | |
294 @section Saving Buffers | |
295 | |
296 When you edit a file in Emacs, you are actually working on a buffer | |
297 that is visiting that file---that is, the contents of the file are | |
298 copied into the buffer and the copy is what you edit. Changes to the | |
299 buffer do not change the file until you @dfn{save} the buffer, which | |
300 means copying the contents of the buffer into the file. | |
301 | |
302 @deffn Command save-buffer &optional backup-option | |
303 This function saves the contents of the current buffer in its visited | |
304 file if the buffer has been modified since it was last visited or saved. | |
305 Otherwise it does nothing. | |
306 | |
307 @code{save-buffer} is responsible for making backup files. Normally, | |
308 @var{backup-option} is @code{nil}, and @code{save-buffer} makes a backup | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
309 file only if this is the first save since visiting the file. Other |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
310 values for @var{backup-option} request the making of backup files in |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
311 other circumstances: |
6555 | 312 |
313 @itemize @bullet | |
314 @item | |
315 With an argument of 4 or 64, reflecting 1 or 3 @kbd{C-u}'s, the | |
316 @code{save-buffer} function marks this version of the file to be | |
317 backed up when the buffer is next saved. | |
318 | |
319 @item | |
320 With an argument of 16 or 64, reflecting 2 or 3 @kbd{C-u}'s, the | |
321 @code{save-buffer} function unconditionally backs up the previous | |
322 version of the file before saving it. | |
323 @end itemize | |
324 @end deffn | |
325 | |
26770
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
326 @deffn Command save-some-buffers &optional save-silently-p pred |
6555 | 327 This command saves some modified file-visiting buffers. Normally it |
328 asks the user about each buffer. But if @var{save-silently-p} is | |
329 non-@code{nil}, it saves all the file-visiting buffers without querying | |
330 the user. | |
331 | |
26770
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
332 The optional @var{pred} argument controls which buffers to ask about. |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
333 If it is @code{nil}, that means to ask only about file-visiting buffers. |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
334 If it is @code{t}, that means also offer to save certain other non-file |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
335 buffers---those that have a non-@code{nil} buffer-local value of |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
336 @code{buffer-offer-save}. (A user who says @samp{yes} to saving a |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
337 non-file buffer is asked to specify the file name to use.) The |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
338 @code{save-buffers-kill-emacs} function passes the value @code{t} for |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
339 @var{pred}. |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
340 |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
341 If @var{pred} is neither @code{t} nor @code{nil}, then it should be |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
342 a function of no arguments. It will be called in each buffer to decide |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
343 whether to offer to save that buffer. If it returns a non-@code{nil} |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
344 value in a certain buffer, that means do offer to save that buffer. |
6555 | 345 @end deffn |
346 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
347 @deffn Command write-file filename &optional confirm |
6555 | 348 This function writes the current buffer into file @var{filename}, makes |
349 the buffer visit that file, and marks it not modified. Then it renames | |
350 the buffer based on @var{filename}, appending a string like @samp{<2>} | |
351 if necessary to make a unique buffer name. It does most of this work by | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
352 calling @code{set-visited-file-name} (@pxref{Buffer File Name}) and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
353 @code{save-buffer}. |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
354 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
355 If @var{confirm} is non-@code{nil}, that means to ask for confirmation |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
356 before overwriting an existing file. |
6555 | 357 @end deffn |
358 | |
15913
f415fdc67ad3
Add xrefs from Saving Buffers to Format Conversion and Saving
Richard M. Stallman <rms@gnu.org>
parents:
15765
diff
changeset
|
359 Saving a buffer runs several hooks. It also performs format |
f415fdc67ad3
Add xrefs from Saving Buffers to Format Conversion and Saving
Richard M. Stallman <rms@gnu.org>
parents:
15765
diff
changeset
|
360 conversion (@pxref{Format Conversion}), and may save text properties in |
f415fdc67ad3
Add xrefs from Saving Buffers to Format Conversion and Saving
Richard M. Stallman <rms@gnu.org>
parents:
15765
diff
changeset
|
361 ``annotations'' (@pxref{Saving Properties}). |
f415fdc67ad3
Add xrefs from Saving Buffers to Format Conversion and Saving
Richard M. Stallman <rms@gnu.org>
parents:
15765
diff
changeset
|
362 |
6555 | 363 @defvar write-file-hooks |
364 The value of this variable is a list of functions to be called before | |
365 writing out a buffer to its visited file. If one of them returns | |
366 non-@code{nil}, the file is considered already written and the rest of | |
367 the functions are not called, nor is the usual code for writing the file | |
368 executed. | |
369 | |
370 If a function in @code{write-file-hooks} returns non-@code{nil}, it | |
371 is responsible for making a backup file (if that is appropriate). | |
372 To do so, execute the following code: | |
373 | |
374 @example | |
375 (or buffer-backed-up (backup-buffer)) | |
376 @end example | |
377 | |
378 You might wish to save the file modes value returned by | |
379 @code{backup-buffer} and use that to set the mode bits of the file that | |
380 you write. This is what @code{save-buffer} normally does. | |
381 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
382 The hook functions in @code{write-file-hooks} are also responsible for |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
383 encoding the data (if desired): they must choose a suitable coding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
384 system (@pxref{Lisp and Coding Systems}), perform the encoding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
385 (@pxref{Explicit Encoding}), and set @code{last-coding-system-used} to |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
386 the coding system that was used (@pxref{Encoding and I/O}). |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
387 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
388 Do not make this variable buffer-local. To set up buffer-specific hook |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
389 functions, use @code{write-contents-hooks} instead. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
390 |
6555 | 391 Even though this is not a normal hook, you can use @code{add-hook} and |
392 @code{remove-hook} to manipulate the list. @xref{Hooks}. | |
393 @end defvar | |
394 | |
395 @c Emacs 19 feature | |
396 @defvar local-write-file-hooks | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
397 This works just like @code{write-file-hooks}, but it is intended to be |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
398 made buffer-local in particular buffers, and used for hooks that pertain |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
399 to the file name or the way the buffer contents were obtained. |
6555 | 400 |
401 The variable is marked as a permanent local, so that changing the major | |
402 mode does not alter a buffer-local value. This is convenient for | |
403 packages that read ``file'' contents in special ways, and set up hooks | |
404 to save the data in a corresponding way. | |
405 @end defvar | |
406 | |
407 @c Emacs 19 feature | |
408 @defvar write-contents-hooks | |
409 This works just like @code{write-file-hooks}, but it is intended for | |
410 hooks that pertain to the contents of the file, as opposed to hooks that | |
8364 | 411 pertain to where the file came from. Such hooks are usually set up by |
14152
9c9debb5950f
Clarify write-contents-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12674
diff
changeset
|
412 major modes, as buffer-local bindings for this variable. |
9c9debb5950f
Clarify write-contents-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12674
diff
changeset
|
413 |
9c9debb5950f
Clarify write-contents-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12674
diff
changeset
|
414 This variable automatically becomes buffer-local whenever it is set; |
9c9debb5950f
Clarify write-contents-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12674
diff
changeset
|
415 switching to a new major mode always resets this variable. When you use |
9c9debb5950f
Clarify write-contents-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12674
diff
changeset
|
416 @code{add-hooks} to add an element to this hook, you should @emph{not} |
9c9debb5950f
Clarify write-contents-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12674
diff
changeset
|
417 specify a non-@code{nil} @var{local} argument, since this variable is |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
418 used @emph{only} buffer-locally. |
6555 | 419 @end defvar |
420 | |
421 @c Emacs 19 feature | |
422 @defvar after-save-hook | |
423 This normal hook runs after a buffer has been saved in its visited file. | |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
424 One use of this hook is in Fast Lock mode; it uses this hook to save the |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
425 highlighting information in a cache file. |
6555 | 426 @end defvar |
427 | |
428 @defvar file-precious-flag | |
429 If this variable is non-@code{nil}, then @code{save-buffer} protects | |
430 against I/O errors while saving by writing the new file to a temporary | |
431 name instead of the name it is supposed to have, and then renaming it to | |
432 the intended name after it is clear there are no errors. This procedure | |
433 prevents problems such as a lack of disk space from resulting in an | |
434 invalid file. | |
435 | |
12226 | 436 As a side effect, backups are necessarily made by copying. @xref{Rename |
437 or Copy}. Yet, at the same time, saving a precious file always breaks | |
438 all hard links between the file you save and other file names. | |
6555 | 439 |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
440 Some modes give this variable a non-@code{nil} buffer-local value |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
441 in particular buffers. |
6555 | 442 @end defvar |
443 | |
444 @defopt require-final-newline | |
445 This variable determines whether files may be written out that do | |
446 @emph{not} end with a newline. If the value of the variable is | |
447 @code{t}, then @code{save-buffer} silently adds a newline at the end of | |
448 the file whenever the buffer being saved does not already end in one. | |
449 If the value of the variable is non-@code{nil}, but not @code{t}, then | |
450 @code{save-buffer} asks the user whether to add a newline each time the | |
451 case arises. | |
452 | |
453 If the value of the variable is @code{nil}, then @code{save-buffer} | |
454 doesn't add newlines at all. @code{nil} is the default value, but a few | |
455 major modes set it to @code{t} in particular buffers. | |
456 @end defopt | |
457 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
458 See also the function @code{set-visited-file-name} (@pxref{Buffer File |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
459 Name}). |
15765
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
460 |
6555 | 461 @node Reading from Files |
462 @comment node-name, next, previous, up | |
463 @section Reading from Files | |
464 | |
465 You can copy a file from the disk and insert it into a buffer | |
466 using the @code{insert-file-contents} function. Don't use the user-level | |
467 command @code{insert-file} in a Lisp program, as that sets the mark. | |
468 | |
469 @defun insert-file-contents filename &optional visit beg end replace | |
470 This function inserts the contents of file @var{filename} into the | |
12226 | 471 current buffer after point. It returns a list of the absolute file name |
6555 | 472 and the length of the data inserted. An error is signaled if |
473 @var{filename} is not the name of a file that can be read. | |
474 | |
12098 | 475 The function @code{insert-file-contents} checks the file contents |
476 against the defined file formats, and converts the file contents if | |
477 appropriate. @xref{Format Conversion}. It also calls the functions in | |
478 the list @code{after-insert-file-functions}; see @ref{Saving | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
479 Properties}. Normally, one of the functions in the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
480 @code{after-insert-file-functions} list determines the coding system |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
481 (@pxref{Coding Systems}) used for decoding the file's contents. |
6555 | 482 |
483 If @var{visit} is non-@code{nil}, this function additionally marks the | |
484 buffer as unmodified and sets up various fields in the buffer so that it | |
485 is visiting the file @var{filename}: these include the buffer's visited | |
486 file name and its last save file modtime. This feature is used by | |
487 @code{find-file-noselect} and you probably should not use it yourself. | |
488 | |
489 If @var{beg} and @var{end} are non-@code{nil}, they should be integers | |
490 specifying the portion of the file to insert. In this case, @var{visit} | |
491 must be @code{nil}. For example, | |
492 | |
493 @example | |
494 (insert-file-contents filename nil 0 500) | |
495 @end example | |
496 | |
497 @noindent | |
498 inserts the first 500 characters of a file. | |
499 | |
500 If the argument @var{replace} is non-@code{nil}, it means to replace the | |
501 contents of the buffer (actually, just the accessible portion) with the | |
502 contents of the file. This is better than simply deleting the buffer | |
503 contents and inserting the whole file, because (1) it preserves some | |
504 marker positions and (2) it puts less data in the undo list. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
505 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
506 It is possible to read a special file (such as a FIFO or an I/O device) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
507 with @code{insert-file-contents}, as long as @var{replace} and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
508 @var{visit} are @code{nil}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
509 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
510 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
511 @defun insert-file-contents-literally filename &optional visit beg end replace |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
512 This function works like @code{insert-file-contents} except that it does |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
513 not do format decoding (@pxref{Format Conversion}), does not do |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
514 character code conversion (@pxref{Coding Systems}), does not run |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
515 @code{find-file-hooks}, does not perform automatic uncompression, and so |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
516 on. |
6555 | 517 @end defun |
518 | |
519 If you want to pass a file name to another process so that another | |
520 program can read the file, use the function @code{file-local-copy}; see | |
521 @ref{Magic File Names}. | |
522 | |
523 @node Writing to Files | |
524 @comment node-name, next, previous, up | |
525 @section Writing to Files | |
526 | |
527 You can write the contents of a buffer, or part of a buffer, directly | |
528 to a file on disk using the @code{append-to-file} and | |
529 @code{write-region} functions. Don't use these functions to write to | |
530 files that are being visited; that could cause confusion in the | |
531 mechanisms for visiting. | |
532 | |
533 @deffn Command append-to-file start end filename | |
534 This function appends the contents of the region delimited by | |
535 @var{start} and @var{end} in the current buffer to the end of file | |
536 @var{filename}. If that file does not exist, it is created. This | |
537 function returns @code{nil}. | |
538 | |
539 An error is signaled if @var{filename} specifies a nonwritable file, | |
540 or a nonexistent file in a directory where files cannot be created. | |
541 @end deffn | |
542 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
543 @deffn Command write-region start end filename &optional append visit lockname mustbenew |
6555 | 544 This function writes the region delimited by @var{start} and @var{end} |
545 in the current buffer into the file specified by @var{filename}. | |
546 | |
547 @c Emacs 19 feature | |
548 If @var{start} is a string, then @code{write-region} writes or appends | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
549 that string, rather than text from the buffer. @var{end} is ignored in |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
550 this case. |
6555 | 551 |
552 If @var{append} is non-@code{nil}, then the specified text is appended | |
553 to the existing file contents (if any). | |
554 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
555 If @var{mustbenew} is non-@code{nil}, then @code{write-region} asks |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
556 for confirmation if @var{filename} names an existing file. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
557 Starting in Emacs 21, if @var{mustbenew} is the symbol @code{excl}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
558 then @code{write-region} does not ask for confirmation, but instead |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
559 it signals an error @code{file-already-exists} if the file already |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
560 exists. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
561 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
562 The test for an existing file, when @var{mustbenew} is @code{excl}, uses |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
563 a special system feature. At least for files on a local disk, there is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
564 no chance that some other program could create a file of the same name |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
565 before Emacs does, without Emacs's noticing. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
566 |
6555 | 567 If @var{visit} is @code{t}, then Emacs establishes an association |
568 between the buffer and the file: the buffer is then visiting that file. | |
569 It also sets the last file modification time for the current buffer to | |
570 @var{filename}'s modtime, and marks the buffer as not modified. This | |
571 feature is used by @code{save-buffer}, but you probably should not use | |
572 it yourself. | |
573 | |
574 @c Emacs 19 feature | |
575 If @var{visit} is a string, it specifies the file name to visit. This | |
576 way, you can write the data to one file (@var{filename}) while recording | |
577 the buffer as visiting another file (@var{visit}). The argument | |
578 @var{visit} is used in the echo area message and also for file locking; | |
579 @var{visit} is stored in @code{buffer-file-name}. This feature is used | |
580 to implement @code{file-precious-flag}; don't use it yourself unless you | |
581 really know what you're doing. | |
582 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
583 The optional argument @var{lockname}, if non-@code{nil}, specifies the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
584 file name to use for purposes of locking and unlocking, overriding |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
585 @var{filename} and @var{visit} for that purpose. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
586 |
12098 | 587 The function @code{write-region} converts the data which it writes to |
588 the appropriate file formats specified by @code{buffer-file-format}. | |
589 @xref{Format Conversion}. It also calls the functions in the list | |
590 @code{write-region-annotate-functions}; see @ref{Saving Properties}. | |
6555 | 591 |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
592 Normally, @code{write-region} displays the message @samp{Wrote |
6555 | 593 @var{filename}} in the echo area. If @var{visit} is neither @code{t} |
594 nor @code{nil} nor a string, then this message is inhibited. This | |
595 feature is useful for programs that use files for internal purposes, | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
596 files that the user does not need to know about. |
6555 | 597 @end deffn |
598 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
599 @defmac with-temp-file file body... |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
600 The @code{with-temp-file} macro evaluates the @var{body} forms with a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
601 temporary buffer as the current buffer; then, at the end, it writes the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
602 buffer contents into file @var{file}. It kills the temporary buffer |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
603 when finished, restoring the buffer that was current before the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
604 @code{with-temp-file} form. Then it returns the value of the last form |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
605 in @var{body}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
606 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
607 The current buffer is restored even in case of an abnormal exit via |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
608 @code{throw} or error (@pxref{Nonlocal Exits}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
609 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
610 See also @code{with-temp-buffer} in @ref{Current Buffer}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
611 @end defmac |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
612 |
6555 | 613 @node File Locks |
614 @section File Locks | |
615 @cindex file locks | |
616 | |
617 When two users edit the same file at the same time, they are likely to | |
618 interfere with each other. Emacs tries to prevent this situation from | |
619 arising by recording a @dfn{file lock} when a file is being modified. | |
620 Emacs can then detect the first attempt to modify a buffer visiting a | |
621 file that is locked by another Emacs job, and ask the user what to do. | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
622 The file lock is really a file, a symbolic link with a special name, |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
623 stored in the same directory as the file you are editing. |
6555 | 624 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
625 When you access files using NFS, there may be a small probability that |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
626 you and another user will both lock the same file ``simultaneously''. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
627 If this happens, it is possible for the two users to make changes |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
628 simultaneously, but Emacs will still warn the user who saves second. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
629 Also, the detection of modification of a buffer visiting a file changed |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
630 on disk catches some cases of simultaneous editing; see |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
631 @ref{Modification Time}. |
6555 | 632 |
633 @defun file-locked-p filename | |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
634 This function returns @code{nil} if the file @var{filename} is not |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
635 locked. It returns @code{t} if it is locked by this Emacs process, and |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
636 it returns the name of the user who has locked it if it is locked by |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
637 some other job. |
6555 | 638 |
639 @example | |
640 @group | |
641 (file-locked-p "foo") | |
642 @result{} nil | |
643 @end group | |
644 @end example | |
645 @end defun | |
646 | |
647 @defun lock-buffer &optional filename | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
648 This function locks the file @var{filename}, if the current buffer is |
6555 | 649 modified. The argument @var{filename} defaults to the current buffer's |
650 visited file. Nothing is done if the current buffer is not visiting a | |
651 file, or is not modified. | |
652 @end defun | |
653 | |
654 @defun unlock-buffer | |
655 This function unlocks the file being visited in the current buffer, | |
656 if the buffer is modified. If the buffer is not modified, then | |
657 the file should not be locked, so this function does nothing. It also | |
658 does nothing if the current buffer is not visiting a file. | |
659 @end defun | |
660 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
661 File locking is not supported on some systems. On systems that do not |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
662 support it, the functions @code{lock-buffer}, @code{unlock-buffer} and |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
663 @code{file-locked-p} do nothing and return @code{nil}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
664 |
6555 | 665 @defun ask-user-about-lock file other-user |
666 This function is called when the user tries to modify @var{file}, but it | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
667 is locked by another user named @var{other-user}. The default |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
668 definition of this function asks the user to say what to do. The value |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
669 this function returns determines what Emacs does next: |
6555 | 670 |
671 @itemize @bullet | |
672 @item | |
673 A value of @code{t} says to grab the lock on the file. Then | |
674 this user may edit the file and @var{other-user} loses the lock. | |
675 | |
676 @item | |
677 A value of @code{nil} says to ignore the lock and let this | |
678 user edit the file anyway. | |
679 | |
680 @item | |
681 @kindex file-locked | |
682 This function may instead signal a @code{file-locked} error, in which | |
683 case the change that the user was about to make does not take place. | |
684 | |
685 The error message for this error looks like this: | |
686 | |
687 @example | |
688 @error{} File is locked: @var{file} @var{other-user} | |
689 @end example | |
690 | |
691 @noindent | |
692 where @code{file} is the name of the file and @var{other-user} is the | |
693 name of the user who has locked the file. | |
694 @end itemize | |
695 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
696 If you wish, you can replace the @code{ask-user-about-lock} function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
697 with your own version that makes the decision in another way. The code |
6555 | 698 for its usual definition is in @file{userlock.el}. |
699 @end defun | |
700 | |
701 @node Information about Files | |
702 @section Information about Files | |
703 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
704 The functions described in this section all operate on strings that |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
705 designate file names. All the functions have names that begin with the |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
706 word @samp{file}. These functions all return information about actual |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
707 files or directories, so their arguments must all exist as actual files |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
708 or directories unless otherwise noted. |
6555 | 709 |
710 @menu | |
711 * Testing Accessibility:: Is a given file readable? Writable? | |
712 * Kinds of Files:: Is it a directory? A symbolic link? | |
713 * Truenames:: Eliminating symbolic links from a file name. | |
714 * File Attributes:: How large is it? Any other names? Etc. | |
715 @end menu | |
716 | |
717 @node Testing Accessibility | |
718 @comment node-name, next, previous, up | |
719 @subsection Testing Accessibility | |
720 @cindex accessibility of a file | |
721 @cindex file accessibility | |
722 | |
723 These functions test for permission to access a file in specific ways. | |
724 | |
725 @defun file-exists-p filename | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
726 This function returns @code{t} if a file named @var{filename} appears to |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
727 exist. This does not mean you can necessarily read the file, only that |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
728 you can find out its attributes. (On Unix and GNU/Linux, this is true |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
729 if the file exists and you have execute permission on the containing |
6555 | 730 directories, regardless of the protection of the file itself.) |
731 | |
732 If the file does not exist, or if fascist access control policies | |
733 prevent you from finding the attributes of the file, this function | |
734 returns @code{nil}. | |
735 @end defun | |
736 | |
737 @defun file-readable-p filename | |
738 This function returns @code{t} if a file named @var{filename} exists | |
739 and you can read it. It returns @code{nil} otherwise. | |
740 | |
741 @example | |
742 @group | |
743 (file-readable-p "files.texi") | |
744 @result{} t | |
745 @end group | |
746 @group | |
747 (file-exists-p "/usr/spool/mqueue") | |
748 @result{} t | |
749 @end group | |
750 @group | |
751 (file-readable-p "/usr/spool/mqueue") | |
752 @result{} nil | |
753 @end group | |
754 @end example | |
755 @end defun | |
756 | |
757 @c Emacs 19 feature | |
758 @defun file-executable-p filename | |
759 This function returns @code{t} if a file named @var{filename} exists and | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
760 you can execute it. It returns @code{nil} otherwise. On Unix and |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
761 GNU/Linux, if the file is a directory, execute permission means you can |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
762 check the existence and attributes of files inside the directory, and |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
763 open those files if their modes permit. |
6555 | 764 @end defun |
765 | |
766 @defun file-writable-p filename | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
767 This function returns @code{t} if the file @var{filename} can be written |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
768 or created by you, and @code{nil} otherwise. A file is writable if the |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
769 file exists and you can write it. It is creatable if it does not exist, |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
770 but the specified directory does exist and you can write in that |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
771 directory. |
6555 | 772 |
773 In the third example below, @file{foo} is not writable because the | |
774 parent directory does not exist, even though the user could create such | |
775 a directory. | |
776 | |
777 @example | |
778 @group | |
779 (file-writable-p "~/foo") | |
780 @result{} t | |
781 @end group | |
782 @group | |
783 (file-writable-p "/foo") | |
784 @result{} nil | |
785 @end group | |
786 @group | |
787 (file-writable-p "~/no-such-dir/foo") | |
788 @result{} nil | |
789 @end group | |
790 @end example | |
791 @end defun | |
792 | |
793 @c Emacs 19 feature | |
794 @defun file-accessible-directory-p dirname | |
795 This function returns @code{t} if you have permission to open existing | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
796 files in the directory whose name as a file is @var{dirname}; otherwise |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
797 (or if there is no such directory), it returns @code{nil}. The value |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
798 of @var{dirname} may be either a directory name or the file name of a |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
799 file which is a directory. |
6555 | 800 |
801 Example: after the following, | |
802 | |
803 @example | |
804 (file-accessible-directory-p "/foo") | |
805 @result{} nil | |
806 @end example | |
807 | |
808 @noindent | |
809 we can deduce that any attempt to read a file in @file{/foo/} will | |
810 give an error. | |
811 @end defun | |
812 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
813 @defun access-file filename string |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
814 This function opens file @var{filename} for reading, then closes it and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
815 returns @code{nil}. However, if the open fails, it signals an error |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
816 using @var{string} as the error message text. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
817 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
818 |
12067 | 819 @defun file-ownership-preserved-p filename |
820 This function returns @code{t} if deleting the file @var{filename} and | |
821 then creating it anew would keep the file's owner unchanged. | |
822 @end defun | |
823 | |
6555 | 824 @defun file-newer-than-file-p filename1 filename2 |
825 @cindex file age | |
826 @cindex file modification time | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
827 This function returns @code{t} if the file @var{filename1} is |
6555 | 828 newer than file @var{filename2}. If @var{filename1} does not |
829 exist, it returns @code{nil}. If @var{filename2} does not exist, | |
830 it returns @code{t}. | |
831 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
832 In the following example, assume that the file @file{aug-19} was written |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
833 on the 19th, @file{aug-20} was written on the 20th, and the file |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
834 @file{no-file} doesn't exist at all. |
6555 | 835 |
836 @example | |
837 @group | |
838 (file-newer-than-file-p "aug-19" "aug-20") | |
839 @result{} nil | |
840 @end group | |
841 @group | |
842 (file-newer-than-file-p "aug-20" "aug-19") | |
843 @result{} t | |
844 @end group | |
845 @group | |
846 (file-newer-than-file-p "aug-19" "no-file") | |
847 @result{} t | |
848 @end group | |
849 @group | |
850 (file-newer-than-file-p "no-file" "aug-19") | |
851 @result{} nil | |
852 @end group | |
853 @end example | |
854 | |
855 You can use @code{file-attributes} to get a file's last modification | |
856 time as a list of two numbers. @xref{File Attributes}. | |
857 @end defun | |
858 | |
859 @node Kinds of Files | |
860 @comment node-name, next, previous, up | |
861 @subsection Distinguishing Kinds of Files | |
862 | |
12098 | 863 This section describes how to distinguish various kinds of files, such |
864 as directories, symbolic links, and ordinary files. | |
6555 | 865 |
866 @defun file-symlink-p filename | |
867 @cindex file symbolic links | |
868 If the file @var{filename} is a symbolic link, the @code{file-symlink-p} | |
869 function returns the file name to which it is linked. This may be the | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
870 name of a text file, a directory, or even another symbolic link, or it |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
871 may be a nonexistent file name. |
6555 | 872 |
873 If the file @var{filename} is not a symbolic link (or there is no such file), | |
874 @code{file-symlink-p} returns @code{nil}. | |
875 | |
876 @example | |
877 @group | |
878 (file-symlink-p "foo") | |
879 @result{} nil | |
880 @end group | |
881 @group | |
882 (file-symlink-p "sym-link") | |
883 @result{} "foo" | |
884 @end group | |
885 @group | |
886 (file-symlink-p "sym-link2") | |
887 @result{} "sym-link" | |
888 @end group | |
889 @group | |
890 (file-symlink-p "/bin") | |
891 @result{} "/pub/bin" | |
892 @end group | |
893 @end example | |
894 | |
895 @c !!! file-symlink-p: should show output of ls -l for comparison | |
896 @end defun | |
897 | |
898 @defun file-directory-p filename | |
899 This function returns @code{t} if @var{filename} is the name of an | |
900 existing directory, @code{nil} otherwise. | |
901 | |
902 @example | |
903 @group | |
904 (file-directory-p "~rms") | |
905 @result{} t | |
906 @end group | |
907 @group | |
908 (file-directory-p "~rms/lewis/files.texi") | |
909 @result{} nil | |
910 @end group | |
911 @group | |
912 (file-directory-p "~rms/lewis/no-such-file") | |
913 @result{} nil | |
914 @end group | |
915 @group | |
916 (file-directory-p "$HOME") | |
917 @result{} nil | |
918 @end group | |
919 @group | |
920 (file-directory-p | |
921 (substitute-in-file-name "$HOME")) | |
922 @result{} t | |
923 @end group | |
924 @end example | |
925 @end defun | |
926 | |
12067 | 927 @defun file-regular-p filename |
928 This function returns @code{t} if the file @var{filename} exists and is | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
929 a regular file (not a directory, named pipe, terminal, or |
12067 | 930 other I/O device). |
931 @end defun | |
932 | |
6555 | 933 @node Truenames |
934 @subsection Truenames | |
935 @cindex truename (of file) | |
936 | |
937 @c Emacs 19 features | |
938 The @dfn{truename} of a file is the name that you get by following | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
939 symbolic links at all levels until none remain, then simplifying away |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
940 @samp{.}@: and @samp{..}@: appearing as name components. This results |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
941 in a sort of canonical name for the file. A file does not always have a |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
942 unique truename; the number of distinct truenames a file has is equal to |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
943 the number of hard links to the file. However, truenames are useful |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
944 because they eliminate symbolic links as a cause of name variation. |
6555 | 945 |
946 @defun file-truename filename | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
947 The function @code{file-truename} returns the truename of the file |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
948 @var{filename}. The argument must be an absolute file name. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
949 @end defun |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
950 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
951 @defun file-chase-links filename |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
952 This function follows symbolic links, starting with @var{filename}, |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
953 until it finds a file name which is not the name of a symbolic link. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
954 Then it returns that file name. |
6555 | 955 @end defun |
956 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
957 To illustrate the difference between @code{file-chase-links} and |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
958 @code{file-truename}, suppose that @file{/usr/foo} is a symbolic link to |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
959 the directory @file{/home/foo}, and @file{/home/foo/hello} is an |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
960 ordinary file (or at least, not a symbolic link) or nonexistent. Then |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
961 we would have: |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
962 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
963 @example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
964 (file-chase-links "/usr/foo/hello") |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
965 ;; @r{This does not follow the links in the parent directories.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
966 @result{} "/usr/foo/hello" |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
967 (file-truename "/usr/foo/hello") |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
968 ;; @r{Assuming that @file{/home} is not a symbolic link.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
969 @result{} "/home/foo/hello" |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
970 @end example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
971 |
6555 | 972 @xref{Buffer File Name}, for related information. |
973 | |
974 @node File Attributes | |
975 @comment node-name, next, previous, up | |
976 @subsection Other Information about Files | |
977 | |
978 This section describes the functions for getting detailed information | |
979 about a file, other than its contents. This information includes the | |
980 mode bits that control access permission, the owner and group numbers, | |
981 the number of names, the inode number, the size, and the times of access | |
982 and modification. | |
983 | |
984 @defun file-modes filename | |
985 @cindex permission | |
986 @cindex file attributes | |
987 This function returns the mode bits of @var{filename}, as an integer. | |
988 The mode bits are also called the file permissions, and they specify | |
989 access control in the usual Unix fashion. If the low-order bit is 1, | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
990 then the file is executable by all users, if the second-lowest-order bit |
6555 | 991 is 1, then the file is writable by all users, etc. |
992 | |
993 The highest value returnable is 4095 (7777 octal), meaning that | |
994 everyone has read, write, and execute permission, that the @sc{suid} bit | |
995 is set for both others and group, and that the sticky bit is set. | |
996 | |
997 @example | |
998 @group | |
999 (file-modes "~/junk/diffs") | |
1000 @result{} 492 ; @r{Decimal integer.} | |
1001 @end group | |
1002 @group | |
1003 (format "%o" 492) | |
1004 @result{} "754" ; @r{Convert to octal.} | |
1005 @end group | |
1006 | |
1007 @group | |
1008 (set-file-modes "~/junk/diffs" 438) | |
1009 @result{} nil | |
1010 @end group | |
1011 | |
1012 @group | |
1013 (format "%o" 438) | |
1014 @result{} "666" ; @r{Convert to octal.} | |
1015 @end group | |
1016 | |
1017 @group | |
1018 % ls -l diffs | |
1019 -rw-rw-rw- 1 lewis 0 3063 Oct 30 16:00 diffs | |
1020 @end group | |
1021 @end example | |
1022 @end defun | |
1023 | |
1024 @defun file-nlinks filename | |
1025 This functions returns the number of names (i.e., hard links) that | |
1026 file @var{filename} has. If the file does not exist, then this function | |
1027 returns @code{nil}. Note that symbolic links have no effect on this | |
1028 function, because they are not considered to be names of the files they | |
1029 link to. | |
1030 | |
1031 @example | |
1032 @group | |
1033 % ls -l foo* | |
1034 -rw-rw-rw- 2 rms 4 Aug 19 01:27 foo | |
1035 -rw-rw-rw- 2 rms 4 Aug 19 01:27 foo1 | |
1036 @end group | |
1037 | |
1038 @group | |
1039 (file-nlinks "foo") | |
1040 @result{} 2 | |
1041 @end group | |
1042 @group | |
1043 (file-nlinks "doesnt-exist") | |
1044 @result{} nil | |
1045 @end group | |
1046 @end example | |
1047 @end defun | |
1048 | |
1049 @defun file-attributes filename | |
1050 This function returns a list of attributes of file @var{filename}. If | |
1051 the specified file cannot be opened, it returns @code{nil}. | |
1052 | |
1053 The elements of the list, in order, are: | |
1054 | |
1055 @enumerate 0 | |
1056 @item | |
1057 @code{t} for a directory, a string for a symbolic link (the name | |
1058 linked to), or @code{nil} for a text file. | |
1059 | |
1060 @c Wordy so as to prevent an overfull hbox. --rjc 15mar92 | |
1061 @item | |
1062 The number of names the file has. Alternate names, also known as hard | |
1063 links, can be created by using the @code{add-name-to-file} function | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1064 (@pxref{Changing Files}). |
6555 | 1065 |
1066 @item | |
1067 The file's @sc{uid}. | |
1068 | |
1069 @item | |
1070 The file's @sc{gid}. | |
1071 | |
1072 @item | |
1073 The time of last access, as a list of two integers. | |
1074 The first integer has the high-order 16 bits of time, | |
1075 the second has the low 16 bits. (This is similar to the | |
1076 value of @code{current-time}; see @ref{Time of Day}.) | |
1077 | |
1078 @item | |
1079 The time of last modification as a list of two integers (as above). | |
1080 | |
1081 @item | |
1082 The time of last status change as a list of two integers (as above). | |
1083 | |
1084 @item | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
1085 The size of the file in bytes. If the size is too large to fit in a |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
1086 Lisp integer, this is a floating point number. |
6555 | 1087 |
1088 @item | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1089 The file's modes, as a string of ten letters or dashes, |
6555 | 1090 as in @samp{ls -l}. |
1091 | |
1092 @item | |
1093 @code{t} if the file's @sc{gid} would change if file were | |
1094 deleted and recreated; @code{nil} otherwise. | |
1095 | |
1096 @item | |
17919
eb712b69e495
The inode number can be an integer.
Richard M. Stallman <rms@gnu.org>
parents:
17398
diff
changeset
|
1097 The file's inode number. If possible, this is an integer. If the inode |
eb712b69e495
The inode number can be an integer.
Richard M. Stallman <rms@gnu.org>
parents:
17398
diff
changeset
|
1098 number is too large to be represented as an integer in Emacs Lisp, then |
eb712b69e495
The inode number can be an integer.
Richard M. Stallman <rms@gnu.org>
parents:
17398
diff
changeset
|
1099 the value has the form @code{(@var{high} . @var{low})}, where @var{low} |
eb712b69e495
The inode number can be an integer.
Richard M. Stallman <rms@gnu.org>
parents:
17398
diff
changeset
|
1100 holds the low 16 bits. |
6555 | 1101 |
1102 @item | |
1103 The file system number of the file system that the file is in. This | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1104 element and the file's inode number together give enough information to |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1105 distinguish any two files on the system---no two files can have the same |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1106 values for both of these numbers. |
6555 | 1107 @end enumerate |
1108 | |
1109 For example, here are the file attributes for @file{files.texi}: | |
1110 | |
1111 @example | |
1112 @group | |
1113 (file-attributes "files.texi") | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1114 @result{} (nil 1 2235 75 |
6555 | 1115 (8489 20284) |
1116 (8489 20284) | |
1117 (8489 20285) | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1118 14906 "-rw-rw-rw-" |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1119 nil 129500 -32252) |
6555 | 1120 @end group |
1121 @end example | |
1122 | |
1123 @noindent | |
1124 and here is how the result is interpreted: | |
1125 | |
1126 @table @code | |
1127 @item nil | |
1128 is neither a directory nor a symbolic link. | |
1129 | |
1130 @item 1 | |
1131 has only one name (the name @file{files.texi} in the current default | |
1132 directory). | |
1133 | |
1134 @item 2235 | |
1135 is owned by the user with @sc{uid} 2235. | |
1136 | |
1137 @item 75 | |
1138 is in the group with @sc{gid} 75. | |
1139 | |
1140 @item (8489 20284) | |
12522 | 1141 was last accessed on Aug 19 00:09. |
6555 | 1142 |
1143 @item (8489 20284) | |
1144 was last modified on Aug 19 00:09. | |
1145 | |
1146 @item (8489 20285) | |
1147 last had its inode changed on Aug 19 00:09. | |
1148 | |
1149 @item 14906 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1150 is 14906 bytes long. (It may not contain 14906 characters, though, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1151 if some of the bytes belong to multibyte sequences.) |
6555 | 1152 |
1153 @item "-rw-rw-rw-" | |
1154 has a mode of read and write access for the owner, group, and world. | |
1155 | |
1156 @item nil | |
1157 would retain the same @sc{gid} if it were recreated. | |
1158 | |
1159 @item 129500 | |
1160 has an inode number of 129500. | |
1161 @item -32252 | |
1162 is on file system number -32252. | |
1163 @end table | |
1164 @end defun | |
1165 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1166 @node Changing Files |
6555 | 1167 @section Changing File Names and Attributes |
1168 @cindex renaming files | |
1169 @cindex copying files | |
1170 @cindex deleting files | |
1171 @cindex linking files | |
1172 @cindex setting modes of files | |
1173 | |
1174 The functions in this section rename, copy, delete, link, and set the | |
1175 modes of files. | |
1176 | |
1177 In the functions that have an argument @var{newname}, if a file by the | |
1178 name of @var{newname} already exists, the actions taken depend on the | |
1179 value of the argument @var{ok-if-already-exists}: | |
1180 | |
1181 @itemize @bullet | |
1182 @item | |
1183 Signal a @code{file-already-exists} error if | |
1184 @var{ok-if-already-exists} is @code{nil}. | |
1185 | |
1186 @item | |
1187 Request confirmation if @var{ok-if-already-exists} is a number. | |
1188 | |
1189 @item | |
1190 Replace the old file without confirmation if @var{ok-if-already-exists} | |
1191 is any other value. | |
1192 @end itemize | |
1193 | |
1194 @defun add-name-to-file oldname newname &optional ok-if-already-exists | |
1195 @cindex file with multiple names | |
1196 @cindex file hard link | |
1197 This function gives the file named @var{oldname} the additional name | |
1198 @var{newname}. This means that @var{newname} becomes a new ``hard | |
1199 link'' to @var{oldname}. | |
1200 | |
1201 In the first part of the following example, we list two files, | |
1202 @file{foo} and @file{foo3}. | |
1203 | |
1204 @example | |
1205 @group | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1206 % ls -li fo* |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1207 81908 -rw-rw-rw- 1 rms 29 Aug 18 20:32 foo |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1208 84302 -rw-rw-rw- 1 rms 24 Aug 18 20:31 foo3 |
6555 | 1209 @end group |
1210 @end example | |
1211 | |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
1212 Now we create a hard link, by calling @code{add-name-to-file}, then list |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
1213 the files again. This shows two names for one file, @file{foo} and |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
1214 @file{foo2}. |
6555 | 1215 |
1216 @example | |
1217 @group | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1218 (add-name-to-file "foo" "foo2") |
6555 | 1219 @result{} nil |
1220 @end group | |
1221 | |
1222 @group | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1223 % ls -li fo* |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1224 81908 -rw-rw-rw- 2 rms 29 Aug 18 20:32 foo |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1225 81908 -rw-rw-rw- 2 rms 29 Aug 18 20:32 foo2 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1226 84302 -rw-rw-rw- 1 rms 24 Aug 18 20:31 foo3 |
6555 | 1227 @end group |
1228 @end example | |
1229 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1230 Finally, we evaluate the following: |
6555 | 1231 |
1232 @example | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1233 (add-name-to-file "foo" "foo3" t) |
6555 | 1234 @end example |
1235 | |
1236 @noindent | |
1237 and list the files again. Now there are three names | |
1238 for one file: @file{foo}, @file{foo2}, and @file{foo3}. The old | |
1239 contents of @file{foo3} are lost. | |
1240 | |
1241 @example | |
1242 @group | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1243 (add-name-to-file "foo1" "foo3") |
6555 | 1244 @result{} nil |
1245 @end group | |
1246 | |
1247 @group | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1248 % ls -li fo* |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1249 81908 -rw-rw-rw- 3 rms 29 Aug 18 20:32 foo |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1250 81908 -rw-rw-rw- 3 rms 29 Aug 18 20:32 foo2 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1251 81908 -rw-rw-rw- 3 rms 29 Aug 18 20:32 foo3 |
6555 | 1252 @end group |
1253 @end example | |
1254 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1255 This function is meaningless on operating systems where multiple names |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1256 for one file are not allowed. Some systems implement multiple names |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1257 by copying the file instead. |
6555 | 1258 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1259 See also @code{file-nlinks} in @ref{File Attributes}. |
6555 | 1260 @end defun |
1261 | |
1262 @deffn Command rename-file filename newname &optional ok-if-already-exists | |
1263 This command renames the file @var{filename} as @var{newname}. | |
1264 | |
1265 If @var{filename} has additional names aside from @var{filename}, it | |
1266 continues to have those names. In fact, adding the name @var{newname} | |
1267 with @code{add-name-to-file} and then deleting @var{filename} has the | |
1268 same effect as renaming, aside from momentary intermediate states. | |
1269 | |
1270 In an interactive call, this function prompts for @var{filename} and | |
1271 @var{newname} in the minibuffer; also, it requests confirmation if | |
1272 @var{newname} already exists. | |
1273 @end deffn | |
1274 | |
1275 @deffn Command copy-file oldname newname &optional ok-if-exists time | |
1276 This command copies the file @var{oldname} to @var{newname}. An | |
1277 error is signaled if @var{oldname} does not exist. | |
1278 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1279 If @var{time} is non-@code{nil}, then this function gives the new file |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1280 the same last-modified time that the old one has. (This works on only |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1281 some operating systems.) If setting the time gets an error, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1282 @code{copy-file} signals a @code{file-date-error} error. |
6555 | 1283 |
1284 In an interactive call, this function prompts for @var{filename} and | |
1285 @var{newname} in the minibuffer; also, it requests confirmation if | |
1286 @var{newname} already exists. | |
1287 @end deffn | |
1288 | |
1289 @deffn Command delete-file filename | |
1290 @pindex rm | |
1291 This command deletes the file @var{filename}, like the shell command | |
1292 @samp{rm @var{filename}}. If the file has multiple names, it continues | |
1293 to exist under the other names. | |
1294 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1295 A suitable kind of @code{file-error} error is signaled if the file does |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1296 not exist, or is not deletable. (On Unix and GNU/Linux, a file is |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1297 deletable if its directory is writable.) |
6555 | 1298 |
1299 See also @code{delete-directory} in @ref{Create/Delete Dirs}. | |
1300 @end deffn | |
1301 | |
1302 @deffn Command make-symbolic-link filename newname &optional ok-if-exists | |
1303 @pindex ln | |
1304 @kindex file-already-exists | |
1305 This command makes a symbolic link to @var{filename}, named | |
1306 @var{newname}. This is like the shell command @samp{ln -s | |
1307 @var{filename} @var{newname}}. | |
1308 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1309 In an interactive call, this function prompts for @var{filename} and |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1310 @var{newname} in the minibuffer; also, it requests confirmation if |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1311 @var{newname} already exists. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1312 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1313 This function is not available on systems that don't support symbolic |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1314 links. |
6555 | 1315 @end deffn |
1316 | |
1317 @defun define-logical-name varname string | |
1318 This function defines the logical name @var{name} to have the value | |
1319 @var{string}. It is available only on VMS. | |
1320 @end defun | |
1321 | |
1322 @defun set-file-modes filename mode | |
1323 This function sets mode bits of @var{filename} to @var{mode} (which must | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1324 be an integer). Only the low 12 bits of @var{mode} are used. |
6555 | 1325 @end defun |
1326 | |
1327 @c Emacs 19 feature | |
1328 @defun set-default-file-modes mode | |
1329 This function sets the default file protection for new files created by | |
1330 Emacs and its subprocesses. Every file created with Emacs initially has | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1331 this protection. On Unix and GNU/Linux, the default protection is the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1332 bitwise complement of the ``umask'' value. |
6555 | 1333 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1334 The argument @var{mode} must be an integer. On most systems, only the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1335 low 9 bits of @var{mode} are meaningful. |
6555 | 1336 |
1337 Saving a modified version of an existing file does not count as creating | |
1338 the file; it does not change the file's mode, and does not use the | |
1339 default file protection. | |
1340 @end defun | |
1341 | |
1342 @defun default-file-modes | |
1343 This function returns the current default protection value. | |
1344 @end defun | |
1345 | |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1346 @cindex MS-DOS and file modes |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1347 @cindex file modes and MS-DOS |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1348 On MS-DOS, there is no such thing as an ``executable'' file mode bit. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1349 So Emacs considers a file executable if its name ends in one of the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1350 standard executable extensions, such as @file{.com}, @file{.bat}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1351 @file{.exe}, and some others. Files that begin with the Unix-standard |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1352 @samp{#!} signature, such as shell and Perl scripts, are also considered |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1353 as executable files. This is reflected in the values returned by |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1354 @code{file-modes} and @code{file-attributes}. Directories are also |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1355 reported with executable bit set, for compatibility with Unix. |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1356 |
6555 | 1357 @node File Names |
1358 @section File Names | |
1359 @cindex file names | |
1360 | |
1361 Files are generally referred to by their names, in Emacs as elsewhere. | |
1362 File names in Emacs are represented as strings. The functions that | |
1363 operate on a file all expect a file name argument. | |
1364 | |
1365 In addition to operating on files themselves, Emacs Lisp programs | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1366 often need to operate on file names; i.e., to take them apart and to use |
6555 | 1367 part of a name to construct related file names. This section describes |
1368 how to manipulate file names. | |
1369 | |
1370 The functions in this section do not actually access files, so they | |
1371 can operate on file names that do not refer to an existing file or | |
1372 directory. | |
1373 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1374 On VMS, all these functions understand both VMS file-name syntax and |
6555 | 1375 Unix syntax. This is so that all the standard Lisp libraries can |
1376 specify file names in Unix syntax and work properly on VMS without | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1377 change. On MS-DOS and MS-Windows, these functions understand MS-DOS or |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1378 MS-Windows file-name syntax as well as Unix syntax. |
6555 | 1379 |
1380 @menu | |
1381 * File Name Components:: The directory part of a file name, and the rest. | |
1382 * Directory Names:: A directory's name as a directory | |
1383 is different from its name as a file. | |
1384 * Relative File Names:: Some file names are relative to a current directory. | |
1385 * File Name Expansion:: Converting relative file names to absolute ones. | |
1386 * Unique File Names:: Generating names for temporary files. | |
1387 * File Name Completion:: Finding the completions for a given file name. | |
15765
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1388 * Standard File Names:: If your package uses a fixed file name, |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1389 how to handle various operating systems simply. |
6555 | 1390 @end menu |
1391 | |
1392 @node File Name Components | |
1393 @subsection File Name Components | |
1394 @cindex directory part (of file name) | |
1395 @cindex nondirectory part (of file name) | |
1396 @cindex version number (in file name) | |
1397 | |
1398 The operating system groups files into directories. To specify a | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1399 file, you must specify the directory and the file's name within that |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1400 directory. Therefore, Emacs considers a file name as having two main |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1401 parts: the @dfn{directory name} part, and the @dfn{nondirectory} part |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1402 (or @dfn{file name within the directory}). Either part may be empty. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1403 Concatenating these two parts reproduces the original file name. |
6555 | 1404 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1405 On most systems, the directory part is everything up to and including |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1406 the last slash; the nondirectory part is the rest. The rules in VMS |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1407 syntax are complicated. |
6555 | 1408 |
1409 For some purposes, the nondirectory part is further subdivided into | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1410 the name proper and the @dfn{version number}. On most systems, only |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1411 backup files have version numbers in their names. On VMS, every file |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1412 has a version number, but most of the time the file name actually used |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1413 in Emacs omits the version number, so that version numbers in Emacs are |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1414 found mostly in directory lists. |
6555 | 1415 |
1416 @defun file-name-directory filename | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1417 This function returns the directory part of @var{filename} (or |
6555 | 1418 @code{nil} if @var{filename} does not include a directory part). On |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1419 most systems, the function returns a string ending in a slash. On VMS, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1420 it returns a string ending in one of the three characters @samp{:}, |
6555 | 1421 @samp{]}, or @samp{>}. |
1422 | |
1423 @example | |
1424 @group | |
1425 (file-name-directory "lewis/foo") ; @r{Unix example} | |
1426 @result{} "lewis/" | |
1427 @end group | |
1428 @group | |
1429 (file-name-directory "foo") ; @r{Unix example} | |
1430 @result{} nil | |
1431 @end group | |
1432 @group | |
1433 (file-name-directory "[X]FOO.TMP") ; @r{VMS example} | |
1434 @result{} "[X]" | |
1435 @end group | |
1436 @end example | |
1437 @end defun | |
1438 | |
1439 @defun file-name-nondirectory filename | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1440 This function returns the nondirectory part of @var{filename}. |
6555 | 1441 |
1442 @example | |
1443 @group | |
1444 (file-name-nondirectory "lewis/foo") | |
1445 @result{} "foo" | |
1446 @end group | |
1447 @group | |
1448 (file-name-nondirectory "foo") | |
1449 @result{} "foo" | |
1450 @end group | |
1451 @group | |
1452 ;; @r{The following example is accurate only on VMS.} | |
1453 (file-name-nondirectory "[X]FOO.TMP") | |
1454 @result{} "FOO.TMP" | |
1455 @end group | |
1456 @end example | |
1457 @end defun | |
1458 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1459 @defun file-name-sans-versions filename &optional keep-backup-version |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1460 This function returns @var{filename} with any file version numbers, |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1461 backup version numbers, or trailing tildes discarded. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1462 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1463 If @var{keep-backup-version} is non-@code{nil}, then true file version |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1464 numbers understood as such by the file system are discarded from the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1465 return value, but backup version numbers are kept. |
6555 | 1466 |
1467 @example | |
1468 @group | |
1469 (file-name-sans-versions "~rms/foo.~1~") | |
1470 @result{} "~rms/foo" | |
1471 @end group | |
1472 @group | |
1473 (file-name-sans-versions "~rms/foo~") | |
1474 @result{} "~rms/foo" | |
1475 @end group | |
1476 @group | |
1477 (file-name-sans-versions "~rms/foo") | |
1478 @result{} "~rms/foo" | |
1479 @end group | |
1480 @group | |
1481 ;; @r{The following example applies to VMS only.} | |
1482 (file-name-sans-versions "foo;23") | |
1483 @result{} "foo" | |
1484 @end group | |
1485 @end example | |
1486 @end defun | |
1487 | |
12067 | 1488 @defun file-name-sans-extension filename |
12098 | 1489 This function returns @var{filename} minus its ``extension,'' if any. |
1490 The extension, in a file name, is the part that starts with the last | |
1491 @samp{.} in the last name component. For example, | |
1492 | |
1493 @example | |
1494 (file-name-sans-extension "foo.lose.c") | |
1495 @result{} "foo.lose" | |
1496 (file-name-sans-extension "big.hack/foo") | |
1497 @result{} "big.hack/foo" | |
1498 @end example | |
12067 | 1499 @end defun |
1500 | |
6555 | 1501 @node Directory Names |
1502 @comment node-name, next, previous, up | |
1503 @subsection Directory Names | |
1504 @cindex directory name | |
1505 @cindex file name of directory | |
1506 | |
1507 A @dfn{directory name} is the name of a directory. A directory is a | |
1508 kind of file, and it has a file name, which is related to the directory | |
1509 name but not identical to it. (This is not quite the same as the usual | |
1510 Unix terminology.) These two different names for the same entity are | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1511 related by a syntactic transformation. On most systems, this is simple: a |
6555 | 1512 directory name ends in a slash, whereas the directory's name as a file |
1513 lacks that slash. On VMS, the relationship is more complicated. | |
1514 | |
1515 The difference between a directory name and its name as a file is | |
1516 subtle but crucial. When an Emacs variable or function argument is | |
1517 described as being a directory name, a file name of a directory is not | |
1518 acceptable. | |
1519 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1520 The following two functions convert between directory names and file |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1521 names. They do nothing special with environment variable substitutions |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1522 such as @samp{$HOME}, and the constructs @samp{~}, and @samp{..}. |
6555 | 1523 |
1524 @defun file-name-as-directory filename | |
1525 This function returns a string representing @var{filename} in a form | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1526 that the operating system will interpret as the name of a directory. On |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1527 most systems, this means appending a slash to the string (if it does not |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1528 already end in one). On VMS, the function converts a string of the form |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1529 @file{[X]Y.DIR.1} to the form @file{[X.Y]}. |
6555 | 1530 |
1531 @example | |
1532 @group | |
1533 (file-name-as-directory "~rms/lewis") | |
1534 @result{} "~rms/lewis/" | |
1535 @end group | |
1536 @end example | |
1537 @end defun | |
1538 | |
1539 @defun directory-file-name dirname | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1540 This function returns a string representing @var{dirname} in a form that |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1541 the operating system will interpret as the name of a file. On most |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1542 systems, this means removing the final slash from the string. On VMS, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1543 the function converts a string of the form @file{[X.Y]} to |
6555 | 1544 @file{[X]Y.DIR.1}. |
1545 | |
1546 @example | |
1547 @group | |
1548 (directory-file-name "~lewis/") | |
1549 @result{} "~lewis" | |
1550 @end group | |
1551 @end example | |
1552 @end defun | |
1553 | |
1554 @cindex directory name abbreviation | |
1555 Directory name abbreviations are useful for directories that are | |
1556 normally accessed through symbolic links. Sometimes the users recognize | |
1557 primarily the link's name as ``the name'' of the directory, and find it | |
1558 annoying to see the directory's ``real'' name. If you define the link | |
1559 name as an abbreviation for the ``real'' name, Emacs shows users the | |
1560 abbreviation instead. | |
1561 | |
1562 @defvar directory-abbrev-alist | |
1563 The variable @code{directory-abbrev-alist} contains an alist of | |
1564 abbreviations to use for file directories. Each element has the form | |
1565 @code{(@var{from} . @var{to})}, and says to replace @var{from} with | |
1566 @var{to} when it appears in a directory name. The @var{from} string is | |
1567 actually a regular expression; it should always start with @samp{^}. | |
1568 The function @code{abbreviate-file-name} performs these substitutions. | |
1569 | |
1570 You can set this variable in @file{site-init.el} to describe the | |
1571 abbreviations appropriate for your site. | |
1572 | |
1573 Here's an example, from a system on which file system @file{/home/fsf} | |
1574 and so on are normally accessed through symbolic links named @file{/fsf} | |
1575 and so on. | |
1576 | |
1577 @example | |
1578 (("^/home/fsf" . "/fsf") | |
1579 ("^/home/gp" . "/gp") | |
1580 ("^/home/gd" . "/gd")) | |
1581 @end example | |
1582 @end defvar | |
1583 | |
1584 To convert a directory name to its abbreviation, use this | |
1585 function: | |
1586 | |
1587 @defun abbreviate-file-name dirname | |
1588 This function applies abbreviations from @code{directory-abbrev-alist} | |
1589 to its argument, and substitutes @samp{~} for the user's home | |
1590 directory. | |
1591 @end defun | |
1592 | |
1593 @node Relative File Names | |
1594 @subsection Absolute and Relative File Names | |
1595 @cindex absolute file name | |
1596 @cindex relative file name | |
1597 | |
1598 All the directories in the file system form a tree starting at the | |
1599 root directory. A file name can specify all the directory names | |
1600 starting from the root of the tree; then it is called an @dfn{absolute} | |
1601 file name. Or it can specify the position of the file in the tree | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1602 relative to a default directory; then it is called a @dfn{relative} file |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1603 name. On Unix and GNU/Linux, an absolute file name starts with a slash |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1604 or a tilde (@samp{~}), and a relative one does not. On MS-DOS and |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1605 MS-Windows, an absolute file name starts with a slash or a backslash, or |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1606 with a drive specification @samp{@var{x}:/}, where @var{x} is the |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1607 @dfn{drive letter}. The rules on VMS are complicated. |
6555 | 1608 |
1609 @defun file-name-absolute-p filename | |
1610 This function returns @code{t} if file @var{filename} is an absolute | |
1611 file name, @code{nil} otherwise. On VMS, this function understands both | |
1612 Unix syntax and VMS syntax. | |
1613 | |
1614 @example | |
1615 @group | |
1616 (file-name-absolute-p "~rms/foo") | |
1617 @result{} t | |
1618 @end group | |
1619 @group | |
1620 (file-name-absolute-p "rms/foo") | |
1621 @result{} nil | |
1622 @end group | |
1623 @group | |
1624 (file-name-absolute-p "/user/rms/foo") | |
1625 @result{} t | |
1626 @end group | |
1627 @end example | |
1628 @end defun | |
1629 | |
1630 @node File Name Expansion | |
1631 @subsection Functions that Expand Filenames | |
1632 @cindex expansion of file names | |
1633 | |
1634 @dfn{Expansion} of a file name means converting a relative file name | |
1635 to an absolute one. Since this is done relative to a default directory, | |
1636 you must specify the default directory name as well as the file name to | |
1637 be expanded. Expansion also simplifies file names by eliminating | |
1638 redundancies such as @file{./} and @file{@var{name}/../}. | |
1639 | |
1640 @defun expand-file-name filename &optional directory | |
1641 This function converts @var{filename} to an absolute file name. If | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1642 @var{directory} is supplied, it is the default directory to start with |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1643 if @var{filename} is relative. (The value of @var{directory} should |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1644 itself be an absolute directory name; it may start with @samp{~}.) |
6555 | 1645 Otherwise, the current buffer's value of @code{default-directory} is |
1646 used. For example: | |
1647 | |
1648 @example | |
1649 @group | |
1650 (expand-file-name "foo") | |
1651 @result{} "/xcssun/users/rms/lewis/foo" | |
1652 @end group | |
1653 @group | |
1654 (expand-file-name "../foo") | |
1655 @result{} "/xcssun/users/rms/foo" | |
1656 @end group | |
1657 @group | |
1658 (expand-file-name "foo" "/usr/spool/") | |
1659 @result{} "/usr/spool/foo" | |
1660 @end group | |
1661 @group | |
1662 (expand-file-name "$HOME/foo") | |
1663 @result{} "/xcssun/users/rms/lewis/$HOME/foo" | |
1664 @end group | |
1665 @end example | |
1666 | |
1667 Filenames containing @samp{.} or @samp{..} are simplified to their | |
1668 canonical form: | |
1669 | |
1670 @example | |
1671 @group | |
1672 (expand-file-name "bar/../foo") | |
1673 @result{} "/xcssun/users/rms/lewis/foo" | |
1674 @end group | |
1675 @end example | |
1676 | |
1677 Note that @code{expand-file-name} does @emph{not} expand environment | |
1678 variables; only @code{substitute-in-file-name} does that. | |
1679 @end defun | |
1680 | |
1681 @c Emacs 19 feature | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1682 @defun file-relative-name filename &optional directory |
6555 | 1683 This function does the inverse of expansion---it tries to return a |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1684 relative name that is equivalent to @var{filename} when interpreted |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1685 relative to @var{directory}. If @var{directory} is omitted or |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1686 @code{nil}, it defaults to the current buffer's default directory. |
17398
a5d9cbc4e2c5
(file-relative-name): Say correctly when the value is absolute.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1687 |
a5d9cbc4e2c5
(file-relative-name): Say correctly when the value is absolute.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1688 On some operating systems, an absolute file name begins with a device |
a5d9cbc4e2c5
(file-relative-name): Say correctly when the value is absolute.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1689 name. On such systems, @var{filename} has no relative equivalent based |
a5d9cbc4e2c5
(file-relative-name): Say correctly when the value is absolute.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1690 on @var{directory} if they start with two different device names. In |
a5d9cbc4e2c5
(file-relative-name): Say correctly when the value is absolute.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1691 this case, @code{file-relative-name} returns @var{filename} in absolute |
a5d9cbc4e2c5
(file-relative-name): Say correctly when the value is absolute.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1692 form. |
6555 | 1693 |
1694 @example | |
1695 (file-relative-name "/foo/bar" "/foo/") | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1696 @result{} "bar" |
6555 | 1697 (file-relative-name "/foo/bar" "/hack/") |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1698 @result{} "/foo/bar" |
6555 | 1699 @end example |
1700 @end defun | |
1701 | |
1702 @defvar default-directory | |
1703 The value of this buffer-local variable is the default directory for the | |
1704 current buffer. It should be an absolute directory name; it may start | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1705 with @samp{~}. This variable is buffer-local in every buffer. |
6555 | 1706 |
1707 @code{expand-file-name} uses the default directory when its second | |
1708 argument is @code{nil}. | |
1709 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1710 Aside from VMS, the value is always a string ending with a slash. |
6555 | 1711 |
1712 @example | |
1713 @group | |
1714 default-directory | |
1715 @result{} "/user/lewis/manual/" | |
1716 @end group | |
1717 @end example | |
1718 @end defvar | |
1719 | |
1720 @defun substitute-in-file-name filename | |
1721 This function replaces environment variables references in | |
1722 @var{filename} with the environment variable values. Following standard | |
1723 Unix shell syntax, @samp{$} is the prefix to substitute an environment | |
1724 variable value. | |
1725 | |
1726 The environment variable name is the series of alphanumeric characters | |
1727 (including underscores) that follow the @samp{$}. If the character following | |
1728 the @samp{$} is a @samp{@{}, then the variable name is everything up to the | |
1729 matching @samp{@}}. | |
1730 | |
1731 @c Wordy to avoid overfull hbox. --rjc 15mar92 | |
1732 Here we assume that the environment variable @code{HOME}, which holds | |
1733 the user's home directory name, has value @samp{/xcssun/users/rms}. | |
1734 | |
1735 @example | |
1736 @group | |
1737 (substitute-in-file-name "$HOME/foo") | |
1738 @result{} "/xcssun/users/rms/foo" | |
1739 @end group | |
1740 @end example | |
1741 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1742 After substitution, if a @samp{~} or a @samp{/} appears following a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1743 @samp{/}, everything before the following @samp{/} is discarded: |
6555 | 1744 |
1745 @example | |
1746 @group | |
1747 (substitute-in-file-name "bar/~/foo") | |
1748 @result{} "~/foo" | |
1749 @end group | |
1750 @group | |
1751 (substitute-in-file-name "/usr/local/$HOME/foo") | |
1752 @result{} "/xcssun/users/rms/foo" | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1753 ;; @r{@file{/usr/local/} has been discarded.} |
6555 | 1754 @end group |
1755 @end example | |
1756 | |
1757 On VMS, @samp{$} substitution is not done, so this function does nothing | |
1758 on VMS except discard superfluous initial components as shown above. | |
1759 @end defun | |
1760 | |
1761 @node Unique File Names | |
1762 @subsection Generating Unique File Names | |
1763 | |
1764 Some programs need to write temporary files. Here is the usual way to | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1765 construct a name for such a file, starting in Emacs 21: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1766 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1767 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1768 (make-temp-file @var{name-of-application}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1769 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1770 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1771 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1772 The job of @code{make-temp-file} is to prevent two different users or |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1773 two different jobs from trying to use the exact same file name. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1774 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1775 @defun make-temp-file prefix &optional dir-flag |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1776 @tindex make-temp-file |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1777 This function creates a temporary file and returns its name. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1778 The name starts with @var{prefix}; it also contains a number that is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1779 different in each Emacs job. If @var{prefix} is a relative file name, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1780 it is expanded against @code{temporary-file-directory}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1781 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1782 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1783 @group |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1784 (make-temp-file "foo") |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1785 @result{} "/tmp/foo232J6v" |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1786 @end group |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1787 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1788 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1789 When @code{make-temp-file} returns, the file has been created and is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1790 empty. At that point, you should write the intended contents into the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1791 file. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1792 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1793 If @var{dir-flag} is non-@code{nil}, @code{make-temp-file} creates |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1794 an empty directory instead of an empty file. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1795 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1796 To prevent conflicts among different libraries running in the same |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1797 Emacs, each Lisp program that uses @code{make-temp-file} should have its |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1798 own @var{prefix}. The number added to the end of @var{prefix} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1799 distinguishes between the same application running in different Emacs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1800 jobs. Additional added characters permit a large number of distinct |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1801 names even in one Emacs job. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1802 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1803 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1804 The default directory for temporary files is controlled by the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1805 variable @code{temporary-file-directory}. This variable gives the user |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1806 a uniform way to specify the directory for all temporary files. Some |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1807 programs use @code{small-temporary-file-directory} instead, if that is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1808 non-@code{nil}. To use it, you should expand the prefix against |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1809 the proper directory before calling @code{make-temp-file}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1810 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1811 In older Emacs versions where @code{make-temp-file} does not exist, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1812 you should use @code{make-temp-name} instead: |
6555 | 1813 |
1814 @example | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1815 (make-temp-name |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1816 (expand-file-name @var{name-of-application} |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1817 temporary-file-directory)) |
6555 | 1818 @end example |
1819 | |
1820 @defun make-temp-name string | |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1821 This function generates a string that can be used as a unique file name. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1822 The name starts with @var{string}, and contains a number that is |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1823 different in each Emacs job. It is like @code{make-temp-file} except |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1824 that it just constructs a name, and does not create a file. On MS-DOS, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1825 the @var{string} prefix can be truncated to fit into the 8+3 file-name |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1826 limits. |
6555 | 1827 @end defun |
1828 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1829 @defvar temporary-file-directory |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1830 @cindex @code{TMPDIR} environment variable |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1831 @cindex @code{TMP} environment variable |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1832 @cindex @code{TEMP} environment variable |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1833 This variable specifies the directory name for creating temporary files. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1834 Its value should be a directory name (@pxref{Directory Names}), but it |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1835 is good for Lisp programs to cope if the value is a directory's file |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1836 name instead. Using the value as the second argument to |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1837 @code{expand-file-name} is a good way to achieve that. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1838 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1839 The default value is determined in a reasonable way for your operating |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1840 system; it is based on the @code{TMPDIR}, @code{TMP} and @code{TEMP} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1841 environment variables, with a fall-back to a system-dependent name if |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1842 none of these variables is defined. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1843 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1844 Even if you do not use @code{make-temp-name} to choose the temporary |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1845 file's name, you should still use this variable to decide which |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1846 directory to put the file in. However, if you expect the file to be |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1847 small, you should use @code{small-temporary-file-directory} first if |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1848 that is non-@code{nil}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1849 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1850 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1851 @tindex small-temporary-file-directory |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1852 @defvar small-temporary-file-directory |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1853 This variable (new in Emacs 21) specifies the directory name for |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1854 creating certain temporary files, which are likely to be small. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1855 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1856 If you want to write a temporary file which is likely to be small, you |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1857 should compute the directory like this: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1858 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1859 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1860 (make-temp-file |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1861 (expand-file-name @var{prefix} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1862 (or small-temporary-file-directory |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1863 temporary-file-directory))) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1864 @end example |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1865 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1866 |
6555 | 1867 @node File Name Completion |
1868 @subsection File Name Completion | |
1869 @cindex file name completion subroutines | |
1870 @cindex completion, file name | |
1871 | |
1872 This section describes low-level subroutines for completing a file | |
1873 name. For other completion functions, see @ref{Completion}. | |
1874 | |
1875 @defun file-name-all-completions partial-filename directory | |
1876 This function returns a list of all possible completions for a file | |
1877 whose name starts with @var{partial-filename} in directory | |
1878 @var{directory}. The order of the completions is the order of the files | |
1879 in the directory, which is unpredictable and conveys no useful | |
1880 information. | |
1881 | |
1882 The argument @var{partial-filename} must be a file name containing no | |
1883 directory part and no slash. The current buffer's default directory is | |
1884 prepended to @var{directory}, if @var{directory} is not absolute. | |
1885 | |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
1886 In the following example, suppose that @file{~rms/lewis} is the current |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
1887 default directory, and has five files whose names begin with @samp{f}: |
6555 | 1888 @file{foo}, @file{file~}, @file{file.c}, @file{file.c.~1~}, and |
1889 @file{file.c.~2~}.@refill | |
1890 | |
1891 @example | |
1892 @group | |
1893 (file-name-all-completions "f" "") | |
1894 @result{} ("foo" "file~" "file.c.~2~" | |
1895 "file.c.~1~" "file.c") | |
1896 @end group | |
1897 | |
1898 @group | |
1899 (file-name-all-completions "fo" "") | |
1900 @result{} ("foo") | |
1901 @end group | |
1902 @end example | |
1903 @end defun | |
1904 | |
1905 @defun file-name-completion filename directory | |
1906 This function completes the file name @var{filename} in directory | |
1907 @var{directory}. It returns the longest prefix common to all file names | |
1908 in directory @var{directory} that start with @var{filename}. | |
1909 | |
1910 If only one match exists and @var{filename} matches it exactly, the | |
1911 function returns @code{t}. The function returns @code{nil} if directory | |
1912 @var{directory} contains no name starting with @var{filename}. | |
1913 | |
1914 In the following example, suppose that the current default directory | |
1915 has five files whose names begin with @samp{f}: @file{foo}, | |
1916 @file{file~}, @file{file.c}, @file{file.c.~1~}, and | |
1917 @file{file.c.~2~}.@refill | |
1918 | |
1919 @example | |
1920 @group | |
1921 (file-name-completion "fi" "") | |
1922 @result{} "file" | |
1923 @end group | |
1924 | |
1925 @group | |
1926 (file-name-completion "file.c.~1" "") | |
1927 @result{} "file.c.~1~" | |
1928 @end group | |
1929 | |
1930 @group | |
1931 (file-name-completion "file.c.~1~" "") | |
1932 @result{} t | |
1933 @end group | |
1934 | |
1935 @group | |
1936 (file-name-completion "file.c.~3" "") | |
1937 @result{} nil | |
1938 @end group | |
1939 @end example | |
1940 @end defun | |
1941 | |
1942 @defopt completion-ignored-extensions | |
1943 @code{file-name-completion} usually ignores file names that end in any | |
1944 string in this list. It does not ignore them when all the possible | |
1945 completions end in one of these suffixes or when a buffer showing all | |
1946 possible completions is displayed.@refill | |
1947 | |
1948 A typical value might look like this: | |
1949 | |
1950 @example | |
1951 @group | |
1952 completion-ignored-extensions | |
1953 @result{} (".o" ".elc" "~" ".dvi") | |
1954 @end group | |
1955 @end example | |
1956 @end defopt | |
1957 | |
15765
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1958 @node Standard File Names |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1959 @subsection Standard File Names |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1960 |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1961 Most of the file names used in Lisp programs are entered by the user. |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1962 But occasionally a Lisp program needs to specify a standard file name |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1963 for a particular use---typically, to hold customization information |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1964 about each user. For example, abbrev definitions are stored (by |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1965 default) in the file @file{~/.abbrev_defs}; the @code{completion} |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1966 package stores completions in the file @file{~/.completions}. These are |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1967 two of the many standard file names used by parts of Emacs for certain |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1968 purposes. |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1969 |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1970 Various operating systems have their own conventions for valid file |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1971 names and for which file names to use for user profile data. A Lisp |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1972 program which reads a file using a standard file name ought to use, on |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1973 each type of system, a file name suitable for that system. The function |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1974 @code{convert-standard-filename} makes this easy to do. |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1975 |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1976 @defun convert-standard-filename filename |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1977 This function alters the file name @var{filename} to fit the conventions |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1978 of the operating system in use, and returns the result as a new string. |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1979 @end defun |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1980 |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1981 The recommended way to specify a standard file name in a Lisp program |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1982 is to choose a name which fits the conventions of GNU and Unix systems, |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1983 usually with a nondirectory part that starts with a period, and pass it |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1984 to @code{convert-standard-filename} instead of using it directly. Here |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1985 is an example from the @code{completion} package: |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1986 |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1987 @example |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1988 (defvar save-completions-file-name |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1989 (convert-standard-filename "~/.completions") |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1990 "*The file name to save completions to.") |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1991 @end example |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1992 |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1993 On GNU and Unix systems, and on some other systems as well, |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1994 @code{convert-standard-filename} returns its argument unchanged. On |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1995 some other systems, it alters the name to fit the system's conventions. |
15765
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1996 |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1997 For example, on MS-DOS the alterations made by this function include |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1998 converting a leading @samp{.} to @samp{_}, converting a @samp{_} in the |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1999 middle of the name to @samp{.} if there is no other @samp{.}, inserting |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2000 a @samp{.} after eight characters if there is none, and truncating to |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2001 three characters after the @samp{.}. (It makes other changes as well.) |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2002 Thus, @file{.abbrev_defs} becomes @file{_abbrev.def}, and |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2003 @file{.completions} becomes @file{_complet.ion}. |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2004 |
6555 | 2005 @node Contents of Directories |
2006 @section Contents of Directories | |
2007 @cindex directory-oriented functions | |
2008 @cindex file names in directory | |
2009 | |
2010 A directory is a kind of file that contains other files entered under | |
2011 various names. Directories are a feature of the file system. | |
2012 | |
2013 Emacs can list the names of the files in a directory as a Lisp list, | |
2014 or display the names in a buffer using the @code{ls} shell command. In | |
2015 the latter case, it can optionally display information about each file, | |
2016 depending on the options passed to the @code{ls} command. | |
2017 | |
2018 @defun directory-files directory &optional full-name match-regexp nosort | |
2019 This function returns a list of the names of the files in the directory | |
2020 @var{directory}. By default, the list is in alphabetical order. | |
2021 | |
2022 If @var{full-name} is non-@code{nil}, the function returns the files' | |
2023 absolute file names. Otherwise, it returns the names relative to | |
2024 the specified directory. | |
2025 | |
2026 If @var{match-regexp} is non-@code{nil}, this function returns only | |
2027 those file names that contain a match for that regular expression---the | |
2028 other file names are excluded from the list. | |
2029 | |
2030 @c Emacs 19 feature | |
2031 If @var{nosort} is non-@code{nil}, @code{directory-files} does not sort | |
2032 the list, so you get the file names in no particular order. Use this if | |
2033 you want the utmost possible speed and don't care what order the files | |
2034 are processed in. If the order of processing is visible to the user, | |
2035 then the user will probably be happier if you do sort the names. | |
2036 | |
2037 @example | |
2038 @group | |
2039 (directory-files "~lewis") | |
2040 @result{} ("#foo#" "#foo.el#" "." ".." | |
2041 "dired-mods.el" "files.texi" | |
2042 "files.texi.~1~") | |
2043 @end group | |
2044 @end example | |
2045 | |
2046 An error is signaled if @var{directory} is not the name of a directory | |
2047 that can be read. | |
2048 @end defun | |
2049 | |
2050 @defun file-name-all-versions file dirname | |
2051 This function returns a list of all versions of the file named | |
2052 @var{file} in directory @var{dirname}. | |
2053 @end defun | |
2054 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2055 @tindex file-expand-wildcards |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2056 @defun file-expand-wildcards pattern &optional full |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2057 This function expands the wildcard pattern @var{pattern}, returning |
24952 | 2058 a list of file names that match it. |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2059 |
24952 | 2060 If @var{pattern} is written as an absolute file name, |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2061 the values are absolute also. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2062 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2063 If @var{pattern} is written as a relative file name, it is interpreted |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2064 relative to the current default directory. The file names returned are |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2065 normally also relative to the current default directory. However, if |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2066 @var{full} is non-@code{nil}, they are absolute. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2067 @end defun |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2068 |
6555 | 2069 @defun insert-directory file switches &optional wildcard full-directory-p |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2070 This function inserts (in the current buffer) a directory listing for |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2071 directory @var{file}, formatted with @code{ls} according to |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2072 @var{switches}. It leaves point after the inserted text. |
6555 | 2073 |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2074 The argument @var{file} may be either a directory name or a file |
6555 | 2075 specification including wildcard characters. If @var{wildcard} is |
2076 non-@code{nil}, that means treat @var{file} as a file specification with | |
2077 wildcards. | |
2078 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2079 If @var{full-directory-p} is non-@code{nil}, that means the directory |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2080 listing is expected to show the full contents of a directory. You |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2081 should specify @code{t} when @var{file} is a directory and switches do |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2082 not contain @samp{-d}. (The @samp{-d} option to @code{ls} says to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2083 describe a directory itself as a file, rather than showing its |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2084 contents.) |
6555 | 2085 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2086 On most systems, this function works by running a directory listing |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2087 program whose name is in the variable @code{insert-directory-program}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2088 If @var{wildcard} is non-@code{nil}, it also runs the shell specified by |
6555 | 2089 @code{shell-file-name}, to expand the wildcards. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2090 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2091 MS-DOS and MS-Windows systems usually lack the standard Unix program |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2092 @code{ls}, so this function emulates the standard Unix program @code{ls} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2093 with Lisp code. |
6555 | 2094 @end defun |
2095 | |
2096 @defvar insert-directory-program | |
2097 This variable's value is the program to run to generate a directory listing | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2098 for the function @code{insert-directory}. It is ignored on systems |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2099 which generate the listing with Lisp code. |
6555 | 2100 @end defvar |
2101 | |
2102 @node Create/Delete Dirs | |
2103 @section Creating and Deleting Directories | |
2104 @c Emacs 19 features | |
2105 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2106 Most Emacs Lisp file-manipulation functions get errors when used on |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2107 files that are directories. For example, you cannot delete a directory |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2108 with @code{delete-file}. These special functions exist to create and |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2109 delete directories. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2110 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
2111 @defun make-directory dirname &optional parents |
6555 | 2112 This function creates a directory named @var{dirname}. |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
2113 If @var{parents} is non-@code{nil}, that means to create |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
2114 the parent directories first, if they don't already exist. |
6555 | 2115 @end defun |
2116 | |
2117 @defun delete-directory dirname | |
2118 This function deletes the directory named @var{dirname}. The function | |
2119 @code{delete-file} does not work for files that are directories; you | |
12098 | 2120 must use @code{delete-directory} for them. If the directory contains |
2121 any files, @code{delete-directory} signals an error. | |
6555 | 2122 @end defun |
2123 | |
2124 @node Magic File Names | |
2125 @section Making Certain File Names ``Magic'' | |
2126 @cindex magic file names | |
2127 | |
2128 @c Emacs 19 feature | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2129 You can implement special handling for certain file names. This is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2130 called making those names @dfn{magic}. The principal use for this |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2131 feature is in implementing remote file names (@pxref{Remote Files,, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2132 Remote Files, emacs, The GNU Emacs Manual}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2133 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2134 To define a kind of magic file name, you must supply a regular |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2135 expression to define the class of names (all those that match the |
6555 | 2136 regular expression), plus a handler that implements all the primitive |
2137 Emacs file operations for file names that do match. | |
2138 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2139 The variable @code{file-name-handler-alist} holds a list of handlers, |
6555 | 2140 together with regular expressions that determine when to apply each |
2141 handler. Each element has this form: | |
2142 | |
2143 @example | |
2144 (@var{regexp} . @var{handler}) | |
2145 @end example | |
2146 | |
2147 @noindent | |
2148 All the Emacs primitives for file access and file name transformation | |
2149 check the given file name against @code{file-name-handler-alist}. If | |
2150 the file name matches @var{regexp}, the primitives handle that file by | |
2151 calling @var{handler}. | |
2152 | |
2153 The first argument given to @var{handler} is the name of the primitive; | |
2154 the remaining arguments are the arguments that were passed to that | |
2155 operation. (The first of these arguments is typically the file name | |
2156 itself.) For example, if you do this: | |
2157 | |
2158 @example | |
2159 (file-exists-p @var{filename}) | |
2160 @end example | |
2161 | |
2162 @noindent | |
2163 and @var{filename} has handler @var{handler}, then @var{handler} is | |
2164 called like this: | |
2165 | |
2166 @example | |
2167 (funcall @var{handler} 'file-exists-p @var{filename}) | |
2168 @end example | |
2169 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2170 Here are the operations that a magic file name handler gets to handle: |
6555 | 2171 |
27193 | 2172 @ifnottex |
6555 | 2173 @noindent |
2174 @code{add-name-to-file}, @code{copy-file}, @code{delete-directory}, | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2175 @code{delete-file}, |
12226 | 2176 @code{diff-latest-backup-file}, |
6555 | 2177 @code{directory-file-name}, |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2178 @code{directory-files}, |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
2179 @code{dired-call-process}, |
6555 | 2180 @code{dired-compress-file}, @code{dired-uncache}, |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2181 @code{expand-file-name}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2182 @code{file-accessible-directory-p},@* |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2183 @code{file-attributes}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2184 @code{file-directory-p}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2185 @code{file-executable-p}, @code{file-exists-p},@* |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2186 @code{file-local-copy}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2187 @code{file-modes}, @code{file-name-all-completions},@* |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2188 @code{file-name-as-directory}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2189 @code{file-name-completion}, |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
2190 @code{file-name-directory}, |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
2191 @code{file-name-nondirectory}, |
6555 | 2192 @code{file-name-sans-versions}, @code{file-newer-than-file-p}, |
15765
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2193 @code{file-ownership-preserved-p}, |
11626
0b86aef0c387
Mention file-regular-p operation.
Richard M. Stallman <rms@gnu.org>
parents:
8364
diff
changeset
|
2194 @code{file-readable-p}, @code{file-regular-p}, @code{file-symlink-p}, |
12226 | 2195 @code{file-truename}, @code{file-writable-p}, |
15765
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2196 @code{find-backup-file-name}, |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2197 @code{get-file-buffer},@* |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2198 @code{insert-directory}, |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
2199 @code{insert-file-contents}, |
15765
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2200 @code{load}, @code{make-directory}, |
6555 | 2201 @code{make-symbolic-link}, @code{rename-file}, @code{set-file-modes}, |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2202 @code{set-visited-file-modtime}, @code{shell-command},@* |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2203 @code{unhandled-file-name-directory}, |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
2204 @code{vc-registered}, |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2205 @code{verify-visited-file-modtime},@* |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2206 @code{write-region}. |
27193 | 2207 @end ifnottex |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2208 @iftex |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2209 @noindent |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2210 @flushleft |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2211 @code{add-name-to-file}, @code{copy-file}, @code{delete-directory}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2212 @code{delete-file}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2213 @code{diff-latest-backup-file}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2214 @code{directory-file-name}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2215 @code{directory-files}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2216 @code{dired-call-process}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2217 @code{dired-compress-file}, @code{dired-uncache}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2218 @code{expand-file-name}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2219 @code{file-accessible-direc@discretionary{}{}{}tory-p}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2220 @code{file-attributes}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2221 @code{file-direct@discretionary{}{}{}ory-p}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2222 @code{file-executable-p}, @code{file-exists-p}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2223 @code{file-local-copy}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2224 @code{file-modes}, @code{file-name-all-completions}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2225 @code{file-name-as-directory}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2226 @code{file-name-completion}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2227 @code{file-name-directory}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2228 @code{file-name-nondirec@discretionary{}{}{}tory}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2229 @code{file-name-sans-versions}, @code{file-newer-than-file-p}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2230 @code{file-ownership-pre@discretionary{}{}{}served-p}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2231 @code{file-readable-p}, @code{file-regular-p}, @code{file-symlink-p}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2232 @code{file-truename}, @code{file-writable-p}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2233 @code{find-backup-file-name}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2234 @code{get-file-buffer}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2235 @code{insert-directory}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2236 @code{insert-file-contents}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2237 @code{load}, @code{make-direc@discretionary{}{}{}tory}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2238 @code{make-symbolic-link}, @code{rename-file}, @code{set-file-modes}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2239 @code{set-visited-file-modtime}, @code{shell-command}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2240 @code{unhandled-file-name-directory}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2241 @code{vc-regis@discretionary{}{}{}tered}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2242 @code{verify-visited-file-modtime}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2243 @code{write-region}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2244 @end flushleft |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2245 @end iftex |
6555 | 2246 |
8118
56b5ed321f8d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2247 Handlers for @code{insert-file-contents} typically need to clear the |
56b5ed321f8d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2248 buffer's modified flag, with @code{(set-buffer-modified-p nil)}, if the |
56b5ed321f8d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2249 @var{visit} argument is non-@code{nil}. This also has the effect of |
56b5ed321f8d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2250 unlocking the buffer if it is locked. |
56b5ed321f8d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2251 |
6555 | 2252 The handler function must handle all of the above operations, and |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2253 possibly others to be added in the future. It need not implement all |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2254 these operations itself---when it has nothing special to do for a |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2255 certain operation, it can reinvoke the primitive, to handle the |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2256 operation ``in the usual way''. It should always reinvoke the primitive |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2257 for an operation it does not recognize. Here's one way to do this: |
6555 | 2258 |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2259 @smallexample |
6555 | 2260 (defun my-file-handler (operation &rest args) |
2261 ;; @r{First check for the specific operations} | |
2262 ;; @r{that we have special handling for.} | |
2263 (cond ((eq operation 'insert-file-contents) @dots{}) | |
2264 ((eq operation 'write-region) @dots{}) | |
2265 @dots{} | |
2266 ;; @r{Handle any operation we don't know about.} | |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2267 (t (let ((inhibit-file-name-handlers |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2268 (cons 'my-file-handler |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2269 (and (eq inhibit-file-name-operation operation) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2270 inhibit-file-name-handlers))) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2271 (inhibit-file-name-operation operation)) |
6555 | 2272 (apply operation args))))) |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2273 @end smallexample |
6555 | 2274 |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2275 When a handler function decides to call the ordinary Emacs primitive for |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2276 the operation at hand, it needs to prevent the primitive from calling |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2277 the same handler once again, thus leading to an infinite recursion. The |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2278 example above shows how to do this, with the variables |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2279 @code{inhibit-file-name-handlers} and |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2280 @code{inhibit-file-name-operation}. Be careful to use them exactly as |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2281 shown above; the details are crucial for proper behavior in the case of |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2282 multiple handlers, and for operations that have two file names that may |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2283 each have handlers. |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2284 |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2285 @defvar inhibit-file-name-handlers |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2286 This variable holds a list of handlers whose use is presently inhibited |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2287 for a certain operation. |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2288 @end defvar |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2289 |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2290 @defvar inhibit-file-name-operation |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2291 The operation for which certain handlers are presently inhibited. |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2292 @end defvar |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2293 |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2294 @defun find-file-name-handler file operation |
6555 | 2295 This function returns the handler function for file name @var{file}, or |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2296 @code{nil} if there is none. The argument @var{operation} should be the |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2297 operation to be performed on the file---the value you will pass to the |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2298 handler as its first argument when you call it. The operation is needed |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2299 for comparison with @code{inhibit-file-name-operation}. |
6555 | 2300 @end defun |
2301 | |
2302 @defun file-local-copy filename | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2303 This function copies file @var{filename} to an ordinary non-magic file, |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2304 if it isn't one already. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2305 |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2306 If @var{filename} specifies a magic file name, which programs |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2307 outside Emacs cannot directly read or write, this copies the contents to |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2308 an ordinary file and returns that file's name. |
6555 | 2309 |
2310 If @var{filename} is an ordinary file name, not magic, then this function | |
2311 does nothing and returns @code{nil}. | |
2312 @end defun | |
2313 | |
2314 @defun unhandled-file-name-directory filename | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2315 This function returns the name of a directory that is not magic. It |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2316 uses the directory part of @var{filename} if that is not magic. For a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2317 magic file name, it invokes the file name handler, which therefore |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2318 decides what value to return. |
6555 | 2319 |
2320 This is useful for running a subprocess; every subprocess must have a | |
2321 non-magic directory to serve as its current directory, and this function | |
2322 is a good way to come up with one. | |
2323 @end defun | |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2324 |
12067 | 2325 @node Format Conversion |
2326 @section File Format Conversion | |
2327 | |
2328 @cindex file format conversion | |
2329 @cindex encoding file formats | |
2330 @cindex decoding file formats | |
2331 The variable @code{format-alist} defines a list of @dfn{file formats}, | |
12098 | 2332 which describe textual representations used in files for the data (text, |
12067 | 2333 text-properties, and possibly other information) in an Emacs buffer. |
12098 | 2334 Emacs performs format conversion if appropriate when reading and writing |
2335 files. | |
12067 | 2336 |
2337 @defvar format-alist | |
2338 This list contains one format definition for each defined file format. | |
2339 @end defvar | |
2340 | |
2341 @cindex format definition | |
2342 Each format definition is a list of this form: | |
2343 | |
2344 @example | |
2345 (@var{name} @var{doc-string} @var{regexp} @var{from-fn} @var{to-fn} @var{modify} @var{mode-fn}) | |
2346 @end example | |
2347 | |
2348 Here is what the elements in a format definition mean: | |
2349 | |
2350 @table @var | |
2351 @item name | |
2352 The name of this format. | |
2353 | |
2354 @item doc-string | |
2355 A documentation string for the format. | |
2356 | |
2357 @item regexp | |
2358 A regular expression which is used to recognize files represented in | |
2359 this format. | |
2360 | |
2361 @item from-fn | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2362 A shell command or function to decode data in this format (to convert |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2363 file data into the usual Emacs data representation). |
12067 | 2364 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2365 A shell command is represented as a string; Emacs runs the command as a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2366 filter to perform the conversion. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2367 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2368 If @var{from-fn} is a function, it is called with two arguments, @var{begin} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2369 and @var{end}, which specify the part of the buffer it should convert. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2370 It should convert the text by editing it in place. Since this can |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2371 change the length of the text, @var{from-fn} should return the modified |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2372 end position. |
12067 | 2373 |
12098 | 2374 One responsibility of @var{from-fn} is to make sure that the beginning |
12067 | 2375 of the file no longer matches @var{regexp}. Otherwise it is likely to |
2376 get called again. | |
2377 | |
2378 @item to-fn | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2379 A shell command or function to encode data in this format---that is, to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2380 convert the usual Emacs data representation into this format. |
12067 | 2381 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2382 If @var{to-fn} is a string, it is a shell command; Emacs runs the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2383 command as a filter to perform the conversion. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2384 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2385 If @var{to-fn} is a function, it is called with two arguments, @var{begin} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2386 and @var{end}, which specify the part of the buffer it should convert. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2387 There are two ways it can do the conversion: |
12067 | 2388 |
2389 @itemize @bullet | |
2390 @item | |
2391 By editing the buffer in place. In this case, @var{to-fn} should | |
2392 return the end-position of the range of text, as modified. | |
2393 | |
2394 @item | |
2395 By returning a list of annotations. This is a list of elements of the | |
2396 form @code{(@var{position} . @var{string})}, where @var{position} is an | |
2397 integer specifying the relative position in the text to be written, and | |
2398 @var{string} is the annotation to add there. The list must be sorted in | |
2399 order of position when @var{to-fn} returns it. | |
2400 | |
2401 When @code{write-region} actually writes the text from the buffer to the | |
2402 file, it intermixes the specified annotations at the corresponding | |
2403 positions. All this takes place without modifying the buffer. | |
2404 @end itemize | |
2405 | |
2406 @item modify | |
2407 A flag, @code{t} if the encoding function modifies the buffer, and | |
2408 @code{nil} if it works by returning a list of annotations. | |
2409 | |
27259
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
2410 @item mode-fn |
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
2411 A minor-mode function to call after visiting a file converted from this |
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
2412 format. The function is called with one argument, the integer 1; |
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
2413 that tells a minor-mode function to enable the mode. |
12067 | 2414 @end table |
2415 | |
2416 The function @code{insert-file-contents} automatically recognizes file | |
2417 formats when it reads the specified file. It checks the text of the | |
2418 beginning of the file against the regular expressions of the format | |
2419 definitions, and if it finds a match, it calls the decoding function for | |
2420 that format. Then it checks all the known formats over again. | |
2421 It keeps checking them until none of them is applicable. | |
2422 | |
2423 Visiting a file, with @code{find-file-noselect} or the commands that use | |
2424 it, performs conversion likewise (because it calls | |
12098 | 2425 @code{insert-file-contents}); it also calls the mode function for each |
2426 format that it decodes. It stores a list of the format names in the | |
2427 buffer-local variable @code{buffer-file-format}. | |
12067 | 2428 |
2429 @defvar buffer-file-format | |
12098 | 2430 This variable states the format of the visited file. More precisely, |
2431 this is a list of the file format names that were decoded in the course | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2432 of visiting the current buffer's file. It is always buffer-local in all |
12067 | 2433 buffers. |
2434 @end defvar | |
2435 | |
2436 When @code{write-region} writes data into a file, it first calls the | |
12098 | 2437 encoding functions for the formats listed in @code{buffer-file-format}, |
2438 in the order of appearance in the list. | |
12067 | 2439 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2440 @deffn Command format-write-file file format |
12067 | 2441 This command writes the current buffer contents into the file @var{file} |
2442 in format @var{format}, and makes that format the default for future | |
12098 | 2443 saves of the buffer. The argument @var{format} is a list of format |
2444 names. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2445 @end deffn |
12067 | 2446 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2447 @deffn Command format-find-file file format |
12226 | 2448 This command finds the file @var{file}, converting it according to |
2449 format @var{format}. It also makes @var{format} the default if the | |
2450 buffer is saved later. | |
2451 | |
2452 The argument @var{format} is a list of format names. If @var{format} is | |
2453 @code{nil}, no conversion takes place. Interactively, typing just | |
2454 @key{RET} for @var{format} specifies @code{nil}. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2455 @end deffn |
12226 | 2456 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2457 @deffn Command format-insert-file file format &optional beg end |
12226 | 2458 This command inserts the contents of file @var{file}, converting it |
2459 according to format @var{format}. If @var{beg} and @var{end} are | |
2460 non-@code{nil}, they specify which part of the file to read, as in | |
2461 @code{insert-file-contents} (@pxref{Reading from Files}). | |
2462 | |
2463 The return value is like what @code{insert-file-contents} returns: a | |
2464 list of the absolute file name and the length of the data inserted | |
2465 (after conversion). | |
2466 | |
2467 The argument @var{format} is a list of format names. If @var{format} is | |
2468 @code{nil}, no conversion takes place. Interactively, typing just | |
2469 @key{RET} for @var{format} specifies @code{nil}. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2470 @end deffn |
12226 | 2471 |
12067 | 2472 @defvar auto-save-file-format |
2473 This variable specifies the format to use for auto-saving. Its value is | |
2474 a list of format names, just like the value of | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2475 @code{buffer-file-format}; however, it is used instead of |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2476 @code{buffer-file-format} for writing auto-save files. This variable is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2477 always buffer-local in all buffers. |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2478 @end defvar |