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