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