Commit | Line | Data |
---|---|---|
b8d4c8d0 GM |
1 | @c -*-texinfo-*- |
2 | @c This is part of the GNU Emacs Lisp Reference Manual. | |
acaf905b | 3 | @c Copyright (C) 1990-1995, 1998-1999, 2001-2012 |
d24880de | 4 | @c Free Software Foundation, Inc. |
b8d4c8d0 | 5 | @c See the file elisp.texi for copying conditions. |
6336d8c3 | 6 | @setfilename ../../info/files |
b8d4c8d0 GM |
7 | @node Files, Backups and Auto-Saving, Documentation, Top |
8 | @comment node-name, next, previous, up | |
9 | @chapter Files | |
10 | ||
a59225b1 CY |
11 | This chapter describes the Emacs Lisp functions and variables to |
12 | find, create, view, save, and otherwise work with files and file | |
13 | directories. A few other file-related functions are described in | |
b8d4c8d0 GM |
14 | @ref{Buffers}, and those related to backups and auto-saving are |
15 | described in @ref{Backups and Auto-Saving}. | |
16 | ||
17 | Many of the file functions take one or more arguments that are file | |
18 | names. A file name is actually a string. Most of these functions | |
19 | expand file name arguments by calling @code{expand-file-name}, so that | |
20 | @file{~} is handled correctly, as are relative file names (including | |
a59225b1 CY |
21 | @samp{../}). @xref{File Name Expansion}. |
22 | ||
23 | In addition, certain @dfn{magic} file names are handled specially. | |
24 | For example, when a remote file name is specified, Emacs accesses the | |
25 | file over the network via an appropriate protocol (@pxref{Remote | |
26 | Files,, Remote Files, emacs, The GNU Emacs Manual}). This handling is | |
27 | done at a very low level, so you may assume that all the functions | |
28 | described in this chapter accept magic file names as file name | |
29 | arguments, except where noted. @xref{Magic File Names}, for details. | |
b8d4c8d0 GM |
30 | |
31 | When file I/O functions signal Lisp errors, they usually use the | |
32 | condition @code{file-error} (@pxref{Handling Errors}). The error | |
33 | message is in most cases obtained from the operating system, according | |
34 | to locale @code{system-message-locale}, and decoded using coding system | |
35 | @code{locale-coding-system} (@pxref{Locales}). | |
36 | ||
37 | @menu | |
38 | * Visiting Files:: Reading files into Emacs buffers for editing. | |
39 | * Saving Buffers:: Writing changed buffers back into files. | |
40 | * Reading from Files:: Reading files into buffers without visiting. | |
41 | * Writing to Files:: Writing new files from parts of buffers. | |
42 | * File Locks:: Locking and unlocking files, to prevent | |
43 | simultaneous editing by two people. | |
44 | * Information about Files:: Testing existence, accessibility, size of files. | |
a59225b1 | 45 | * Changing Files:: Renaming files, changing permissions, etc. |
b8d4c8d0 GM |
46 | * File Names:: Decomposing and expanding file names. |
47 | * Contents of Directories:: Getting a list of the files in a directory. | |
d24880de | 48 | * Create/Delete Dirs:: Creating and Deleting Directories. |
a59225b1 | 49 | * Magic File Names:: Special handling for certain file names. |
b8d4c8d0 GM |
50 | * Format Conversion:: Conversion to and from various file formats. |
51 | @end menu | |
52 | ||
53 | @node Visiting Files | |
54 | @section Visiting Files | |
55 | @cindex finding files | |
56 | @cindex visiting files | |
57 | ||
58 | Visiting a file means reading a file into a buffer. Once this is | |
59 | done, we say that the buffer is @dfn{visiting} that file, and call the | |
60 | file ``the visited file'' of the buffer. | |
61 | ||
62 | A file and a buffer are two different things. A file is information | |
63 | recorded permanently in the computer (unless you delete it). A buffer, | |
64 | on the other hand, is information inside of Emacs that will vanish at | |
65 | the end of the editing session (or when you kill the buffer). Usually, | |
66 | a buffer contains information that you have copied from a file; then we | |
67 | say the buffer is visiting that file. The copy in the buffer is what | |
68 | you modify with editing commands. Such changes to the buffer do not | |
69 | change the file; therefore, to make the changes permanent, you must | |
70 | @dfn{save} the buffer, which means copying the altered buffer contents | |
71 | back into the file. | |
72 | ||
73 | In spite of the distinction between files and buffers, people often | |
74 | refer to a file when they mean a buffer and vice-versa. Indeed, we say, | |
75 | ``I am editing a file,'' rather than, ``I am editing a buffer that I | |
76 | will soon save as a file of the same name.'' Humans do not usually need | |
77 | to make the distinction explicit. When dealing with a computer program, | |
78 | however, it is good to keep the distinction in mind. | |
79 | ||
80 | @menu | |
81 | * Visiting Functions:: The usual interface functions for visiting. | |
82 | * Subroutines of Visiting:: Lower-level subroutines that they use. | |
83 | @end menu | |
84 | ||
85 | @node Visiting Functions | |
86 | @subsection Functions for Visiting Files | |
87 | ||
88 | This section describes the functions normally used to visit files. | |
89 | For historical reasons, these functions have names starting with | |
90 | @samp{find-} rather than @samp{visit-}. @xref{Buffer File Name}, for | |
91 | functions and variables that access the visited file name of a buffer or | |
92 | that find an existing buffer by its visited file name. | |
93 | ||
94 | In a Lisp program, if you want to look at the contents of a file but | |
95 | not alter it, the fastest way is to use @code{insert-file-contents} in a | |
96 | temporary buffer. Visiting the file is not necessary and takes longer. | |
97 | @xref{Reading from Files}. | |
98 | ||
99 | @deffn Command find-file filename &optional wildcards | |
100 | This command selects a buffer visiting the file @var{filename}, | |
101 | using an existing buffer if there is one, and otherwise creating a | |
102 | new buffer and reading the file into it. It also returns that buffer. | |
103 | ||
104 | Aside from some technical details, the body of the @code{find-file} | |
105 | function is basically equivalent to: | |
106 | ||
107 | @smallexample | |
108 | (switch-to-buffer (find-file-noselect filename nil nil wildcards)) | |
109 | @end smallexample | |
110 | ||
111 | @noindent | |
0e406a72 | 112 | (See @code{switch-to-buffer} in @ref{Switching Buffers}.) |
b8d4c8d0 GM |
113 | |
114 | If @var{wildcards} is non-@code{nil}, which is always true in an | |
115 | interactive call, then @code{find-file} expands wildcard characters in | |
116 | @var{filename} and visits all the matching files. | |
117 | ||
118 | When @code{find-file} is called interactively, it prompts for | |
119 | @var{filename} in the minibuffer. | |
120 | @end deffn | |
121 | ||
e03b2fd4 EZ |
122 | @deffn Command find-file-literally filename |
123 | This command visits @var{filename}, like @code{find-file} does, but it | |
124 | does not perform any format conversions (@pxref{Format Conversion}), | |
125 | character code conversions (@pxref{Coding Systems}), or end-of-line | |
126 | conversions (@pxref{Coding System Basics, End of line conversion}). | |
127 | The buffer visiting the file is made unibyte, and its major mode is | |
128 | Fundamental mode, regardless of the file name. File local variable | |
129 | specifications in the file (@pxref{File Local Variables}) are | |
130 | ignored, and automatic decompression and adding a newline at the end | |
131 | of the file due to @code{require-final-newline} (@pxref{Saving | |
132 | Buffers, require-final-newline}) are also disabled. | |
133 | ||
134 | Note that if Emacs already has a buffer visiting the same file | |
135 | non-literally, it will not visit the same file literally, but instead | |
136 | just switch to the existing buffer. If you want to be sure of | |
137 | accessing a file's contents literally, you should create a temporary | |
138 | buffer and then read the file contents into it using | |
139 | @code{insert-file-contents-literally} (@pxref{Reading from Files}). | |
140 | @end deffn | |
141 | ||
b8d4c8d0 GM |
142 | @defun find-file-noselect filename &optional nowarn rawfile wildcards |
143 | This function is the guts of all the file-visiting functions. It | |
144 | returns a buffer visiting the file @var{filename}. You may make the | |
145 | buffer current or display it in a window if you wish, but this | |
146 | function does not do so. | |
147 | ||
148 | The function returns an existing buffer if there is one; otherwise it | |
149 | creates a new buffer and reads the file into it. When | |
150 | @code{find-file-noselect} uses an existing buffer, it first verifies | |
151 | that the file has not changed since it was last visited or saved in | |
152 | that buffer. If the file has changed, this function asks the user | |
153 | whether to reread the changed file. If the user says @samp{yes}, any | |
154 | edits previously made in the buffer are lost. | |
155 | ||
156 | Reading the file involves decoding the file's contents (@pxref{Coding | |
157 | Systems}), including end-of-line conversion, and format conversion | |
158 | (@pxref{Format Conversion}). If @var{wildcards} is non-@code{nil}, | |
159 | then @code{find-file-noselect} expands wildcard characters in | |
160 | @var{filename} and visits all the matching files. | |
161 | ||
162 | This function displays warning or advisory messages in various peculiar | |
163 | cases, unless the optional argument @var{nowarn} is non-@code{nil}. For | |
164 | example, if it needs to create a buffer, and there is no file named | |
165 | @var{filename}, it displays the message @samp{(New file)} in the echo | |
166 | area, and leaves the buffer empty. | |
167 | ||
168 | The @code{find-file-noselect} function normally calls | |
169 | @code{after-find-file} after reading the file (@pxref{Subroutines of | |
170 | Visiting}). That function sets the buffer major mode, parses local | |
171 | variables, warns the user if there exists an auto-save file more recent | |
172 | than the file just visited, and finishes by running the functions in | |
173 | @code{find-file-hook}. | |
174 | ||
175 | If the optional argument @var{rawfile} is non-@code{nil}, then | |
176 | @code{after-find-file} is not called, and the | |
177 | @code{find-file-not-found-functions} are not run in case of failure. | |
178 | What's more, a non-@code{nil} @var{rawfile} value suppresses coding | |
179 | system conversion and format conversion. | |
180 | ||
181 | The @code{find-file-noselect} function usually returns the buffer that | |
182 | is visiting the file @var{filename}. But, if wildcards are actually | |
183 | used and expanded, it returns a list of buffers that are visiting the | |
184 | various files. | |
185 | ||
186 | @example | |
187 | @group | |
188 | (find-file-noselect "/etc/fstab") | |
189 | @result{} #<buffer fstab> | |
190 | @end group | |
191 | @end example | |
192 | @end defun | |
193 | ||
194 | @deffn Command find-file-other-window filename &optional wildcards | |
195 | This command selects a buffer visiting the file @var{filename}, but | |
0e406a72 CY |
196 | does so in a window other than the selected window. It may use |
197 | another existing window or split a window; see @ref{Switching | |
198 | Buffers}. | |
b8d4c8d0 GM |
199 | |
200 | When this command is called interactively, it prompts for | |
201 | @var{filename}. | |
202 | @end deffn | |
203 | ||
204 | @deffn Command find-file-read-only filename &optional wildcards | |
205 | This command selects a buffer visiting the file @var{filename}, like | |
206 | @code{find-file}, but it marks the buffer as read-only. @xref{Read Only | |
207 | Buffers}, for related functions and variables. | |
208 | ||
209 | When this command is called interactively, it prompts for | |
210 | @var{filename}. | |
211 | @end deffn | |
212 | ||
b8d4c8d0 GM |
213 | @defopt find-file-wildcards |
214 | If this variable is non-@code{nil}, then the various @code{find-file} | |
215 | commands check for wildcard characters and visit all the files that | |
216 | match them (when invoked interactively or when their @var{wildcards} | |
217 | argument is non-@code{nil}). If this option is @code{nil}, then | |
218 | the @code{find-file} commands ignore their @var{wildcards} argument | |
219 | and never treat wildcard characters specially. | |
220 | @end defopt | |
221 | ||
01f17ae2 | 222 | @defopt find-file-hook |
b8d4c8d0 GM |
223 | The value of this variable is a list of functions to be called after a |
224 | file is visited. The file's local-variables specification (if any) will | |
225 | have been processed before the hooks are run. The buffer visiting the | |
226 | file is current when the hook functions are run. | |
227 | ||
228 | This variable is a normal hook. @xref{Hooks}. | |
01f17ae2 | 229 | @end defopt |
b8d4c8d0 GM |
230 | |
231 | @defvar find-file-not-found-functions | |
232 | The value of this variable is a list of functions to be called when | |
233 | @code{find-file} or @code{find-file-noselect} is passed a nonexistent | |
234 | file name. @code{find-file-noselect} calls these functions as soon as | |
235 | it detects a nonexistent file. It calls them in the order of the list, | |
236 | until one of them returns non-@code{nil}. @code{buffer-file-name} is | |
237 | already set up. | |
238 | ||
239 | This is not a normal hook because the values of the functions are | |
240 | used, and in many cases only some of the functions are called. | |
241 | @end defvar | |
242 | ||
e03b2fd4 EZ |
243 | @defvar find-file-literally |
244 | This buffer-local variable, if set to a non-@code{nil} value, makes | |
245 | @code{save-buffer} behave as if the buffer were visiting its file | |
246 | literally, i.e. without conversions of any kind. The command | |
247 | @code{find-file-literally} sets this variable's local value, but other | |
248 | equivalent functions and commands can do that as well, e.g.@: to avoid | |
249 | automatic addition of a newline at the end of the file. This variable | |
3ee240fa | 250 | is permanent local, so it is unaffected by changes of major modes. |
e03b2fd4 EZ |
251 | @end defvar |
252 | ||
b8d4c8d0 GM |
253 | @node Subroutines of Visiting |
254 | @comment node-name, next, previous, up | |
255 | @subsection Subroutines of Visiting | |
256 | ||
257 | The @code{find-file-noselect} function uses two important subroutines | |
258 | which are sometimes useful in user Lisp code: @code{create-file-buffer} | |
259 | and @code{after-find-file}. This section explains how to use them. | |
260 | ||
261 | @defun create-file-buffer filename | |
262 | This function creates a suitably named buffer for visiting | |
263 | @var{filename}, and returns it. It uses @var{filename} (sans directory) | |
264 | as the name if that name is free; otherwise, it appends a string such as | |
265 | @samp{<2>} to get an unused name. See also @ref{Creating Buffers}. | |
266 | ||
267 | @strong{Please note:} @code{create-file-buffer} does @emph{not} | |
268 | associate the new buffer with a file and does not select the buffer. | |
269 | It also does not use the default major mode. | |
270 | ||
271 | @example | |
272 | @group | |
273 | (create-file-buffer "foo") | |
274 | @result{} #<buffer foo> | |
275 | @end group | |
276 | @group | |
277 | (create-file-buffer "foo") | |
278 | @result{} #<buffer foo<2>> | |
279 | @end group | |
280 | @group | |
281 | (create-file-buffer "foo") | |
282 | @result{} #<buffer foo<3>> | |
283 | @end group | |
284 | @end example | |
285 | ||
286 | This function is used by @code{find-file-noselect}. | |
287 | It uses @code{generate-new-buffer} (@pxref{Creating Buffers}). | |
288 | @end defun | |
289 | ||
290 | @defun after-find-file &optional error warn noauto after-find-file-from-revert-buffer nomodes | |
291 | This function sets the buffer major mode, and parses local variables | |
292 | (@pxref{Auto Major Mode}). It is called by @code{find-file-noselect} | |
293 | and by the default revert function (@pxref{Reverting}). | |
294 | ||
295 | @cindex new file message | |
296 | @cindex file open error | |
297 | If reading the file got an error because the file does not exist, but | |
298 | its directory does exist, the caller should pass a non-@code{nil} value | |
299 | for @var{error}. In that case, @code{after-find-file} issues a warning: | |
300 | @samp{(New file)}. For more serious errors, the caller should usually not | |
301 | call @code{after-find-file}. | |
302 | ||
303 | If @var{warn} is non-@code{nil}, then this function issues a warning | |
304 | if an auto-save file exists and is more recent than the visited file. | |
305 | ||
306 | If @var{noauto} is non-@code{nil}, that says not to enable or disable | |
307 | Auto-Save mode. The mode remains enabled if it was enabled before. | |
308 | ||
309 | If @var{after-find-file-from-revert-buffer} is non-@code{nil}, that | |
310 | means this call was from @code{revert-buffer}. This has no direct | |
311 | effect, but some mode functions and hook functions check the value | |
312 | of this variable. | |
313 | ||
314 | If @var{nomodes} is non-@code{nil}, that means don't alter the buffer's | |
315 | major mode, don't process local variables specifications in the file, | |
316 | and don't run @code{find-file-hook}. This feature is used by | |
317 | @code{revert-buffer} in some cases. | |
318 | ||
319 | The last thing @code{after-find-file} does is call all the functions | |
320 | in the list @code{find-file-hook}. | |
321 | @end defun | |
322 | ||
323 | @node Saving Buffers | |
324 | @section Saving Buffers | |
325 | @cindex saving buffers | |
326 | ||
327 | When you edit a file in Emacs, you are actually working on a buffer | |
328 | that is visiting that file---that is, the contents of the file are | |
329 | copied into the buffer and the copy is what you edit. Changes to the | |
330 | buffer do not change the file until you @dfn{save} the buffer, which | |
331 | means copying the contents of the buffer into the file. | |
332 | ||
333 | @deffn Command save-buffer &optional backup-option | |
334 | This function saves the contents of the current buffer in its visited | |
335 | file if the buffer has been modified since it was last visited or saved. | |
336 | Otherwise it does nothing. | |
337 | ||
338 | @code{save-buffer} is responsible for making backup files. Normally, | |
339 | @var{backup-option} is @code{nil}, and @code{save-buffer} makes a backup | |
340 | file only if this is the first save since visiting the file. Other | |
341 | values for @var{backup-option} request the making of backup files in | |
342 | other circumstances: | |
343 | ||
344 | @itemize @bullet | |
345 | @item | |
346 | With an argument of 4 or 64, reflecting 1 or 3 @kbd{C-u}'s, the | |
347 | @code{save-buffer} function marks this version of the file to be | |
348 | backed up when the buffer is next saved. | |
349 | ||
350 | @item | |
351 | With an argument of 16 or 64, reflecting 2 or 3 @kbd{C-u}'s, the | |
352 | @code{save-buffer} function unconditionally backs up the previous | |
353 | version of the file before saving it. | |
354 | ||
355 | @item | |
356 | With an argument of 0, unconditionally do @emph{not} make any backup file. | |
357 | @end itemize | |
358 | @end deffn | |
359 | ||
360 | @deffn Command save-some-buffers &optional save-silently-p pred | |
361 | @anchor{Definition of save-some-buffers} | |
362 | This command saves some modified file-visiting buffers. Normally it | |
363 | asks the user about each buffer. But if @var{save-silently-p} is | |
364 | non-@code{nil}, it saves all the file-visiting buffers without querying | |
365 | the user. | |
366 | ||
367 | The optional @var{pred} argument controls which buffers to ask about | |
368 | (or to save silently if @var{save-silently-p} is non-@code{nil}). | |
369 | If it is @code{nil}, that means to ask only about file-visiting buffers. | |
370 | If it is @code{t}, that means also offer to save certain other non-file | |
371 | buffers---those that have a non-@code{nil} buffer-local value of | |
372 | @code{buffer-offer-save} (@pxref{Killing Buffers}). A user who says | |
373 | @samp{yes} to saving a non-file buffer is asked to specify the file | |
374 | name to use. The @code{save-buffers-kill-emacs} function passes the | |
375 | value @code{t} for @var{pred}. | |
376 | ||
377 | If @var{pred} is neither @code{t} nor @code{nil}, then it should be | |
378 | a function of no arguments. It will be called in each buffer to decide | |
379 | whether to offer to save that buffer. If it returns a non-@code{nil} | |
380 | value in a certain buffer, that means do offer to save that buffer. | |
381 | @end deffn | |
382 | ||
383 | @deffn Command write-file filename &optional confirm | |
384 | @anchor{Definition of write-file} | |
385 | This function writes the current buffer into file @var{filename}, makes | |
386 | the buffer visit that file, and marks it not modified. Then it renames | |
387 | the buffer based on @var{filename}, appending a string like @samp{<2>} | |
388 | if necessary to make a unique buffer name. It does most of this work by | |
389 | calling @code{set-visited-file-name} (@pxref{Buffer File Name}) and | |
390 | @code{save-buffer}. | |
391 | ||
392 | If @var{confirm} is non-@code{nil}, that means to ask for confirmation | |
393 | before overwriting an existing file. Interactively, confirmation is | |
394 | required, unless the user supplies a prefix argument. | |
395 | ||
396 | If @var{filename} is an existing directory, or a symbolic link to one, | |
397 | @code{write-file} uses the name of the visited file, in directory | |
398 | @var{filename}. If the buffer is not visiting a file, it uses the | |
399 | buffer name instead. | |
400 | @end deffn | |
401 | ||
402 | Saving a buffer runs several hooks. It also performs format | |
403 | conversion (@pxref{Format Conversion}). | |
404 | ||
405 | @defvar write-file-functions | |
406 | The value of this variable is a list of functions to be called before | |
407 | writing out a buffer to its visited file. If one of them returns | |
408 | non-@code{nil}, the file is considered already written and the rest of | |
409 | the functions are not called, nor is the usual code for writing the file | |
410 | executed. | |
411 | ||
412 | If a function in @code{write-file-functions} returns non-@code{nil}, it | |
413 | is responsible for making a backup file (if that is appropriate). | |
414 | To do so, execute the following code: | |
415 | ||
416 | @example | |
417 | (or buffer-backed-up (backup-buffer)) | |
418 | @end example | |
419 | ||
420 | You might wish to save the file modes value returned by | |
421 | @code{backup-buffer} and use that (if non-@code{nil}) to set the mode | |
422 | bits of the file that you write. This is what @code{save-buffer} | |
423 | normally does. @xref{Making Backups,, Making Backup Files}. | |
424 | ||
425 | The hook functions in @code{write-file-functions} are also responsible | |
426 | for encoding the data (if desired): they must choose a suitable coding | |
427 | system and end-of-line conversion (@pxref{Lisp and Coding Systems}), | |
428 | perform the encoding (@pxref{Explicit Encoding}), and set | |
429 | @code{last-coding-system-used} to the coding system that was used | |
430 | (@pxref{Encoding and I/O}). | |
431 | ||
432 | If you set this hook locally in a buffer, it is assumed to be | |
433 | associated with the file or the way the contents of the buffer were | |
434 | obtained. Thus the variable is marked as a permanent local, so that | |
435 | changing the major mode does not alter a buffer-local value. On the | |
436 | other hand, calling @code{set-visited-file-name} will reset it. | |
437 | If this is not what you want, you might like to use | |
438 | @code{write-contents-functions} instead. | |
439 | ||
440 | Even though this is not a normal hook, you can use @code{add-hook} and | |
441 | @code{remove-hook} to manipulate the list. @xref{Hooks}. | |
442 | @end defvar | |
443 | ||
444 | @c Emacs 19 feature | |
445 | @defvar write-contents-functions | |
446 | This works just like @code{write-file-functions}, but it is intended | |
447 | for hooks that pertain to the buffer's contents, not to the particular | |
448 | visited file or its location. Such hooks are usually set up by major | |
449 | modes, as buffer-local bindings for this variable. This variable | |
450 | automatically becomes buffer-local whenever it is set; switching to a | |
451 | new major mode always resets this variable, but calling | |
452 | @code{set-visited-file-name} does not. | |
453 | ||
454 | If any of the functions in this hook returns non-@code{nil}, the file | |
455 | is considered already written and the rest are not called and neither | |
456 | are the functions in @code{write-file-functions}. | |
457 | @end defvar | |
458 | ||
459 | @defopt before-save-hook | |
460 | This normal hook runs before a buffer is saved in its visited file, | |
461 | regardless of whether that is done normally or by one of the hooks | |
462 | described above. For instance, the @file{copyright.el} program uses | |
463 | this hook to make sure the file you are saving has the current year in | |
464 | its copyright notice. | |
465 | @end defopt | |
466 | ||
467 | @c Emacs 19 feature | |
468 | @defopt after-save-hook | |
469 | This normal hook runs after a buffer has been saved in its visited file. | |
470 | One use of this hook is in Fast Lock mode; it uses this hook to save the | |
471 | highlighting information in a cache file. | |
472 | @end defopt | |
473 | ||
474 | @defopt file-precious-flag | |
475 | If this variable is non-@code{nil}, then @code{save-buffer} protects | |
476 | against I/O errors while saving by writing the new file to a temporary | |
477 | name instead of the name it is supposed to have, and then renaming it to | |
478 | the intended name after it is clear there are no errors. This procedure | |
479 | prevents problems such as a lack of disk space from resulting in an | |
480 | invalid file. | |
481 | ||
482 | As a side effect, backups are necessarily made by copying. @xref{Rename | |
483 | or Copy}. Yet, at the same time, saving a precious file always breaks | |
484 | all hard links between the file you save and other file names. | |
485 | ||
486 | Some modes give this variable a non-@code{nil} buffer-local value | |
487 | in particular buffers. | |
488 | @end defopt | |
489 | ||
490 | @defopt require-final-newline | |
491 | This variable determines whether files may be written out that do | |
492 | @emph{not} end with a newline. If the value of the variable is | |
493 | @code{t}, then @code{save-buffer} silently adds a newline at the end of | |
494 | the file whenever the buffer being saved does not already end in one. | |
495 | If the value of the variable is non-@code{nil}, but not @code{t}, then | |
496 | @code{save-buffer} asks the user whether to add a newline each time the | |
497 | case arises. | |
498 | ||
499 | If the value of the variable is @code{nil}, then @code{save-buffer} | |
500 | doesn't add newlines at all. @code{nil} is the default value, but a few | |
501 | major modes set it to @code{t} in particular buffers. | |
502 | @end defopt | |
503 | ||
504 | See also the function @code{set-visited-file-name} (@pxref{Buffer File | |
505 | Name}). | |
506 | ||
507 | @node Reading from Files | |
508 | @comment node-name, next, previous, up | |
509 | @section Reading from Files | |
510 | @cindex reading from files | |
511 | ||
512 | You can copy a file from the disk and insert it into a buffer | |
513 | using the @code{insert-file-contents} function. Don't use the user-level | |
514 | command @code{insert-file} in a Lisp program, as that sets the mark. | |
515 | ||
516 | @defun insert-file-contents filename &optional visit beg end replace | |
517 | This function inserts the contents of file @var{filename} into the | |
518 | current buffer after point. It returns a list of the absolute file name | |
519 | and the length of the data inserted. An error is signaled if | |
520 | @var{filename} is not the name of a file that can be read. | |
521 | ||
a59225b1 CY |
522 | This function checks the file contents against the defined file |
523 | formats, and converts the file contents if appropriate and also calls | |
524 | the functions in the list @code{after-insert-file-functions}. | |
525 | @xref{Format Conversion}. Normally, one of the functions in the | |
b8d4c8d0 GM |
526 | @code{after-insert-file-functions} list determines the coding system |
527 | (@pxref{Coding Systems}) used for decoding the file's contents, | |
7951ad77 | 528 | including end-of-line conversion. However, if the file contains null |
a59225b1 CY |
529 | bytes, it is by default visited without any code conversions. |
530 | @xref{Lisp and Coding Systems, inhibit-null-byte-detection}. | |
b8d4c8d0 GM |
531 | |
532 | If @var{visit} is non-@code{nil}, this function additionally marks the | |
533 | buffer as unmodified and sets up various fields in the buffer so that it | |
534 | is visiting the file @var{filename}: these include the buffer's visited | |
535 | file name and its last save file modtime. This feature is used by | |
536 | @code{find-file-noselect} and you probably should not use it yourself. | |
537 | ||
538 | If @var{beg} and @var{end} are non-@code{nil}, they should be integers | |
539 | specifying the portion of the file to insert. In this case, @var{visit} | |
540 | must be @code{nil}. For example, | |
541 | ||
542 | @example | |
543 | (insert-file-contents filename nil 0 500) | |
544 | @end example | |
545 | ||
546 | @noindent | |
547 | inserts the first 500 characters of a file. | |
548 | ||
549 | If the argument @var{replace} is non-@code{nil}, it means to replace the | |
550 | contents of the buffer (actually, just the accessible portion) with the | |
551 | contents of the file. This is better than simply deleting the buffer | |
552 | contents and inserting the whole file, because (1) it preserves some | |
553 | marker positions and (2) it puts less data in the undo list. | |
554 | ||
555 | It is possible to read a special file (such as a FIFO or an I/O device) | |
556 | with @code{insert-file-contents}, as long as @var{replace} and | |
557 | @var{visit} are @code{nil}. | |
558 | @end defun | |
559 | ||
560 | @defun insert-file-contents-literally filename &optional visit beg end replace | |
a59225b1 CY |
561 | This function works like @code{insert-file-contents} except that it |
562 | does not run @code{find-file-hook}, and does not do format decoding, | |
563 | character code conversion, automatic uncompression, and so on. | |
b8d4c8d0 GM |
564 | @end defun |
565 | ||
566 | If you want to pass a file name to another process so that another | |
567 | program can read the file, use the function @code{file-local-copy}; see | |
568 | @ref{Magic File Names}. | |
569 | ||
570 | @node Writing to Files | |
571 | @comment node-name, next, previous, up | |
572 | @section Writing to Files | |
573 | @cindex writing to files | |
574 | ||
575 | You can write the contents of a buffer, or part of a buffer, directly | |
576 | to a file on disk using the @code{append-to-file} and | |
577 | @code{write-region} functions. Don't use these functions to write to | |
578 | files that are being visited; that could cause confusion in the | |
579 | mechanisms for visiting. | |
580 | ||
581 | @deffn Command append-to-file start end filename | |
582 | This function appends the contents of the region delimited by | |
583 | @var{start} and @var{end} in the current buffer to the end of file | |
584 | @var{filename}. If that file does not exist, it is created. This | |
585 | function returns @code{nil}. | |
586 | ||
587 | An error is signaled if @var{filename} specifies a nonwritable file, | |
588 | or a nonexistent file in a directory where files cannot be created. | |
589 | ||
590 | When called from Lisp, this function is completely equivalent to: | |
591 | ||
592 | @example | |
593 | (write-region start end filename t) | |
594 | @end example | |
595 | @end deffn | |
596 | ||
597 | @deffn Command write-region start end filename &optional append visit lockname mustbenew | |
598 | This function writes the region delimited by @var{start} and @var{end} | |
599 | in the current buffer into the file specified by @var{filename}. | |
600 | ||
601 | If @var{start} is @code{nil}, then the command writes the entire buffer | |
602 | contents (@emph{not} just the accessible portion) to the file and | |
603 | ignores @var{end}. | |
604 | ||
605 | @c Emacs 19 feature | |
606 | If @var{start} is a string, then @code{write-region} writes or appends | |
607 | that string, rather than text from the buffer. @var{end} is ignored in | |
608 | this case. | |
609 | ||
610 | If @var{append} is non-@code{nil}, then the specified text is appended | |
611 | to the existing file contents (if any). If @var{append} is an | |
612 | integer, @code{write-region} seeks to that byte offset from the start | |
613 | of the file and writes the data from there. | |
614 | ||
615 | If @var{mustbenew} is non-@code{nil}, then @code{write-region} asks | |
616 | for confirmation if @var{filename} names an existing file. If | |
617 | @var{mustbenew} is the symbol @code{excl}, then @code{write-region} | |
618 | does not ask for confirmation, but instead it signals an error | |
619 | @code{file-already-exists} if the file already exists. | |
620 | ||
621 | The test for an existing file, when @var{mustbenew} is @code{excl}, uses | |
622 | a special system feature. At least for files on a local disk, there is | |
623 | no chance that some other program could create a file of the same name | |
624 | before Emacs does, without Emacs's noticing. | |
625 | ||
626 | If @var{visit} is @code{t}, then Emacs establishes an association | |
627 | between the buffer and the file: the buffer is then visiting that file. | |
628 | It also sets the last file modification time for the current buffer to | |
629 | @var{filename}'s modtime, and marks the buffer as not modified. This | |
630 | feature is used by @code{save-buffer}, but you probably should not use | |
631 | it yourself. | |
632 | ||
633 | @c Emacs 19 feature | |
634 | If @var{visit} is a string, it specifies the file name to visit. This | |
635 | way, you can write the data to one file (@var{filename}) while recording | |
636 | the buffer as visiting another file (@var{visit}). The argument | |
637 | @var{visit} is used in the echo area message and also for file locking; | |
638 | @var{visit} is stored in @code{buffer-file-name}. This feature is used | |
639 | to implement @code{file-precious-flag}; don't use it yourself unless you | |
640 | really know what you're doing. | |
641 | ||
642 | The optional argument @var{lockname}, if non-@code{nil}, specifies the | |
643 | file name to use for purposes of locking and unlocking, overriding | |
644 | @var{filename} and @var{visit} for that purpose. | |
645 | ||
646 | The function @code{write-region} converts the data which it writes to | |
647 | the appropriate file formats specified by @code{buffer-file-format} | |
648 | and also calls the functions in the list | |
649 | @code{write-region-annotate-functions}. | |
650 | @xref{Format Conversion}. | |
651 | ||
652 | Normally, @code{write-region} displays the message @samp{Wrote | |
653 | @var{filename}} in the echo area. If @var{visit} is neither @code{t} | |
654 | nor @code{nil} nor a string, then this message is inhibited. This | |
655 | feature is useful for programs that use files for internal purposes, | |
656 | files that the user does not need to know about. | |
657 | @end deffn | |
658 | ||
659 | @defmac with-temp-file file body@dots{} | |
660 | @anchor{Definition of with-temp-file} | |
661 | The @code{with-temp-file} macro evaluates the @var{body} forms with a | |
662 | temporary buffer as the current buffer; then, at the end, it writes the | |
663 | buffer contents into file @var{file}. It kills the temporary buffer | |
664 | when finished, restoring the buffer that was current before the | |
665 | @code{with-temp-file} form. Then it returns the value of the last form | |
666 | in @var{body}. | |
667 | ||
668 | The current buffer is restored even in case of an abnormal exit via | |
669 | @code{throw} or error (@pxref{Nonlocal Exits}). | |
670 | ||
671 | See also @code{with-temp-buffer} in @ref{Definition of | |
672 | with-temp-buffer,, The Current Buffer}. | |
673 | @end defmac | |
674 | ||
675 | @node File Locks | |
676 | @section File Locks | |
677 | @cindex file locks | |
678 | @cindex lock file | |
679 | ||
680 | When two users edit the same file at the same time, they are likely | |
681 | to interfere with each other. Emacs tries to prevent this situation | |
682 | from arising by recording a @dfn{file lock} when a file is being | |
683 | modified. (File locks are not implemented on Microsoft systems.) | |
684 | Emacs can then detect the first attempt to modify a buffer visiting a | |
685 | file that is locked by another Emacs job, and ask the user what to do. | |
686 | The file lock is really a file, a symbolic link with a special name, | |
687 | stored in the same directory as the file you are editing. | |
688 | ||
689 | When you access files using NFS, there may be a small probability that | |
690 | you and another user will both lock the same file ``simultaneously.'' | |
691 | If this happens, it is possible for the two users to make changes | |
692 | simultaneously, but Emacs will still warn the user who saves second. | |
693 | Also, the detection of modification of a buffer visiting a file changed | |
694 | on disk catches some cases of simultaneous editing; see | |
695 | @ref{Modification Time}. | |
696 | ||
697 | @defun file-locked-p filename | |
698 | This function returns @code{nil} if the file @var{filename} is not | |
699 | locked. It returns @code{t} if it is locked by this Emacs process, and | |
700 | it returns the name of the user who has locked it if it is locked by | |
701 | some other job. | |
702 | ||
703 | @example | |
704 | @group | |
705 | (file-locked-p "foo") | |
706 | @result{} nil | |
707 | @end group | |
708 | @end example | |
709 | @end defun | |
710 | ||
711 | @defun lock-buffer &optional filename | |
712 | This function locks the file @var{filename}, if the current buffer is | |
713 | modified. The argument @var{filename} defaults to the current buffer's | |
714 | visited file. Nothing is done if the current buffer is not visiting a | |
715 | file, or is not modified, or if the system does not support locking. | |
716 | @end defun | |
717 | ||
718 | @defun unlock-buffer | |
719 | This function unlocks the file being visited in the current buffer, | |
720 | if the buffer is modified. If the buffer is not modified, then | |
721 | the file should not be locked, so this function does nothing. It also | |
722 | does nothing if the current buffer is not visiting a file, or if the | |
723 | system does not support locking. | |
724 | @end defun | |
725 | ||
726 | File locking is not supported on some systems. On systems that do not | |
727 | support it, the functions @code{lock-buffer}, @code{unlock-buffer} and | |
728 | @code{file-locked-p} do nothing and return @code{nil}. | |
729 | ||
730 | @defun ask-user-about-lock file other-user | |
731 | This function is called when the user tries to modify @var{file}, but it | |
732 | is locked by another user named @var{other-user}. The default | |
733 | definition of this function asks the user to say what to do. The value | |
734 | this function returns determines what Emacs does next: | |
735 | ||
736 | @itemize @bullet | |
737 | @item | |
738 | A value of @code{t} says to grab the lock on the file. Then | |
739 | this user may edit the file and @var{other-user} loses the lock. | |
740 | ||
741 | @item | |
742 | A value of @code{nil} says to ignore the lock and let this | |
743 | user edit the file anyway. | |
744 | ||
745 | @item | |
746 | @kindex file-locked | |
747 | This function may instead signal a @code{file-locked} error, in which | |
748 | case the change that the user was about to make does not take place. | |
749 | ||
750 | The error message for this error looks like this: | |
751 | ||
752 | @example | |
753 | @error{} File is locked: @var{file} @var{other-user} | |
754 | @end example | |
755 | ||
756 | @noindent | |
757 | where @code{file} is the name of the file and @var{other-user} is the | |
758 | name of the user who has locked the file. | |
759 | @end itemize | |
760 | ||
761 | If you wish, you can replace the @code{ask-user-about-lock} function | |
762 | with your own version that makes the decision in another way. The code | |
763 | for its usual definition is in @file{userlock.el}. | |
764 | @end defun | |
765 | ||
766 | @node Information about Files | |
767 | @section Information about Files | |
768 | @cindex file, information about | |
769 | ||
770 | The functions described in this section all operate on strings that | |
771 | designate file names. With a few exceptions, all the functions have | |
772 | names that begin with the word @samp{file}. These functions all | |
773 | return information about actual files or directories, so their | |
774 | arguments must all exist as actual files or directories unless | |
775 | otherwise noted. | |
776 | ||
777 | @menu | |
778 | * Testing Accessibility:: Is a given file readable? Writable? | |
779 | * Kinds of Files:: Is it a directory? A symbolic link? | |
d24880de | 780 | * Truenames:: Eliminating symbolic links from a file name. |
b8d4c8d0 GM |
781 | * File Attributes:: How large is it? Any other names? Etc. |
782 | * Locating Files:: How to find a file in standard places. | |
783 | @end menu | |
784 | ||
785 | @node Testing Accessibility | |
786 | @comment node-name, next, previous, up | |
787 | @subsection Testing Accessibility | |
788 | @cindex accessibility of a file | |
789 | @cindex file accessibility | |
790 | ||
791 | These functions test for permission to access a file in specific | |
792 | ways. Unless explicitly stated otherwise, they recursively follow | |
793 | symbolic links for their file name arguments, at all levels (at the | |
794 | level of the file itself and at all levels of parent directories). | |
795 | ||
796 | @defun file-exists-p filename | |
797 | This function returns @code{t} if a file named @var{filename} appears | |
798 | to exist. This does not mean you can necessarily read the file, only | |
799 | that you can find out its attributes. (On Unix and GNU/Linux, this is | |
800 | true if the file exists and you have execute permission on the | |
a59225b1 | 801 | containing directories, regardless of the permissions of the file |
b8d4c8d0 GM |
802 | itself.) |
803 | ||
804 | If the file does not exist, or if fascist access control policies | |
805 | prevent you from finding the attributes of the file, this function | |
806 | returns @code{nil}. | |
807 | ||
808 | Directories are files, so @code{file-exists-p} returns @code{t} when | |
809 | given a directory name. However, symbolic links are treated | |
810 | specially; @code{file-exists-p} returns @code{t} for a symbolic link | |
811 | name only if the target file exists. | |
812 | @end defun | |
813 | ||
814 | @defun file-readable-p filename | |
815 | This function returns @code{t} if a file named @var{filename} exists | |
816 | and you can read it. It returns @code{nil} otherwise. | |
817 | ||
818 | @example | |
819 | @group | |
820 | (file-readable-p "files.texi") | |
821 | @result{} t | |
822 | @end group | |
823 | @group | |
824 | (file-exists-p "/usr/spool/mqueue") | |
825 | @result{} t | |
826 | @end group | |
827 | @group | |
828 | (file-readable-p "/usr/spool/mqueue") | |
829 | @result{} nil | |
830 | @end group | |
831 | @end example | |
832 | @end defun | |
833 | ||
834 | @c Emacs 19 feature | |
835 | @defun file-executable-p filename | |
836 | This function returns @code{t} if a file named @var{filename} exists and | |
837 | you can execute it. It returns @code{nil} otherwise. On Unix and | |
838 | GNU/Linux, if the file is a directory, execute permission means you can | |
839 | check the existence and attributes of files inside the directory, and | |
840 | open those files if their modes permit. | |
841 | @end defun | |
842 | ||
843 | @defun file-writable-p filename | |
844 | This function returns @code{t} if the file @var{filename} can be written | |
845 | or created by you, and @code{nil} otherwise. A file is writable if the | |
846 | file exists and you can write it. It is creatable if it does not exist, | |
847 | but the specified directory does exist and you can write in that | |
848 | directory. | |
849 | ||
850 | In the third example below, @file{foo} is not writable because the | |
851 | parent directory does not exist, even though the user could create such | |
852 | a directory. | |
853 | ||
854 | @example | |
855 | @group | |
856 | (file-writable-p "~/foo") | |
857 | @result{} t | |
858 | @end group | |
859 | @group | |
860 | (file-writable-p "/foo") | |
861 | @result{} nil | |
862 | @end group | |
863 | @group | |
864 | (file-writable-p "~/no-such-dir/foo") | |
865 | @result{} nil | |
866 | @end group | |
867 | @end example | |
868 | @end defun | |
869 | ||
870 | @c Emacs 19 feature | |
871 | @defun file-accessible-directory-p dirname | |
872 | This function returns @code{t} if you have permission to open existing | |
873 | files in the directory whose name as a file is @var{dirname}; | |
874 | otherwise (or if there is no such directory), it returns @code{nil}. | |
875 | The value of @var{dirname} may be either a directory name (such as | |
876 | @file{/foo/}) or the file name of a file which is a directory | |
877 | (such as @file{/foo}, without the final slash). | |
878 | ||
879 | Example: after the following, | |
880 | ||
881 | @example | |
882 | (file-accessible-directory-p "/foo") | |
883 | @result{} nil | |
884 | @end example | |
885 | ||
886 | @noindent | |
887 | we can deduce that any attempt to read a file in @file{/foo/} will | |
888 | give an error. | |
889 | @end defun | |
890 | ||
891 | @defun access-file filename string | |
892 | This function opens file @var{filename} for reading, then closes it and | |
893 | returns @code{nil}. However, if the open fails, it signals an error | |
894 | using @var{string} as the error message text. | |
895 | @end defun | |
896 | ||
897 | @defun file-ownership-preserved-p filename | |
898 | This function returns @code{t} if deleting the file @var{filename} and | |
899 | then creating it anew would keep the file's owner unchanged. It also | |
900 | returns @code{t} for nonexistent files. | |
901 | ||
902 | If @var{filename} is a symbolic link, then, unlike the other functions | |
903 | discussed here, @code{file-ownership-preserved-p} does @emph{not} | |
904 | replace @var{filename} with its target. However, it does recursively | |
905 | follow symbolic links at all levels of parent directories. | |
906 | @end defun | |
907 | ||
908 | @defun file-newer-than-file-p filename1 filename2 | |
909 | @cindex file age | |
910 | @cindex file modification time | |
911 | This function returns @code{t} if the file @var{filename1} is | |
912 | newer than file @var{filename2}. If @var{filename1} does not | |
913 | exist, it returns @code{nil}. If @var{filename1} does exist, but | |
914 | @var{filename2} does not, it returns @code{t}. | |
915 | ||
916 | In the following example, assume that the file @file{aug-19} was written | |
917 | on the 19th, @file{aug-20} was written on the 20th, and the file | |
918 | @file{no-file} doesn't exist at all. | |
919 | ||
920 | @example | |
921 | @group | |
922 | (file-newer-than-file-p "aug-19" "aug-20") | |
923 | @result{} nil | |
924 | @end group | |
925 | @group | |
926 | (file-newer-than-file-p "aug-20" "aug-19") | |
927 | @result{} t | |
928 | @end group | |
929 | @group | |
930 | (file-newer-than-file-p "aug-19" "no-file") | |
931 | @result{} t | |
932 | @end group | |
933 | @group | |
934 | (file-newer-than-file-p "no-file" "aug-19") | |
935 | @result{} nil | |
936 | @end group | |
937 | @end example | |
938 | ||
939 | You can use @code{file-attributes} to get a file's last modification | |
940 | time as a list of two numbers. @xref{File Attributes}. | |
941 | @end defun | |
942 | ||
943 | @node Kinds of Files | |
944 | @comment node-name, next, previous, up | |
945 | @subsection Distinguishing Kinds of Files | |
946 | ||
947 | This section describes how to distinguish various kinds of files, such | |
948 | as directories, symbolic links, and ordinary files. | |
949 | ||
950 | @defun file-symlink-p filename | |
951 | @cindex file symbolic links | |
952 | If the file @var{filename} is a symbolic link, the | |
953 | @code{file-symlink-p} function returns the (non-recursive) link target | |
954 | as a string. (Determining the file name that the link points to from | |
955 | the target is nontrivial.) First, this function recursively follows | |
956 | symbolic links at all levels of parent directories. | |
957 | ||
958 | If the file @var{filename} is not a symbolic link (or there is no such file), | |
959 | @code{file-symlink-p} returns @code{nil}. | |
960 | ||
961 | @example | |
962 | @group | |
963 | (file-symlink-p "foo") | |
964 | @result{} nil | |
965 | @end group | |
966 | @group | |
967 | (file-symlink-p "sym-link") | |
968 | @result{} "foo" | |
969 | @end group | |
970 | @group | |
971 | (file-symlink-p "sym-link2") | |
972 | @result{} "sym-link" | |
973 | @end group | |
974 | @group | |
975 | (file-symlink-p "/bin") | |
976 | @result{} "/pub/bin" | |
977 | @end group | |
978 | @end example | |
979 | ||
980 | @c !!! file-symlink-p: should show output of ls -l for comparison | |
981 | @end defun | |
982 | ||
983 | The next two functions recursively follow symbolic links at | |
984 | all levels for @var{filename}. | |
985 | ||
986 | @defun file-directory-p filename | |
987 | This function returns @code{t} if @var{filename} is the name of an | |
988 | existing directory, @code{nil} otherwise. | |
989 | ||
990 | @example | |
991 | @group | |
992 | (file-directory-p "~rms") | |
993 | @result{} t | |
994 | @end group | |
995 | @group | |
996 | (file-directory-p "~rms/lewis/files.texi") | |
997 | @result{} nil | |
998 | @end group | |
999 | @group | |
1000 | (file-directory-p "~rms/lewis/no-such-file") | |
1001 | @result{} nil | |
1002 | @end group | |
1003 | @group | |
1004 | (file-directory-p "$HOME") | |
1005 | @result{} nil | |
1006 | @end group | |
1007 | @group | |
1008 | (file-directory-p | |
1009 | (substitute-in-file-name "$HOME")) | |
1010 | @result{} t | |
1011 | @end group | |
1012 | @end example | |
1013 | @end defun | |
1014 | ||
1015 | @defun file-regular-p filename | |
1016 | This function returns @code{t} if the file @var{filename} exists and is | |
1017 | a regular file (not a directory, named pipe, terminal, or | |
1018 | other I/O device). | |
1019 | @end defun | |
1020 | ||
23453255 | 1021 | @defun files-equal-p file1 file2 |
9a4888c0 CY |
1022 | This function returns @code{t} if the files @var{file1} and |
1023 | @var{file2} name the same file. Two ordinary files are considered to | |
fa9a0855 | 1024 | be the same if the function @code{file-attributes} (@pxref{File |
9a4888c0 | 1025 | Attributes}) returns @code{equal} values for them. |
23453255 | 1026 | @end defun |
1027 | ||
1028 | @defun file-subdir-of-p dir1 dir2 | |
9a4888c0 CY |
1029 | This function returns @code{t} if directory @var{dir1} is a |
1030 | subdirectory of @var{dir2}, or if @var{dir1} and @var{dir2} are the | |
1031 | same directory. It compares the @code{file-truename} values of the | |
1032 | two directories (@pxref{Truenames}). If either @var{dir1} or | |
1033 | @var{dir2} do not name existing directories, the return value is | |
1034 | @code{nil}. | |
23453255 | 1035 | @end defun |
1036 | ||
b8d4c8d0 GM |
1037 | @node Truenames |
1038 | @subsection Truenames | |
1039 | @cindex truename (of file) | |
1040 | ||
b8d4c8d0 GM |
1041 | The @dfn{truename} of a file is the name that you get by following |
1042 | symbolic links at all levels until none remain, then simplifying away | |
1043 | @samp{.}@: and @samp{..}@: appearing as name components. This results | |
1044 | in a sort of canonical name for the file. A file does not always have a | |
1045 | unique truename; the number of distinct truenames a file has is equal to | |
1046 | the number of hard links to the file. However, truenames are useful | |
1047 | because they eliminate symbolic links as a cause of name variation. | |
1048 | ||
1049 | @defun file-truename filename | |
a59225b1 CY |
1050 | This function returns the truename of the file @var{filename}. If the |
1051 | argument is not an absolute file name, this function first expands it | |
1052 | against @code{default-directory}. | |
b8d4c8d0 GM |
1053 | |
1054 | This function does not expand environment variables. Only | |
1055 | @code{substitute-in-file-name} does that. @xref{Definition of | |
1056 | substitute-in-file-name}. | |
1057 | ||
1058 | If you may need to follow symbolic links preceding @samp{..}@: | |
1059 | appearing as a name component, you should make sure to call | |
1060 | @code{file-truename} without prior direct or indirect calls to | |
1061 | @code{expand-file-name}, as otherwise the file name component | |
1062 | immediately preceding @samp{..} will be ``simplified away'' before | |
1063 | @code{file-truename} is called. To eliminate the need for a call to | |
1064 | @code{expand-file-name}, @code{file-truename} handles @samp{~} in the | |
1065 | same way that @code{expand-file-name} does. @xref{File Name | |
1066 | Expansion,, Functions that Expand Filenames}. | |
1067 | @end defun | |
1068 | ||
1069 | @defun file-chase-links filename &optional limit | |
1070 | This function follows symbolic links, starting with @var{filename}, | |
1071 | until it finds a file name which is not the name of a symbolic link. | |
1072 | Then it returns that file name. This function does @emph{not} follow | |
1073 | symbolic links at the level of parent directories. | |
1074 | ||
1075 | If you specify a number for @var{limit}, then after chasing through | |
1076 | that many links, the function just returns what it has even if that is | |
1077 | still a symbolic link. | |
1078 | @end defun | |
1079 | ||
1080 | To illustrate the difference between @code{file-chase-links} and | |
1081 | @code{file-truename}, suppose that @file{/usr/foo} is a symbolic link to | |
1082 | the directory @file{/home/foo}, and @file{/home/foo/hello} is an | |
1083 | ordinary file (or at least, not a symbolic link) or nonexistent. Then | |
1084 | we would have: | |
1085 | ||
1086 | @example | |
1087 | (file-chase-links "/usr/foo/hello") | |
1088 | ;; @r{This does not follow the links in the parent directories.} | |
1089 | @result{} "/usr/foo/hello" | |
1090 | (file-truename "/usr/foo/hello") | |
1091 | ;; @r{Assuming that @file{/home} is not a symbolic link.} | |
1092 | @result{} "/home/foo/hello" | |
1093 | @end example | |
1094 | ||
1095 | @xref{Buffer File Name}, for related information. | |
1096 | ||
1097 | @node File Attributes | |
1098 | @comment node-name, next, previous, up | |
1099 | @subsection Other Information about Files | |
1100 | ||
a59225b1 CY |
1101 | This section describes the functions for getting detailed |
1102 | information about a file, other than its contents. This information | |
1103 | includes the mode bits that control access permissions, the owner and | |
1104 | group numbers, the number of names, the inode number, the size, and | |
1105 | the times of access and modification. | |
b8d4c8d0 GM |
1106 | |
1107 | @defun file-modes filename | |
a59225b1 CY |
1108 | @cindex file permissions |
1109 | @cindex permissions, file | |
b8d4c8d0 | 1110 | @cindex file attributes |
a59225b1 CY |
1111 | @cindex file modes |
1112 | This function returns the @dfn{mode bits} describing the @dfn{file | |
1113 | permissions} of @var{filename}, as an integer. It recursively follows | |
1114 | symbolic links in @var{filename} at all levels. If @var{filename} | |
1115 | does not exist, the return value is @code{nil}. | |
1116 | ||
1117 | @xref{File Permissions,,, coreutils, The @sc{gnu} @code{Coreutils} | |
1118 | Manual}, for a description of mode bits. If the low-order bit is 1, | |
1119 | then the file is executable by all users, if the second-lowest-order | |
1120 | bit is 1, then the file is writable by all users, etc. The highest | |
1121 | value returnable is 4095 (7777 octal), meaning that everyone has read, | |
1122 | write, and execute permission, that the @acronym{SUID} bit is set for | |
1123 | both others and group, and that the sticky bit is set. | |
b8d4c8d0 GM |
1124 | |
1125 | @example | |
1126 | @group | |
1127 | (file-modes "~/junk/diffs") | |
1128 | @result{} 492 ; @r{Decimal integer.} | |
1129 | @end group | |
1130 | @group | |
1131 | (format "%o" 492) | |
1132 | @result{} "754" ; @r{Convert to octal.} | |
1133 | @end group | |
1134 | ||
1135 | @group | |
8d80ef01 | 1136 | (set-file-modes "~/junk/diffs" #o666) |
b8d4c8d0 GM |
1137 | @result{} nil |
1138 | @end group | |
1139 | ||
b8d4c8d0 GM |
1140 | @group |
1141 | % ls -l diffs | |
1142 | -rw-rw-rw- 1 lewis 0 3063 Oct 30 16:00 diffs | |
1143 | @end group | |
1144 | @end example | |
a59225b1 CY |
1145 | |
1146 | @xref{Changing Files}, for functions that change file permissions, | |
1147 | such as @code{set-file-modes}. | |
fa74b241 CY |
1148 | |
1149 | @cindex MS-DOS and file modes | |
1150 | @cindex file modes and MS-DOS | |
1151 | @strong{MS-DOS note:} On MS-DOS, there is no such thing as an | |
1152 | ``executable'' file mode bit. So @code{file-modes} considers a file | |
1153 | executable if its name ends in one of the standard executable | |
1154 | extensions, such as @file{.com}, @file{.bat}, @file{.exe}, and some | |
1155 | others. Files that begin with the Unix-standard @samp{#!} signature, | |
1156 | such as shell and Perl scripts, are also considered executable. | |
1157 | Directories are also reported as executable, for compatibility with | |
1158 | Unix. These conventions are also followed by @code{file-attributes}, | |
1159 | below. | |
b8d4c8d0 GM |
1160 | @end defun |
1161 | ||
a59225b1 CY |
1162 | If the @var{filename} argument to the next two functions is a |
1163 | symbolic link, then these function do @emph{not} replace it with its | |
1164 | target. However, they both recursively follow symbolic links at all | |
1165 | levels of parent directories. | |
b8d4c8d0 GM |
1166 | |
1167 | @defun file-nlinks filename | |
1168 | This functions returns the number of names (i.e., hard links) that | |
1169 | file @var{filename} has. If the file does not exist, then this function | |
1170 | returns @code{nil}. Note that symbolic links have no effect on this | |
1171 | function, because they are not considered to be names of the files they | |
1172 | link to. | |
1173 | ||
1174 | @example | |
1175 | @group | |
1176 | % ls -l foo* | |
1177 | -rw-rw-rw- 2 rms 4 Aug 19 01:27 foo | |
1178 | -rw-rw-rw- 2 rms 4 Aug 19 01:27 foo1 | |
1179 | @end group | |
1180 | ||
1181 | @group | |
1182 | (file-nlinks "foo") | |
1183 | @result{} 2 | |
1184 | @end group | |
1185 | @group | |
1186 | (file-nlinks "doesnt-exist") | |
1187 | @result{} nil | |
1188 | @end group | |
1189 | @end example | |
1190 | @end defun | |
1191 | ||
1192 | @defun file-attributes filename &optional id-format | |
1193 | @anchor{Definition of file-attributes} | |
1194 | This function returns a list of attributes of file @var{filename}. If | |
1195 | the specified file cannot be opened, it returns @code{nil}. | |
1196 | The optional parameter @var{id-format} specifies the preferred format | |
1197 | of attributes @acronym{UID} and @acronym{GID} (see below)---the | |
1198 | valid values are @code{'string} and @code{'integer}. The latter is | |
1199 | the default, but we plan to change that, so you should specify a | |
1200 | non-@code{nil} value for @var{id-format} if you use the returned | |
1201 | @acronym{UID} or @acronym{GID}. | |
1202 | ||
1203 | The elements of the list, in order, are: | |
1204 | ||
1205 | @enumerate 0 | |
1206 | @item | |
1207 | @code{t} for a directory, a string for a symbolic link (the name | |
1208 | linked to), or @code{nil} for a text file. | |
1209 | ||
1210 | @c Wordy so as to prevent an overfull hbox. --rjc 15mar92 | |
1211 | @item | |
1212 | The number of names the file has. Alternate names, also known as hard | |
1213 | links, can be created by using the @code{add-name-to-file} function | |
1214 | (@pxref{Changing Files}). | |
1215 | ||
1216 | @item | |
1217 | The file's @acronym{UID}, normally as a string. However, if it does | |
1218 | not correspond to a named user, the value is an integer or a floating | |
1219 | point number. | |
1220 | ||
1221 | @item | |
1222 | The file's @acronym{GID}, likewise. | |
1223 | ||
1224 | @item | |
1225 | The time of last access, as a list of two integers. | |
1226 | The first integer has the high-order 16 bits of time, | |
1227 | the second has the low 16 bits. (This is similar to the | |
804543b5 EZ |
1228 | value of @code{current-time}; see @ref{Time of Day}.) Note that on |
1229 | some FAT-based filesystems, only the date of last access is recorded, | |
1230 | so this time will always hold the midnight of the day of last access. | |
b8d4c8d0 | 1231 | |
804543b5 | 1232 | @cindex modification time of file |
b8d4c8d0 GM |
1233 | @item |
1234 | The time of last modification as a list of two integers (as above). | |
804543b5 | 1235 | This is the last time when the file's contents were modified. |
b8d4c8d0 GM |
1236 | |
1237 | @item | |
1238 | The time of last status change as a list of two integers (as above). | |
804543b5 EZ |
1239 | This is the time of the last change to the file's access mode bits, |
1240 | its owner and group, and other information recorded in the filesystem | |
1241 | for the file, beyond the file's contents. | |
b8d4c8d0 GM |
1242 | |
1243 | @item | |
1244 | The size of the file in bytes. If the size is too large to fit in a | |
1245 | Lisp integer, this is a floating point number. | |
1246 | ||
1247 | @item | |
1248 | The file's modes, as a string of ten letters or dashes, | |
1249 | as in @samp{ls -l}. | |
1250 | ||
1251 | @item | |
1252 | @code{t} if the file's @acronym{GID} would change if file were | |
1253 | deleted and recreated; @code{nil} otherwise. | |
1254 | ||
1255 | @item | |
804543b5 EZ |
1256 | The file's inode number. If possible, this is an integer. If the |
1257 | inode number is too large to be represented as an integer in Emacs | |
001903b5 PE |
1258 | Lisp but dividing it by @math{2^16} yields a representable integer, |
1259 | then the value has the | |
804543b5 | 1260 | form @code{(@var{high} . @var{low})}, where @var{low} holds the low 16 |
001903b5 | 1261 | bits. If the inode number is too wide for even that, the value is of the form |
804543b5 | 1262 | @code{(@var{high} @var{middle} . @var{low})}, where @code{high} holds |
001903b5 | 1263 | the high bits, @var{middle} the middle 24 bits, and @var{low} the low |
804543b5 | 1264 | 16 bits. |
b8d4c8d0 GM |
1265 | |
1266 | @item | |
804543b5 EZ |
1267 | The filesystem number of the device that the file is on. Depending on |
1268 | the magnitude of the value, this can be either an integer or a cons | |
1269 | cell, in the same manner as the inode number. This element and the | |
1270 | file's inode number together give enough information to distinguish | |
1271 | any two files on the system---no two files can have the same values | |
1272 | for both of these numbers. | |
b8d4c8d0 GM |
1273 | @end enumerate |
1274 | ||
1275 | For example, here are the file attributes for @file{files.texi}: | |
1276 | ||
1277 | @example | |
1278 | @group | |
1279 | (file-attributes "files.texi" 'string) | |
1280 | @result{} (nil 1 "lh" "users" | |
804543b5 EZ |
1281 | (19145 42977) |
1282 | (19141 59576) | |
1283 | (18340 17300) | |
1284 | 122295 "-rw-rw-rw-" | |
1285 | nil (5888 2 . 43978) | |
1286 | (15479 . 46724)) | |
b8d4c8d0 GM |
1287 | @end group |
1288 | @end example | |
1289 | ||
1290 | @noindent | |
1291 | and here is how the result is interpreted: | |
1292 | ||
1293 | @table @code | |
1294 | @item nil | |
1295 | is neither a directory nor a symbolic link. | |
1296 | ||
1297 | @item 1 | |
1298 | has only one name (the name @file{files.texi} in the current default | |
1299 | directory). | |
1300 | ||
1301 | @item "lh" | |
1302 | is owned by the user with name "lh". | |
1303 | ||
1304 | @item "users" | |
1305 | is in the group with name "users". | |
1306 | ||
804543b5 EZ |
1307 | @item (19145 42977) |
1308 | was last accessed on Oct 5 2009, at 10:01:37. | |
b8d4c8d0 | 1309 | |
804543b5 EZ |
1310 | @item (19141 59576) |
1311 | last had its contents modified on Oct 2 2009, at 13:49:12. | |
b8d4c8d0 | 1312 | |
804543b5 EZ |
1313 | @item (18340 17300) |
1314 | last had its status changed on Feb 2 2008, at 12:19:00. | |
b8d4c8d0 | 1315 | |
804543b5 EZ |
1316 | @item 122295 |
1317 | is 122295 bytes long. (It may not contain 122295 characters, though, | |
1318 | if some of the bytes belong to multibyte sequences, and also if the | |
1319 | end-of-line format is CR-LF.) | |
b8d4c8d0 GM |
1320 | |
1321 | @item "-rw-rw-rw-" | |
1322 | has a mode of read and write access for the owner, group, and world. | |
1323 | ||
1324 | @item nil | |
1325 | would retain the same @acronym{GID} if it were recreated. | |
1326 | ||
804543b5 EZ |
1327 | @item (5888 2 . 43978) |
1328 | has an inode number of 6473924464520138. | |
1329 | ||
1330 | @item (15479 . 46724) | |
1331 | is on the file-system device whose number is 1014478468. | |
b8d4c8d0 GM |
1332 | @end table |
1333 | @end defun | |
1334 | ||
fa74b241 CY |
1335 | @cindex SELinux context |
1336 | SELinux is a Linux kernel feature which provides more sophisticated | |
1337 | file access controls than ordinary ``Unix-style'' file permissions. | |
1338 | If Emacs has been compiled with SELinux support on a system with | |
1339 | SELinux enabled, you can use the function @code{file-selinux-context} | |
1340 | to retrieve a file's SELinux security context. For the function | |
1341 | @code{set-file-selinux-context}, see @ref{Changing Files}. | |
1342 | ||
1343 | @defun file-selinux-context filename | |
1344 | This function returns the SELinux security context of the file | |
1345 | @var{filename}. This return value is a list of the form | |
1346 | @code{(@var{user} @var{role} @var{type} @var{range})}, whose elements | |
1347 | are the context's user, role, type, and range respectively, as Lisp | |
1348 | strings. See the SELinux documentation for details about what these | |
1349 | actually mean. | |
1350 | ||
1351 | If the file does not exist or is inaccessible, or if the system does | |
1352 | not support SELinux, or if Emacs was not compiled with SELinux | |
1353 | support, then the return value is @code{(nil nil nil nil)}. | |
1354 | @end defun | |
2aa8ea6e | 1355 | |
b8d4c8d0 GM |
1356 | @node Locating Files |
1357 | @subsection How to Locate Files in Standard Places | |
1358 | @cindex locate file in path | |
1359 | @cindex find file in path | |
1360 | ||
1361 | This section explains how to search for a file in a list of | |
a59225b1 CY |
1362 | directories (a @dfn{path}), or for an executable file in the standard |
1363 | list of executable file directories, or for an Emacs-specific user | |
1364 | configuration file. | |
b8d4c8d0 GM |
1365 | |
1366 | @defun locate-file filename path &optional suffixes predicate | |
1367 | This function searches for a file whose name is @var{filename} in a | |
1368 | list of directories given by @var{path}, trying the suffixes in | |
a59225b1 CY |
1369 | @var{suffixes}. If it finds such a file, it returns the file's |
1370 | absolute file name (@pxref{Relative File Names}); otherwise it returns | |
1371 | @code{nil}. | |
b8d4c8d0 GM |
1372 | |
1373 | The optional argument @var{suffixes} gives the list of file-name | |
1374 | suffixes to append to @var{filename} when searching. | |
1375 | @code{locate-file} tries each possible directory with each of these | |
1376 | suffixes. If @var{suffixes} is @code{nil}, or @code{("")}, then there | |
1377 | are no suffixes, and @var{filename} is used only as-is. Typical | |
1378 | values of @var{suffixes} are @code{exec-suffixes} (@pxref{Subprocess | |
a59225b1 CY |
1379 | Creation}), @code{load-suffixes}, @code{load-file-rep-suffixes} and |
1380 | the return value of the function @code{get-load-suffixes} (@pxref{Load | |
1381 | Suffixes}). | |
b8d4c8d0 GM |
1382 | |
1383 | Typical values for @var{path} are @code{exec-path} (@pxref{Subprocess | |
a59225b1 CY |
1384 | Creation}) when looking for executable programs, or @code{load-path} |
1385 | (@pxref{Library Search}) when looking for Lisp files. If | |
1386 | @var{filename} is absolute, @var{path} has no effect, but the suffixes | |
1387 | in @var{suffixes} are still tried. | |
1388 | ||
1389 | The optional argument @var{predicate}, if non-@code{nil}, specifies a | |
1390 | predicate function for testing whether a candidate file is suitable. | |
1391 | The predicate is passed the candidate file name as its single | |
1392 | argument. If @var{predicate} is @code{nil} or omitted, | |
1393 | @code{locate-file} uses @code{file-readable-p} as the predicate. | |
1394 | @xref{Kinds of Files}, for other useful predicates, e.g.@: | |
1395 | @code{file-executable-p} and @code{file-directory-p}. | |
b8d4c8d0 GM |
1396 | |
1397 | For compatibility, @var{predicate} can also be one of the symbols | |
1398 | @code{executable}, @code{readable}, @code{writable}, @code{exists}, or | |
1399 | a list of one or more of these symbols. | |
1400 | @end defun | |
1401 | ||
1402 | @defun executable-find program | |
1403 | This function searches for the executable file of the named | |
a59225b1 | 1404 | @var{program} and returns the absolute file name of the executable, |
b8d4c8d0 GM |
1405 | including its file-name extensions, if any. It returns @code{nil} if |
1406 | the file is not found. The functions searches in all the directories | |
a59225b1 CY |
1407 | in @code{exec-path}, and tries all the file-name extensions in |
1408 | @code{exec-suffixes} (@pxref{Subprocess Creation}). | |
1409 | @end defun | |
1410 | ||
1411 | @defun locate-user-emacs-file base-name &optional old-name | |
1412 | This function returns an absolute file name for an Emacs-specific | |
1413 | configuration or data file. The argument @file{base-name} should be a | |
1414 | relative file name. The return value is the absolute name of a file | |
1415 | in the directory specified by @code{user-emacs-directory}; if that | |
1416 | directory does not exist, this function creates it. | |
1417 | ||
1418 | If the optional argument @var{old-name} is non-@code{nil}, it | |
1419 | specifies a file in the user's home directory, | |
1420 | @file{~/@var{old-name}}. If such a file exists, the return value is | |
1421 | the absolute name of that file, instead of the file specified by | |
1422 | @var{base-name}. This argument is intended to be used by Emacs | |
1423 | packages to provide backward compatibility. For instance, prior to | |
1424 | the introduction of @code{user-emacs-directory}, the abbrev file was | |
1425 | located in @file{~/.abbrev_defs}, so the definition of | |
1426 | @code{abbrev-file-name} is | |
1427 | ||
1428 | @example | |
1429 | (defcustom abbrev-file-name | |
1430 | (locate-user-emacs-file "abbrev_defs" ".abbrev_defs") | |
1431 | "Default name of file from which to read abbrevs." | |
1432 | @dots{} | |
1433 | :type 'file) | |
1434 | @end example | |
b8d4c8d0 GM |
1435 | @end defun |
1436 | ||
1437 | @node Changing Files | |
1438 | @section Changing File Names and Attributes | |
1439 | @c @cindex renaming files Duplicates rename-file | |
1440 | @cindex copying files | |
1441 | @cindex deleting files | |
1442 | @cindex linking files | |
1443 | @cindex setting modes of files | |
1444 | ||
a59225b1 CY |
1445 | The functions in this section rename, copy, delete, link, and set |
1446 | the modes (permissions) of files. | |
b8d4c8d0 GM |
1447 | |
1448 | In the functions that have an argument @var{newname}, if a file by the | |
1449 | name of @var{newname} already exists, the actions taken depend on the | |
1450 | value of the argument @var{ok-if-already-exists}: | |
1451 | ||
1452 | @itemize @bullet | |
1453 | @item | |
1454 | Signal a @code{file-already-exists} error if | |
1455 | @var{ok-if-already-exists} is @code{nil}. | |
1456 | ||
1457 | @item | |
1458 | Request confirmation if @var{ok-if-already-exists} is a number. | |
1459 | ||
1460 | @item | |
1461 | Replace the old file without confirmation if @var{ok-if-already-exists} | |
1462 | is any other value. | |
1463 | @end itemize | |
1464 | ||
1465 | The next four commands all recursively follow symbolic links at all | |
1466 | levels of parent directories for their first argument, but, if that | |
1467 | argument is itself a symbolic link, then only @code{copy-file} | |
1468 | replaces it with its (recursive) target. | |
1469 | ||
1470 | @deffn Command add-name-to-file oldname newname &optional ok-if-already-exists | |
1471 | @cindex file with multiple names | |
1472 | @cindex file hard link | |
1473 | This function gives the file named @var{oldname} the additional name | |
1474 | @var{newname}. This means that @var{newname} becomes a new ``hard | |
1475 | link'' to @var{oldname}. | |
1476 | ||
1477 | In the first part of the following example, we list two files, | |
1478 | @file{foo} and @file{foo3}. | |
1479 | ||
1480 | @example | |
1481 | @group | |
1482 | % ls -li fo* | |
1483 | 81908 -rw-rw-rw- 1 rms 29 Aug 18 20:32 foo | |
1484 | 84302 -rw-rw-rw- 1 rms 24 Aug 18 20:31 foo3 | |
1485 | @end group | |
1486 | @end example | |
1487 | ||
1488 | Now we create a hard link, by calling @code{add-name-to-file}, then list | |
1489 | the files again. This shows two names for one file, @file{foo} and | |
1490 | @file{foo2}. | |
1491 | ||
1492 | @example | |
1493 | @group | |
1494 | (add-name-to-file "foo" "foo2") | |
1495 | @result{} nil | |
1496 | @end group | |
1497 | ||
1498 | @group | |
1499 | % ls -li fo* | |
1500 | 81908 -rw-rw-rw- 2 rms 29 Aug 18 20:32 foo | |
1501 | 81908 -rw-rw-rw- 2 rms 29 Aug 18 20:32 foo2 | |
1502 | 84302 -rw-rw-rw- 1 rms 24 Aug 18 20:31 foo3 | |
1503 | @end group | |
1504 | @end example | |
1505 | ||
1506 | Finally, we evaluate the following: | |
1507 | ||
1508 | @example | |
1509 | (add-name-to-file "foo" "foo3" t) | |
1510 | @end example | |
1511 | ||
1512 | @noindent | |
1513 | and list the files again. Now there are three names | |
1514 | for one file: @file{foo}, @file{foo2}, and @file{foo3}. The old | |
1515 | contents of @file{foo3} are lost. | |
1516 | ||
1517 | @example | |
1518 | @group | |
1519 | (add-name-to-file "foo1" "foo3") | |
1520 | @result{} nil | |
1521 | @end group | |
1522 | ||
1523 | @group | |
1524 | % ls -li fo* | |
1525 | 81908 -rw-rw-rw- 3 rms 29 Aug 18 20:32 foo | |
1526 | 81908 -rw-rw-rw- 3 rms 29 Aug 18 20:32 foo2 | |
1527 | 81908 -rw-rw-rw- 3 rms 29 Aug 18 20:32 foo3 | |
1528 | @end group | |
1529 | @end example | |
1530 | ||
1531 | This function is meaningless on operating systems where multiple names | |
1532 | for one file are not allowed. Some systems implement multiple names | |
1533 | by copying the file instead. | |
1534 | ||
1535 | See also @code{file-nlinks} in @ref{File Attributes}. | |
1536 | @end deffn | |
1537 | ||
1538 | @deffn Command rename-file filename newname &optional ok-if-already-exists | |
1539 | This command renames the file @var{filename} as @var{newname}. | |
1540 | ||
1541 | If @var{filename} has additional names aside from @var{filename}, it | |
1542 | continues to have those names. In fact, adding the name @var{newname} | |
1543 | with @code{add-name-to-file} and then deleting @var{filename} has the | |
1544 | same effect as renaming, aside from momentary intermediate states. | |
1545 | @end deffn | |
1546 | ||
a49ca6b9 | 1547 | @deffn Command copy-file oldname newname &optional ok-if-exists time preserve-uid-gid preserve-selinux |
b8d4c8d0 GM |
1548 | This command copies the file @var{oldname} to @var{newname}. An |
1549 | error is signaled if @var{oldname} does not exist. If @var{newname} | |
1550 | names a directory, it copies @var{oldname} into that directory, | |
1551 | preserving its final name component. | |
1552 | ||
1553 | If @var{time} is non-@code{nil}, then this function gives the new file | |
1554 | the same last-modified time that the old one has. (This works on only | |
1555 | some operating systems.) If setting the time gets an error, | |
1556 | @code{copy-file} signals a @code{file-date-error} error. In an | |
1557 | interactive call, a prefix argument specifies a non-@code{nil} value | |
1558 | for @var{time}. | |
1559 | ||
1560 | This function copies the file modes, too. | |
1561 | ||
1562 | If argument @var{preserve-uid-gid} is @code{nil}, we let the operating | |
1563 | system decide the user and group ownership of the new file (this is | |
1564 | usually set to the user running Emacs). If @var{preserve-uid-gid} is | |
1565 | non-@code{nil}, we attempt to copy the user and group ownership of the | |
1566 | file. This works only on some operating systems, and only if you have | |
1567 | the correct permissions to do so. | |
a49ca6b9 | 1568 | |
fa74b241 CY |
1569 | If the optional argument @var{preserve-selinux} is non-@code{nil}, and |
1570 | Emacs has been compiled with SELinux support, this function attempts | |
1571 | to copy the file's SELinux context (@pxref{File Attributes}). | |
b8d4c8d0 GM |
1572 | @end deffn |
1573 | ||
1574 | @deffn Command make-symbolic-link filename newname &optional ok-if-exists | |
1575 | @pindex ln | |
1576 | @kindex file-already-exists | |
1577 | This command makes a symbolic link to @var{filename}, named | |
1578 | @var{newname}. This is like the shell command @samp{ln -s | |
1579 | @var{filename} @var{newname}}. | |
1580 | ||
1581 | This function is not available on systems that don't support symbolic | |
1582 | links. | |
1583 | @end deffn | |
1584 | ||
04e2ce72 CY |
1585 | @cindex trash |
1586 | @vindex delete-by-moving-to-trash | |
1587 | @deffn Command delete-file filename &optional trash | |
b8d4c8d0 | 1588 | @pindex rm |
04e2ce72 CY |
1589 | This command deletes the file @var{filename}. If the file has |
1590 | multiple names, it continues to exist under the other names. If | |
1591 | @var{filename} is a symbolic link, @code{delete-file} deletes only the | |
1592 | symbolic link and not its target (though it does follow symbolic links | |
1593 | at all levels of parent directories). | |
1594 | ||
1595 | A suitable kind of @code{file-error} error is signaled if the file | |
1596 | does not exist, or is not deletable. (On Unix and GNU/Linux, a file | |
1597 | is deletable if its directory is writable.) | |
1598 | ||
1599 | If the optional argument @var{trash} is non-@code{nil} and the | |
1600 | variable @code{delete-by-moving-to-trash} is non-@code{nil}, this | |
1601 | command moves the file into the system Trash instead of deleting it. | |
1602 | @xref{Misc File Ops,,Miscellaneous File Operations, emacs, The GNU | |
1603 | Emacs Manual}. When called interactively, @var{trash} is @code{t} if | |
1604 | no prefix argument is given, and @code{nil} otherwise. | |
b8d4c8d0 GM |
1605 | |
1606 | See also @code{delete-directory} in @ref{Create/Delete Dirs}. | |
1607 | @end deffn | |
1608 | ||
a59225b1 CY |
1609 | @cindex file permissions, setting |
1610 | @cindex permissions, file | |
1611 | @cindex file modes, setting | |
018a960d | 1612 | @deffn Command set-file-modes filename mode |
a59225b1 CY |
1613 | This function sets the @dfn{file mode} (or @dfn{file permissions}) of |
1614 | @var{filename} to @var{mode}. It recursively follows symbolic links | |
1615 | at all levels for @var{filename}. | |
1616 | ||
1617 | If called non-interactively, @var{mode} must be an integer. Only the | |
1618 | lowest 12 bits of the integer are used; on most systems, only the | |
1619 | lowest 9 bits are meaningful. You can use the Lisp construct for | |
1620 | octal numbers to enter @var{mode}. For example, | |
1621 | ||
1622 | @example | |
1623 | (set-file-modes #o644) | |
1624 | @end example | |
1625 | ||
1626 | @noindent | |
1627 | specifies that the file should be readable and writable for its owner, | |
1628 | readable for group members, and readable for all other users. | |
1629 | @xref{File Permissions,,, coreutils, The @sc{gnu} @code{Coreutils} | |
1630 | Manual}, for a description of mode bit specifications. | |
018a960d EZ |
1631 | |
1632 | Interactively, @var{mode} is read from the minibuffer using | |
a59225b1 CY |
1633 | @code{read-file-modes} (see below), which lets the user type in either |
1634 | an integer or a string representing the permissions symbolically. | |
018a960d | 1635 | |
a59225b1 CY |
1636 | @xref{File Attributes}, for the function @code{file-modes}, which |
1637 | returns the permissions of a file. | |
018a960d | 1638 | @end deffn |
b8d4c8d0 | 1639 | |
b8d4c8d0 GM |
1640 | @defun set-default-file-modes mode |
1641 | @cindex umask | |
a59225b1 CY |
1642 | This function sets the default file permissions for new files created |
1643 | by Emacs and its subprocesses. Every file created with Emacs | |
1644 | initially has these permissions, or a subset of them | |
1645 | (@code{write-region} will not grant execute permissions even if the | |
1646 | default file permissions allow execution). On Unix and GNU/Linux, the | |
1647 | default permissions are given by the bitwise complement of the | |
1648 | ``umask'' value. | |
1649 | ||
1650 | The argument @var{mode} should be an integer which specifies the | |
1651 | permissions, similar to @code{set-file-modes} above. Only the lowest | |
1652 | 9 bits are meaningful. | |
1653 | ||
1654 | The default file permissions have no effect when you save a modified | |
1655 | version of an existing file; saving a file preserves its existing | |
1656 | permissions. | |
b8d4c8d0 GM |
1657 | @end defun |
1658 | ||
1659 | @defun default-file-modes | |
a59225b1 | 1660 | This function returns the default file permissions, as an integer. |
b8d4c8d0 GM |
1661 | @end defun |
1662 | ||
018a960d | 1663 | @defun read-file-modes &optional prompt base-file |
a59225b1 CY |
1664 | This function reads a set of file mode bits from the minibuffer. The |
1665 | first optional argument @var{prompt} specifies a non-default prompt. | |
1666 | Second second optional argument @var{base-file} is the name of a file | |
1667 | on whose permissions to base the mode bits that this function returns, | |
1668 | if what the user types specifies mode bits relative to permissions of | |
1669 | an existing file. | |
018a960d EZ |
1670 | |
1671 | If user input represents an octal number, this function returns that | |
1672 | number. If it is a complete symbolic specification of mode bits, as | |
1673 | in @code{"u=rwx"}, the function converts it to the equivalent numeric | |
1674 | value using @code{file-modes-symbolic-to-number} and returns the | |
1675 | result. If the specification is relative, as in @code{"o+g"}, then | |
1586be92 | 1676 | the permissions on which the specification is based are taken from the |
018a960d EZ |
1677 | mode bits of @var{base-file}. If @var{base-file} is omitted or |
1678 | @code{nil}, the function uses @code{0} as the base mode bits. The | |
1679 | complete and relative specifications can be combined, as in | |
1680 | @code{"u+r,g+rx,o+r,g-w"}. @xref{File Permissions,,, coreutils, The | |
a59225b1 CY |
1681 | @sc{gnu} @code{Coreutils} Manual}, for a description of file mode |
1682 | specifications. | |
018a960d EZ |
1683 | @end defun |
1684 | ||
61331bf3 | 1685 | @defun file-modes-symbolic-to-number modes &optional base-modes |
a59225b1 CY |
1686 | This function converts a symbolic file mode specification in |
1687 | @var{modes} into the equivalent integer value. If the symbolic | |
018a960d EZ |
1688 | specification is based on an existing file, that file's mode bits are |
1689 | taken from the optional argument @var{base-modes}; if that argument is | |
a59225b1 | 1690 | omitted or @code{nil}, it defaults to 0, i.e.@: no access rights at |
4990219b | 1691 | all. |
61331bf3 | 1692 | @end defun |
018a960d | 1693 | |
b8d4c8d0 GM |
1694 | @defun set-file-times filename &optional time |
1695 | This function sets the access and modification times of @var{filename} | |
1696 | to @var{time}. The return value is @code{t} if the times are successfully | |
1697 | set, otherwise it is @code{nil}. @var{time} defaults to the current | |
1698 | time and must be in the format returned by @code{current-time} | |
1699 | (@pxref{Time of Day}). | |
1700 | @end defun | |
1701 | ||
fa74b241 CY |
1702 | @defun set-file-selinux-context filename context |
1703 | This function sets the SELinux security context of the file | |
1704 | @var{filename} to @var{context}. @xref{File Attributes}, for a brief | |
1705 | description of SELinux contexts. The @var{context} argument should be | |
1706 | a list @code{(@var{user} @var{role} @var{type} @var{range})}, like the | |
1707 | return value of @code{file-selinux-context}. The function does | |
1708 | nothing if SELinux is disabled, or if Emacs was compiled without | |
1709 | SELinux support. | |
1710 | @end defun | |
1711 | ||
b8d4c8d0 GM |
1712 | @node File Names |
1713 | @section File Names | |
1714 | @cindex file names | |
1715 | ||
1716 | Files are generally referred to by their names, in Emacs as elsewhere. | |
1717 | File names in Emacs are represented as strings. The functions that | |
1718 | operate on a file all expect a file name argument. | |
1719 | ||
1720 | In addition to operating on files themselves, Emacs Lisp programs | |
1721 | often need to operate on file names; i.e., to take them apart and to use | |
1722 | part of a name to construct related file names. This section describes | |
1723 | how to manipulate file names. | |
1724 | ||
1725 | The functions in this section do not actually access files, so they | |
1726 | can operate on file names that do not refer to an existing file or | |
1727 | directory. | |
1728 | ||
1729 | On MS-DOS and MS-Windows, these functions (like the function that | |
1730 | actually operate on files) accept MS-DOS or MS-Windows file-name syntax, | |
1731 | where backslashes separate the components, as well as Unix syntax; but | |
7c2fb837 DN |
1732 | they always return Unix syntax. This enables Lisp programs to specify |
1733 | file names in Unix syntax and work properly on all systems without | |
1734 | change. | |
b8d4c8d0 GM |
1735 | |
1736 | @menu | |
1737 | * File Name Components:: The directory part of a file name, and the rest. | |
1738 | * Relative File Names:: Some file names are relative to a current directory. | |
1739 | * Directory Names:: A directory's name as a directory | |
1740 | is different from its name as a file. | |
1741 | * File Name Expansion:: Converting relative file names to absolute ones. | |
1742 | * Unique File Names:: Generating names for temporary files. | |
1743 | * File Name Completion:: Finding the completions for a given file name. | |
1744 | * Standard File Names:: If your package uses a fixed file name, | |
1745 | how to handle various operating systems simply. | |
1746 | @end menu | |
1747 | ||
1748 | @node File Name Components | |
1749 | @subsection File Name Components | |
1750 | @cindex directory part (of file name) | |
1751 | @cindex nondirectory part (of file name) | |
1752 | @cindex version number (in file name) | |
1753 | ||
1754 | The operating system groups files into directories. To specify a | |
1755 | file, you must specify the directory and the file's name within that | |
1756 | directory. Therefore, Emacs considers a file name as having two main | |
1757 | parts: the @dfn{directory name} part, and the @dfn{nondirectory} part | |
1758 | (or @dfn{file name within the directory}). Either part may be empty. | |
1759 | Concatenating these two parts reproduces the original file name. | |
1760 | ||
1761 | On most systems, the directory part is everything up to and including | |
1762 | the last slash (backslash is also allowed in input on MS-DOS or | |
7c2fb837 | 1763 | MS-Windows); the nondirectory part is the rest. |
b8d4c8d0 GM |
1764 | |
1765 | For some purposes, the nondirectory part is further subdivided into | |
1766 | the name proper and the @dfn{version number}. On most systems, only | |
7c2fb837 | 1767 | backup files have version numbers in their names. |
b8d4c8d0 GM |
1768 | |
1769 | @defun file-name-directory filename | |
1770 | This function returns the directory part of @var{filename}, as a | |
1771 | directory name (@pxref{Directory Names}), or @code{nil} if | |
1772 | @var{filename} does not include a directory part. | |
1773 | ||
1774 | On GNU and Unix systems, a string returned by this function always | |
7c2fb837 | 1775 | ends in a slash. On MS-DOS it can also end in a colon. |
b8d4c8d0 GM |
1776 | |
1777 | @example | |
1778 | @group | |
1779 | (file-name-directory "lewis/foo") ; @r{Unix example} | |
1780 | @result{} "lewis/" | |
1781 | @end group | |
1782 | @group | |
1783 | (file-name-directory "foo") ; @r{Unix example} | |
1784 | @result{} nil | |
1785 | @end group | |
b8d4c8d0 GM |
1786 | @end example |
1787 | @end defun | |
1788 | ||
1789 | @defun file-name-nondirectory filename | |
1790 | This function returns the nondirectory part of @var{filename}. | |
1791 | ||
1792 | @example | |
1793 | @group | |
1794 | (file-name-nondirectory "lewis/foo") | |
1795 | @result{} "foo" | |
1796 | @end group | |
1797 | @group | |
1798 | (file-name-nondirectory "foo") | |
1799 | @result{} "foo" | |
1800 | @end group | |
1801 | @group | |
1802 | (file-name-nondirectory "lewis/") | |
1803 | @result{} "" | |
1804 | @end group | |
b8d4c8d0 GM |
1805 | @end example |
1806 | @end defun | |
1807 | ||
1808 | @defun file-name-sans-versions filename &optional keep-backup-version | |
1809 | This function returns @var{filename} with any file version numbers, | |
1810 | backup version numbers, or trailing tildes discarded. | |
1811 | ||
1812 | If @var{keep-backup-version} is non-@code{nil}, then true file version | |
1813 | numbers understood as such by the file system are discarded from the | |
1814 | return value, but backup version numbers are kept. | |
1815 | ||
1816 | @example | |
1817 | @group | |
1818 | (file-name-sans-versions "~rms/foo.~1~") | |
1819 | @result{} "~rms/foo" | |
1820 | @end group | |
1821 | @group | |
1822 | (file-name-sans-versions "~rms/foo~") | |
1823 | @result{} "~rms/foo" | |
1824 | @end group | |
1825 | @group | |
1826 | (file-name-sans-versions "~rms/foo") | |
1827 | @result{} "~rms/foo" | |
1828 | @end group | |
b8d4c8d0 GM |
1829 | @end example |
1830 | @end defun | |
1831 | ||
1832 | @defun file-name-extension filename &optional period | |
1833 | This function returns @var{filename}'s final ``extension,'' if any, | |
1834 | after applying @code{file-name-sans-versions} to remove any | |
1835 | version/backup part. The extension, in a file name, is the part that | |
4c565c5c LK |
1836 | follows the last @samp{.} in the last name component (minus any |
1837 | version/backup part). | |
b8d4c8d0 GM |
1838 | |
1839 | This function returns @code{nil} for extensionless file names such as | |
1840 | @file{foo}. It returns @code{""} for null extensions, as in | |
1841 | @file{foo.}. If the last component of a file name begins with a | |
1842 | @samp{.}, that @samp{.} doesn't count as the beginning of an | |
1843 | extension. Thus, @file{.emacs}'s ``extension'' is @code{nil}, not | |
1844 | @samp{.emacs}. | |
1845 | ||
1846 | If @var{period} is non-@code{nil}, then the returned value includes | |
1847 | the period that delimits the extension, and if @var{filename} has no | |
1848 | extension, the value is @code{""}. | |
1849 | @end defun | |
1850 | ||
1851 | @defun file-name-sans-extension filename | |
1852 | This function returns @var{filename} minus its extension, if any. The | |
1853 | version/backup part, if present, is only removed if the file has an | |
1854 | extension. For example, | |
1855 | ||
1856 | @example | |
1857 | (file-name-sans-extension "foo.lose.c") | |
1858 | @result{} "foo.lose" | |
1859 | (file-name-sans-extension "big.hack/foo") | |
1860 | @result{} "big.hack/foo" | |
1861 | (file-name-sans-extension "/my/home/.emacs") | |
1862 | @result{} "/my/home/.emacs" | |
1863 | (file-name-sans-extension "/my/home/.emacs.el") | |
1864 | @result{} "/my/home/.emacs" | |
1865 | (file-name-sans-extension "~/foo.el.~3~") | |
1866 | @result{} "~/foo" | |
1867 | (file-name-sans-extension "~/foo.~3~") | |
1868 | @result{} "~/foo.~3~" | |
1869 | @end example | |
1870 | ||
1871 | Note that the @samp{.~3~} in the two last examples is the backup part, | |
1872 | not an extension. | |
1873 | @end defun | |
1874 | ||
b8d4c8d0 GM |
1875 | |
1876 | @node Relative File Names | |
1877 | @subsection Absolute and Relative File Names | |
1878 | @cindex absolute file name | |
1879 | @cindex relative file name | |
1880 | ||
1881 | All the directories in the file system form a tree starting at the | |
1882 | root directory. A file name can specify all the directory names | |
1883 | starting from the root of the tree; then it is called an @dfn{absolute} | |
1884 | file name. Or it can specify the position of the file in the tree | |
1885 | relative to a default directory; then it is called a @dfn{relative} file | |
1886 | name. On Unix and GNU/Linux, an absolute file name starts with a slash | |
1887 | or a tilde (@samp{~}), and a relative one does not. On MS-DOS and | |
1888 | MS-Windows, an absolute file name starts with a slash or a backslash, or | |
1889 | with a drive specification @samp{@var{x}:/}, where @var{x} is the | |
7c2fb837 | 1890 | @dfn{drive letter}. |
b8d4c8d0 GM |
1891 | |
1892 | @defun file-name-absolute-p filename | |
1893 | This function returns @code{t} if file @var{filename} is an absolute | |
7c2fb837 | 1894 | file name, @code{nil} otherwise. |
b8d4c8d0 GM |
1895 | |
1896 | @example | |
1897 | @group | |
1898 | (file-name-absolute-p "~rms/foo") | |
1899 | @result{} t | |
1900 | @end group | |
1901 | @group | |
1902 | (file-name-absolute-p "rms/foo") | |
1903 | @result{} nil | |
1904 | @end group | |
1905 | @group | |
1906 | (file-name-absolute-p "/user/rms/foo") | |
1907 | @result{} t | |
1908 | @end group | |
1909 | @end example | |
1910 | @end defun | |
1911 | ||
1912 | Given a possibly relative file name, you can convert it to an | |
1913 | absolute name using @code{expand-file-name} (@pxref{File Name | |
1914 | Expansion}). This function converts absolute file names to relative | |
1915 | names: | |
1916 | ||
1917 | @defun file-relative-name filename &optional directory | |
1918 | This function tries to return a relative name that is equivalent to | |
1919 | @var{filename}, assuming the result will be interpreted relative to | |
1920 | @var{directory} (an absolute directory name or directory file name). | |
1921 | If @var{directory} is omitted or @code{nil}, it defaults to the | |
1922 | current buffer's default directory. | |
1923 | ||
1924 | On some operating systems, an absolute file name begins with a device | |
1925 | name. On such systems, @var{filename} has no relative equivalent based | |
1926 | on @var{directory} if they start with two different device names. In | |
1927 | this case, @code{file-relative-name} returns @var{filename} in absolute | |
1928 | form. | |
1929 | ||
1930 | @example | |
1931 | (file-relative-name "/foo/bar" "/foo/") | |
1932 | @result{} "bar" | |
1933 | (file-relative-name "/foo/bar" "/hack/") | |
1934 | @result{} "../foo/bar" | |
1935 | @end example | |
1936 | @end defun | |
1937 | ||
1938 | @node Directory Names | |
1939 | @comment node-name, next, previous, up | |
1940 | @subsection Directory Names | |
1941 | @cindex directory name | |
1942 | @cindex file name of directory | |
1943 | ||
1944 | A @dfn{directory name} is the name of a directory. A directory is | |
1945 | actually a kind of file, so it has a file name, which is related to | |
1946 | the directory name but not identical to it. (This is not quite the | |
1947 | same as the usual Unix terminology.) These two different names for | |
1948 | the same entity are related by a syntactic transformation. On GNU and | |
1949 | Unix systems, this is simple: a directory name ends in a slash, | |
7c2fb837 DN |
1950 | whereas the directory's name as a file lacks that slash. On MS-DOS |
1951 | the relationship is more complicated. | |
b8d4c8d0 GM |
1952 | |
1953 | The difference between a directory name and its name as a file is | |
1954 | subtle but crucial. When an Emacs variable or function argument is | |
1955 | described as being a directory name, a file name of a directory is not | |
1956 | acceptable. When @code{file-name-directory} returns a string, that is | |
1957 | always a directory name. | |
1958 | ||
1959 | The following two functions convert between directory names and file | |
1960 | names. They do nothing special with environment variable substitutions | |
1961 | such as @samp{$HOME}, and the constructs @samp{~}, @samp{.} and @samp{..}. | |
1962 | ||
1963 | @defun file-name-as-directory filename | |
1964 | This function returns a string representing @var{filename} in a form | |
1965 | that the operating system will interpret as the name of a directory. On | |
1966 | most systems, this means appending a slash to the string (if it does not | |
7c2fb837 | 1967 | already end in one). |
b8d4c8d0 GM |
1968 | |
1969 | @example | |
1970 | @group | |
1971 | (file-name-as-directory "~rms/lewis") | |
1972 | @result{} "~rms/lewis/" | |
1973 | @end group | |
1974 | @end example | |
1975 | @end defun | |
1976 | ||
1977 | @defun directory-file-name dirname | |
1978 | This function returns a string representing @var{dirname} in a form that | |
1979 | the operating system will interpret as the name of a file. On most | |
1980 | systems, this means removing the final slash (or backslash) from the | |
7c2fb837 | 1981 | string. |
b8d4c8d0 GM |
1982 | |
1983 | @example | |
1984 | @group | |
1985 | (directory-file-name "~lewis/") | |
1986 | @result{} "~lewis" | |
1987 | @end group | |
1988 | @end example | |
1989 | @end defun | |
1990 | ||
1991 | Given a directory name, you can combine it with a relative file name | |
1992 | using @code{concat}: | |
1993 | ||
1994 | @example | |
1995 | (concat @var{dirname} @var{relfile}) | |
1996 | @end example | |
1997 | ||
1998 | @noindent | |
1999 | Be sure to verify that the file name is relative before doing that. | |
2000 | If you use an absolute file name, the results could be syntactically | |
2001 | invalid or refer to the wrong file. | |
2002 | ||
2003 | If you want to use a directory file name in making such a | |
2004 | combination, you must first convert it to a directory name using | |
2005 | @code{file-name-as-directory}: | |
2006 | ||
2007 | @example | |
2008 | (concat (file-name-as-directory @var{dirfile}) @var{relfile}) | |
2009 | @end example | |
2010 | ||
2011 | @noindent | |
2012 | Don't try concatenating a slash by hand, as in | |
2013 | ||
2014 | @example | |
2015 | ;;; @r{Wrong!} | |
2016 | (concat @var{dirfile} "/" @var{relfile}) | |
2017 | @end example | |
2018 | ||
2019 | @noindent | |
2020 | because this is not portable. Always use | |
2021 | @code{file-name-as-directory}. | |
2022 | ||
b8d4c8d0 GM |
2023 | To convert a directory name to its abbreviation, use this |
2024 | function: | |
2025 | ||
2026 | @defun abbreviate-file-name filename | |
2027 | @anchor{Definition of abbreviate-file-name} | |
362b9d48 GM |
2028 | This function returns an abbreviated form of @var{filename}. It |
2029 | applies the abbreviations specified in @code{directory-abbrev-alist} | |
2030 | (@pxref{File Aliases,,File Aliases, emacs, The GNU Emacs Manual}), | |
2031 | then substitutes @samp{~} for the user's home directory if the | |
2032 | argument names a file in the home directory or one of its | |
2033 | subdirectories. If the home directory is a root directory, it is not | |
2034 | replaced with @samp{~}, because this does not make the result shorter | |
2035 | on many systems. | |
2036 | ||
2037 | You can use this function for directory names and for file names, | |
2038 | because it recognizes abbreviations even as part of the name. | |
b8d4c8d0 GM |
2039 | @end defun |
2040 | ||
2041 | @node File Name Expansion | |
2042 | @subsection Functions that Expand Filenames | |
2043 | @cindex expansion of file names | |
2044 | ||
2045 | @dfn{Expansion} of a file name means converting a relative file name | |
2046 | to an absolute one. Since this is done relative to a default directory, | |
2047 | you must specify the default directory name as well as the file name to | |
2048 | be expanded. Expansion also simplifies file names by eliminating | |
2049 | redundancies such as @file{./} and @file{@var{name}/../}. | |
2050 | ||
2051 | @defun expand-file-name filename &optional directory | |
2052 | This function converts @var{filename} to an absolute file name. If | |
2053 | @var{directory} is supplied, it is the default directory to start with | |
2054 | if @var{filename} is relative. (The value of @var{directory} should | |
2055 | itself be an absolute directory name or directory file name; it may | |
2056 | start with @samp{~}.) Otherwise, the current buffer's value of | |
2057 | @code{default-directory} is used. For example: | |
2058 | ||
2059 | @example | |
2060 | @group | |
2061 | (expand-file-name "foo") | |
2062 | @result{} "/xcssun/users/rms/lewis/foo" | |
2063 | @end group | |
2064 | @group | |
2065 | (expand-file-name "../foo") | |
2066 | @result{} "/xcssun/users/rms/foo" | |
2067 | @end group | |
2068 | @group | |
2069 | (expand-file-name "foo" "/usr/spool/") | |
2070 | @result{} "/usr/spool/foo" | |
2071 | @end group | |
2072 | @group | |
2073 | (expand-file-name "$HOME/foo") | |
2074 | @result{} "/xcssun/users/rms/lewis/$HOME/foo" | |
2075 | @end group | |
2076 | @end example | |
2077 | ||
2078 | If the part of the combined file name before the first slash is | |
2079 | @samp{~}, it expands to the value of the @env{HOME} environment | |
2080 | variable (usually your home directory). If the part before the first | |
2081 | slash is @samp{~@var{user}} and if @var{user} is a valid login name, | |
2082 | it expands to @var{user}'s home directory. | |
2083 | ||
2084 | Filenames containing @samp{.} or @samp{..} are simplified to their | |
2085 | canonical form: | |
2086 | ||
2087 | @example | |
2088 | @group | |
2089 | (expand-file-name "bar/../foo") | |
2090 | @result{} "/xcssun/users/rms/lewis/foo" | |
2091 | @end group | |
2092 | @end example | |
2093 | ||
2094 | In some cases, a leading @samp{..} component can remain in the output: | |
2095 | ||
2096 | @example | |
2097 | @group | |
2098 | (expand-file-name "../home" "/") | |
2099 | @result{} "/../home" | |
2100 | @end group | |
2101 | @end example | |
2102 | ||
2103 | @noindent | |
2104 | This is for the sake of filesystems that have the concept of a | |
2105 | ``superroot'' above the root directory @file{/}. On other filesystems, | |
2106 | @file{/../} is interpreted exactly the same as @file{/}. | |
2107 | ||
2108 | Note that @code{expand-file-name} does @emph{not} expand environment | |
2109 | variables; only @code{substitute-in-file-name} does that. | |
2110 | ||
2111 | Note also that @code{expand-file-name} does not follow symbolic links | |
2112 | at any level. This results in a difference between the way | |
2113 | @code{file-truename} and @code{expand-file-name} treat @samp{..}. | |
2114 | Assuming that @samp{/tmp/bar} is a symbolic link to the directory | |
2115 | @samp{/tmp/foo/bar} we get: | |
2116 | ||
2117 | @example | |
2118 | @group | |
2119 | (file-truename "/tmp/bar/../myfile") | |
2120 | @result{} "/tmp/foo/myfile" | |
2121 | @end group | |
2122 | @group | |
2123 | (expand-file-name "/tmp/bar/../myfile") | |
2124 | @result{} "/tmp/myfile" | |
2125 | @end group | |
2126 | @end example | |
2127 | ||
2128 | If you may need to follow symbolic links preceding @samp{..}, you | |
2129 | should make sure to call @code{file-truename} without prior direct or | |
2130 | indirect calls to @code{expand-file-name}. @xref{Truenames}. | |
2131 | @end defun | |
2132 | ||
2133 | @defvar default-directory | |
2134 | The value of this buffer-local variable is the default directory for the | |
2135 | current buffer. It should be an absolute directory name; it may start | |
2136 | with @samp{~}. This variable is buffer-local in every buffer. | |
2137 | ||
2138 | @code{expand-file-name} uses the default directory when its second | |
2139 | argument is @code{nil}. | |
2140 | ||
7c2fb837 | 2141 | The value is always a string ending with a slash. |
b8d4c8d0 GM |
2142 | |
2143 | @example | |
2144 | @group | |
2145 | default-directory | |
2146 | @result{} "/user/lewis/manual/" | |
2147 | @end group | |
2148 | @end example | |
2149 | @end defvar | |
2150 | ||
2151 | @defun substitute-in-file-name filename | |
2152 | @anchor{Definition of substitute-in-file-name} | |
2153 | This function replaces environment variable references in | |
2154 | @var{filename} with the environment variable values. Following | |
2155 | standard Unix shell syntax, @samp{$} is the prefix to substitute an | |
2156 | environment variable value. If the input contains @samp{$$}, that is | |
2157 | converted to @samp{$}; this gives the user a way to ``quote'' a | |
2158 | @samp{$}. | |
2159 | ||
2160 | The environment variable name is the series of alphanumeric characters | |
2161 | (including underscores) that follow the @samp{$}. If the character following | |
2162 | the @samp{$} is a @samp{@{}, then the variable name is everything up to the | |
2163 | matching @samp{@}}. | |
2164 | ||
2165 | Calling @code{substitute-in-file-name} on output produced by | |
2166 | @code{substitute-in-file-name} tends to give incorrect results. For | |
2167 | instance, use of @samp{$$} to quote a single @samp{$} won't work | |
2168 | properly, and @samp{$} in an environment variable's value could lead | |
2169 | to repeated substitution. Therefore, programs that call this function | |
2170 | and put the output where it will be passed to this function need to | |
2171 | double all @samp{$} characters to prevent subsequent incorrect | |
2172 | results. | |
2173 | ||
2174 | @c Wordy to avoid overfull hbox. --rjc 15mar92 | |
2175 | Here we assume that the environment variable @code{HOME}, which holds | |
2176 | the user's home directory name, has value @samp{/xcssun/users/rms}. | |
2177 | ||
2178 | @example | |
2179 | @group | |
2180 | (substitute-in-file-name "$HOME/foo") | |
2181 | @result{} "/xcssun/users/rms/foo" | |
2182 | @end group | |
2183 | @end example | |
2184 | ||
2185 | After substitution, if a @samp{~} or a @samp{/} appears immediately | |
2186 | after another @samp{/}, the function discards everything before it (up | |
2187 | through the immediately preceding @samp{/}). | |
2188 | ||
2189 | @example | |
2190 | @group | |
2191 | (substitute-in-file-name "bar/~/foo") | |
2192 | @result{} "~/foo" | |
2193 | @end group | |
2194 | @group | |
2195 | (substitute-in-file-name "/usr/local/$HOME/foo") | |
2196 | @result{} "/xcssun/users/rms/foo" | |
2197 | ;; @r{@file{/usr/local/} has been discarded.} | |
2198 | @end group | |
2199 | @end example | |
2200 | ||
b8d4c8d0 GM |
2201 | @end defun |
2202 | ||
2203 | @node Unique File Names | |
2204 | @subsection Generating Unique File Names | |
2205 | ||
2206 | Some programs need to write temporary files. Here is the usual way to | |
2207 | construct a name for such a file: | |
2208 | ||
2209 | @example | |
2210 | (make-temp-file @var{name-of-application}) | |
2211 | @end example | |
2212 | ||
2213 | @noindent | |
2214 | The job of @code{make-temp-file} is to prevent two different users or | |
2215 | two different jobs from trying to use the exact same file name. | |
2216 | ||
2217 | @defun make-temp-file prefix &optional dir-flag suffix | |
2218 | This function creates a temporary file and returns its name. Emacs | |
2219 | creates the temporary file's name by adding to @var{prefix} some | |
2220 | random characters that are different in each Emacs job. The result is | |
2221 | guaranteed to be a newly created empty file. On MS-DOS, this function | |
2222 | can truncate the @var{string} prefix to fit into the 8+3 file-name | |
2223 | limits. If @var{prefix} is a relative file name, it is expanded | |
2224 | against @code{temporary-file-directory}. | |
2225 | ||
2226 | @example | |
2227 | @group | |
2228 | (make-temp-file "foo") | |
2229 | @result{} "/tmp/foo232J6v" | |
2230 | @end group | |
2231 | @end example | |
2232 | ||
2233 | When @code{make-temp-file} returns, the file has been created and is | |
2234 | empty. At that point, you should write the intended contents into the | |
2235 | file. | |
2236 | ||
2237 | If @var{dir-flag} is non-@code{nil}, @code{make-temp-file} creates an | |
2238 | empty directory instead of an empty file. It returns the file name, | |
2239 | not the directory name, of that directory. @xref{Directory Names}. | |
2240 | ||
2241 | If @var{suffix} is non-@code{nil}, @code{make-temp-file} adds it at | |
2242 | the end of the file name. | |
2243 | ||
2244 | To prevent conflicts among different libraries running in the same | |
2245 | Emacs, each Lisp program that uses @code{make-temp-file} should have its | |
2246 | own @var{prefix}. The number added to the end of @var{prefix} | |
2247 | distinguishes between the same application running in different Emacs | |
2248 | jobs. Additional added characters permit a large number of distinct | |
2249 | names even in one Emacs job. | |
2250 | @end defun | |
2251 | ||
2252 | The default directory for temporary files is controlled by the | |
2253 | variable @code{temporary-file-directory}. This variable gives the user | |
2254 | a uniform way to specify the directory for all temporary files. Some | |
2255 | programs use @code{small-temporary-file-directory} instead, if that is | |
2256 | non-@code{nil}. To use it, you should expand the prefix against | |
2257 | the proper directory before calling @code{make-temp-file}. | |
2258 | ||
01f17ae2 | 2259 | @defopt temporary-file-directory |
b8d4c8d0 GM |
2260 | @cindex @code{TMPDIR} environment variable |
2261 | @cindex @code{TMP} environment variable | |
2262 | @cindex @code{TEMP} environment variable | |
2263 | This variable specifies the directory name for creating temporary files. | |
2264 | Its value should be a directory name (@pxref{Directory Names}), but it | |
2265 | is good for Lisp programs to cope if the value is a directory's file | |
2266 | name instead. Using the value as the second argument to | |
2267 | @code{expand-file-name} is a good way to achieve that. | |
2268 | ||
2269 | The default value is determined in a reasonable way for your operating | |
2270 | system; it is based on the @code{TMPDIR}, @code{TMP} and @code{TEMP} | |
2271 | environment variables, with a fall-back to a system-dependent name if | |
2272 | none of these variables is defined. | |
2273 | ||
2274 | Even if you do not use @code{make-temp-file} to create the temporary | |
2275 | file, you should still use this variable to decide which directory to | |
2276 | put the file in. However, if you expect the file to be small, you | |
2277 | should use @code{small-temporary-file-directory} first if that is | |
2278 | non-@code{nil}. | |
01f17ae2 | 2279 | @end defopt |
b8d4c8d0 | 2280 | |
01f17ae2 | 2281 | @defopt small-temporary-file-directory |
b8d4c8d0 GM |
2282 | This variable specifies the directory name for |
2283 | creating certain temporary files, which are likely to be small. | |
2284 | ||
2285 | If you want to write a temporary file which is likely to be small, you | |
2286 | should compute the directory like this: | |
2287 | ||
2288 | @example | |
2289 | (make-temp-file | |
2290 | (expand-file-name @var{prefix} | |
2291 | (or small-temporary-file-directory | |
2292 | temporary-file-directory))) | |
2293 | @end example | |
01f17ae2 | 2294 | @end defopt |
b8d4c8d0 | 2295 | |
a59225b1 CY |
2296 | @defun make-temp-name base-name |
2297 | This function generates a string that can be used as a unique file | |
2298 | name. The name starts with @var{base-name}, and has several random | |
2299 | characters appended to it, which are different in each Emacs job. It | |
2300 | is like @code{make-temp-file} except that (i) it just constructs a | |
2301 | name, and does not create a file, and (ii) @var{base-name} should be | |
2302 | an absolute file name (on MS-DOS, this function can truncate | |
2303 | @var{base-name} to fit into the 8+3 file-name limits). | |
2304 | ||
2305 | @strong{Warning:} In most cases, you should not use this function; use | |
2306 | @code{make-temp-file} instead! This function is susceptible to a race | |
2307 | condition, between the @code{make-temp-name} call and the creation of | |
2308 | the file, which in some cases may cause a security hole. | |
2309 | @end defun | |
2310 | ||
b8d4c8d0 GM |
2311 | @node File Name Completion |
2312 | @subsection File Name Completion | |
2313 | @cindex file name completion subroutines | |
2314 | @cindex completion, file name | |
2315 | ||
2316 | This section describes low-level subroutines for completing a file | |
2317 | name. For higher level functions, see @ref{Reading File Names}. | |
2318 | ||
2319 | @defun file-name-all-completions partial-filename directory | |
2320 | This function returns a list of all possible completions for a file | |
2321 | whose name starts with @var{partial-filename} in directory | |
2322 | @var{directory}. The order of the completions is the order of the files | |
2323 | in the directory, which is unpredictable and conveys no useful | |
2324 | information. | |
2325 | ||
2326 | The argument @var{partial-filename} must be a file name containing no | |
2327 | directory part and no slash (or backslash on some systems). The current | |
2328 | buffer's default directory is prepended to @var{directory}, if | |
2329 | @var{directory} is not absolute. | |
2330 | ||
2331 | In the following example, suppose that @file{~rms/lewis} is the current | |
2332 | default directory, and has five files whose names begin with @samp{f}: | |
2333 | @file{foo}, @file{file~}, @file{file.c}, @file{file.c.~1~}, and | |
2334 | @file{file.c.~2~}.@refill | |
2335 | ||
2336 | @example | |
2337 | @group | |
2338 | (file-name-all-completions "f" "") | |
2339 | @result{} ("foo" "file~" "file.c.~2~" | |
2340 | "file.c.~1~" "file.c") | |
2341 | @end group | |
2342 | ||
2343 | @group | |
2344 | (file-name-all-completions "fo" "") | |
2345 | @result{} ("foo") | |
2346 | @end group | |
2347 | @end example | |
2348 | @end defun | |
2349 | ||
2350 | @defun file-name-completion filename directory &optional predicate | |
2351 | This function completes the file name @var{filename} in directory | |
2352 | @var{directory}. It returns the longest prefix common to all file names | |
2353 | in directory @var{directory} that start with @var{filename}. If | |
2354 | @var{predicate} is non-@code{nil} then it ignores possible completions | |
2355 | that don't satisfy @var{predicate}, after calling that function | |
2356 | with one argument, the expanded absolute file name. | |
2357 | ||
2358 | If only one match exists and @var{filename} matches it exactly, the | |
2359 | function returns @code{t}. The function returns @code{nil} if directory | |
2360 | @var{directory} contains no name starting with @var{filename}. | |
2361 | ||
2362 | In the following example, suppose that the current default directory | |
2363 | has five files whose names begin with @samp{f}: @file{foo}, | |
2364 | @file{file~}, @file{file.c}, @file{file.c.~1~}, and | |
2365 | @file{file.c.~2~}.@refill | |
2366 | ||
2367 | @example | |
2368 | @group | |
2369 | (file-name-completion "fi" "") | |
2370 | @result{} "file" | |
2371 | @end group | |
2372 | ||
2373 | @group | |
2374 | (file-name-completion "file.c.~1" "") | |
2375 | @result{} "file.c.~1~" | |
2376 | @end group | |
2377 | ||
2378 | @group | |
2379 | (file-name-completion "file.c.~1~" "") | |
2380 | @result{} t | |
2381 | @end group | |
2382 | ||
2383 | @group | |
2384 | (file-name-completion "file.c.~3" "") | |
2385 | @result{} nil | |
2386 | @end group | |
2387 | @end example | |
2388 | @end defun | |
2389 | ||
2390 | @defopt completion-ignored-extensions | |
2391 | @code{file-name-completion} usually ignores file names that end in any | |
2392 | string in this list. It does not ignore them when all the possible | |
2393 | completions end in one of these suffixes. This variable has no effect | |
2394 | on @code{file-name-all-completions}.@refill | |
2395 | ||
2396 | A typical value might look like this: | |
2397 | ||
2398 | @example | |
2399 | @group | |
2400 | completion-ignored-extensions | |
2401 | @result{} (".o" ".elc" "~" ".dvi") | |
2402 | @end group | |
2403 | @end example | |
2404 | ||
2405 | If an element of @code{completion-ignored-extensions} ends in a slash | |
2406 | @samp{/}, it signals a directory. The elements which do @emph{not} end | |
2407 | in a slash will never match a directory; thus, the above value will not | |
2408 | filter out a directory named @file{foo.elc}. | |
2409 | @end defopt | |
2410 | ||
2411 | @node Standard File Names | |
2412 | @subsection Standard File Names | |
2413 | ||
2414 | Most of the file names used in Lisp programs are entered by the user. | |
2415 | But occasionally a Lisp program needs to specify a standard file name | |
2416 | for a particular use---typically, to hold customization information | |
2417 | about each user. For example, abbrev definitions are stored (by | |
2418 | default) in the file @file{~/.abbrev_defs}; the @code{completion} | |
2419 | package stores completions in the file @file{~/.completions}. These are | |
2420 | two of the many standard file names used by parts of Emacs for certain | |
2421 | purposes. | |
2422 | ||
2423 | Various operating systems have their own conventions for valid file | |
2424 | names and for which file names to use for user profile data. A Lisp | |
2425 | program which reads a file using a standard file name ought to use, on | |
2426 | each type of system, a file name suitable for that system. The function | |
2427 | @code{convert-standard-filename} makes this easy to do. | |
2428 | ||
2429 | @defun convert-standard-filename filename | |
2430 | This function alters the file name @var{filename} to fit the conventions | |
2431 | of the operating system in use, and returns the result as a new string. | |
2432 | @end defun | |
2433 | ||
2434 | The recommended way to specify a standard file name in a Lisp program | |
2435 | is to choose a name which fits the conventions of GNU and Unix systems, | |
2436 | usually with a nondirectory part that starts with a period, and pass it | |
2437 | to @code{convert-standard-filename} instead of using it directly. Here | |
2438 | is an example from the @code{completion} package: | |
2439 | ||
2440 | @example | |
2441 | (defvar save-completions-file-name | |
2442 | (convert-standard-filename "~/.completions") | |
2443 | "*The file name to save completions to.") | |
2444 | @end example | |
2445 | ||
2446 | On GNU and Unix systems, and on some other systems as well, | |
2447 | @code{convert-standard-filename} returns its argument unchanged. On | |
2448 | some other systems, it alters the name to fit the system's conventions. | |
2449 | ||
2450 | For example, on MS-DOS the alterations made by this function include | |
2451 | converting a leading @samp{.} to @samp{_}, converting a @samp{_} in the | |
2452 | middle of the name to @samp{.} if there is no other @samp{.}, inserting | |
2453 | a @samp{.} after eight characters if there is none, and truncating to | |
2454 | three characters after the @samp{.}. (It makes other changes as well.) | |
2455 | Thus, @file{.abbrev_defs} becomes @file{_abbrev.def}, and | |
2456 | @file{.completions} becomes @file{_complet.ion}. | |
2457 | ||
2458 | @node Contents of Directories | |
2459 | @section Contents of Directories | |
2460 | @cindex directory-oriented functions | |
2461 | @cindex file names in directory | |
2462 | ||
2463 | A directory is a kind of file that contains other files entered under | |
2464 | various names. Directories are a feature of the file system. | |
2465 | ||
2466 | Emacs can list the names of the files in a directory as a Lisp list, | |
2467 | or display the names in a buffer using the @code{ls} shell command. In | |
2468 | the latter case, it can optionally display information about each file, | |
2469 | depending on the options passed to the @code{ls} command. | |
2470 | ||
2471 | @defun directory-files directory &optional full-name match-regexp nosort | |
2472 | This function returns a list of the names of the files in the directory | |
2473 | @var{directory}. By default, the list is in alphabetical order. | |
2474 | ||
2475 | If @var{full-name} is non-@code{nil}, the function returns the files' | |
2476 | absolute file names. Otherwise, it returns the names relative to | |
2477 | the specified directory. | |
2478 | ||
2479 | If @var{match-regexp} is non-@code{nil}, this function returns only | |
2480 | those file names that contain a match for that regular expression---the | |
2481 | other file names are excluded from the list. On case-insensitive | |
2482 | filesystems, the regular expression matching is case-insensitive. | |
2483 | ||
2484 | @c Emacs 19 feature | |
2485 | If @var{nosort} is non-@code{nil}, @code{directory-files} does not sort | |
2486 | the list, so you get the file names in no particular order. Use this if | |
2487 | you want the utmost possible speed and don't care what order the files | |
2488 | are processed in. If the order of processing is visible to the user, | |
2489 | then the user will probably be happier if you do sort the names. | |
2490 | ||
2491 | @example | |
2492 | @group | |
2493 | (directory-files "~lewis") | |
2494 | @result{} ("#foo#" "#foo.el#" "." ".." | |
2495 | "dired-mods.el" "files.texi" | |
2496 | "files.texi.~1~") | |
2497 | @end group | |
2498 | @end example | |
2499 | ||
2500 | An error is signaled if @var{directory} is not the name of a directory | |
2501 | that can be read. | |
2502 | @end defun | |
2503 | ||
2504 | @defun directory-files-and-attributes directory &optional full-name match-regexp nosort id-format | |
2505 | This is similar to @code{directory-files} in deciding which files | |
2506 | to report on and how to report their names. However, instead | |
2507 | of returning a list of file names, it returns for each file a | |
2508 | list @code{(@var{filename} . @var{attributes})}, where @var{attributes} | |
2509 | is what @code{file-attributes} would return for that file. | |
2510 | The optional argument @var{id-format} has the same meaning as the | |
2511 | corresponding argument to @code{file-attributes} (@pxref{Definition | |
2512 | of file-attributes}). | |
2513 | @end defun | |
2514 | ||
b8d4c8d0 GM |
2515 | @defun file-expand-wildcards pattern &optional full |
2516 | This function expands the wildcard pattern @var{pattern}, returning | |
2517 | a list of file names that match it. | |
2518 | ||
2519 | If @var{pattern} is written as an absolute file name, | |
2520 | the values are absolute also. | |
2521 | ||
2522 | If @var{pattern} is written as a relative file name, it is interpreted | |
2523 | relative to the current default directory. The file names returned are | |
2524 | normally also relative to the current default directory. However, if | |
2525 | @var{full} is non-@code{nil}, they are absolute. | |
2526 | @end defun | |
2527 | ||
2528 | @defun insert-directory file switches &optional wildcard full-directory-p | |
2529 | This function inserts (in the current buffer) a directory listing for | |
2530 | directory @var{file}, formatted with @code{ls} according to | |
2531 | @var{switches}. It leaves point after the inserted text. | |
2532 | @var{switches} may be a string of options, or a list of strings | |
2533 | representing individual options. | |
2534 | ||
2535 | The argument @var{file} may be either a directory name or a file | |
2536 | specification including wildcard characters. If @var{wildcard} is | |
2537 | non-@code{nil}, that means treat @var{file} as a file specification with | |
2538 | wildcards. | |
2539 | ||
2540 | If @var{full-directory-p} is non-@code{nil}, that means the directory | |
2541 | listing is expected to show the full contents of a directory. You | |
2542 | should specify @code{t} when @var{file} is a directory and switches do | |
2543 | not contain @samp{-d}. (The @samp{-d} option to @code{ls} says to | |
2544 | describe a directory itself as a file, rather than showing its | |
2545 | contents.) | |
2546 | ||
2547 | On most systems, this function works by running a directory listing | |
2548 | program whose name is in the variable @code{insert-directory-program}. | |
2549 | If @var{wildcard} is non-@code{nil}, it also runs the shell specified by | |
2550 | @code{shell-file-name}, to expand the wildcards. | |
2551 | ||
2552 | MS-DOS and MS-Windows systems usually lack the standard Unix program | |
2553 | @code{ls}, so this function emulates the standard Unix program @code{ls} | |
2554 | with Lisp code. | |
2555 | ||
2556 | As a technical detail, when @var{switches} contains the long | |
2557 | @samp{--dired} option, @code{insert-directory} treats it specially, | |
2558 | for the sake of dired. However, the normally equivalent short | |
2559 | @samp{-D} option is just passed on to @code{insert-directory-program}, | |
2560 | as any other option. | |
2561 | @end defun | |
2562 | ||
2563 | @defvar insert-directory-program | |
2564 | This variable's value is the program to run to generate a directory listing | |
2565 | for the function @code{insert-directory}. It is ignored on systems | |
2566 | which generate the listing with Lisp code. | |
2567 | @end defvar | |
2568 | ||
2569 | @node Create/Delete Dirs | |
461bf92b | 2570 | @section Creating, Copying and Deleting Directories |
804543b5 | 2571 | @cindex creating, copying and deleting directories |
b8d4c8d0 GM |
2572 | @c Emacs 19 features |
2573 | ||
2574 | Most Emacs Lisp file-manipulation functions get errors when used on | |
2575 | files that are directories. For example, you cannot delete a directory | |
2576 | with @code{delete-file}. These special functions exist to create and | |
2577 | delete directories. | |
2578 | ||
2aa8ea6e | 2579 | @findex mkdir |
106e6894 CY |
2580 | @deffn Command make-directory dirname &optional parents |
2581 | This command creates a directory named @var{dirname}. If | |
2582 | @var{parents} is non-@code{nil}, as is always the case in an | |
b8d4c8d0 GM |
2583 | interactive call, that means to create the parent directories first, |
2584 | if they don't already exist. | |
2aa8ea6e | 2585 | |
106e6894 CY |
2586 | @code{mkdir} is an alias for this. |
2587 | @end deffn | |
b8d4c8d0 | 2588 | |
a6326082 | 2589 | @deffn Command copy-directory dirname newname &optional keep-time parents copy-contents |
461bf92b MA |
2590 | This command copies the directory named @var{dirname} to |
2591 | @var{newname}. If @var{newname} names an existing directory, | |
2592 | @var{dirname} will be copied to a subdirectory there. | |
2593 | ||
2594 | It always sets the file modes of the copied files to match the | |
2595 | corresponding original file. | |
2596 | ||
a6326082 | 2597 | The third argument @var{keep-time} non-@code{nil} means to preserve the |
461bf92b MA |
2598 | modification time of the copied files. A prefix arg makes |
2599 | @var{keep-time} non-@code{nil}. | |
2600 | ||
a6326082 | 2601 | The fourth argument @var{parents} says whether to |
461bf92b MA |
2602 | create parent directories if they don't exist. Interactively, |
2603 | this happens by default. | |
a6326082 CY |
2604 | |
2605 | The fifth argument @var{copy-contents}, if non-@code{nil}, means to | |
2606 | copy the contents of @var{dirname} directly into @var{newname} if the | |
2607 | latter is an existing directory, instead of copying @var{dirname} into | |
2608 | it as a subdirectory. | |
461bf92b MA |
2609 | @end deffn |
2610 | ||
04e2ce72 CY |
2611 | @cindex trash |
2612 | @vindex delete-by-moving-to-trash | |
2613 | @deffn Command delete-directory dirname &optional recursive trash | |
106e6894 | 2614 | This command deletes the directory named @var{dirname}. The function |
b8d4c8d0 | 2615 | @code{delete-file} does not work for files that are directories; you |
d3080264 MA |
2616 | must use @code{delete-directory} for them. If @var{recursive} is |
2617 | @code{nil}, and the directory contains any files, | |
2618 | @code{delete-directory} signals an error. | |
b8d4c8d0 | 2619 | |
106e6894 CY |
2620 | @code{delete-directory} only follows symbolic links at the level of |
2621 | parent directories. | |
04e2ce72 CY |
2622 | |
2623 | If the optional argument @var{trash} is non-@code{nil} and the | |
2624 | variable @code{delete-by-moving-to-trash} is non-@code{nil}, this | |
2625 | command moves the file into the system Trash instead of deleting it. | |
2626 | @xref{Misc File Ops,,Miscellaneous File Operations, emacs, The GNU | |
2627 | Emacs Manual}. When called interactively, @var{trash} is @code{t} if | |
2628 | no prefix argument is given, and @code{nil} otherwise. | |
106e6894 | 2629 | @end deffn |
b8d4c8d0 GM |
2630 | |
2631 | @node Magic File Names | |
2632 | @section Making Certain File Names ``Magic'' | |
2633 | @cindex magic file names | |
2634 | ||
b8d4c8d0 GM |
2635 | You can implement special handling for certain file names. This is |
2636 | called making those names @dfn{magic}. The principal use for this | |
2637 | feature is in implementing remote file names (@pxref{Remote Files,, | |
2638 | Remote Files, emacs, The GNU Emacs Manual}). | |
2639 | ||
2640 | To define a kind of magic file name, you must supply a regular | |
2641 | expression to define the class of names (all those that match the | |
2642 | regular expression), plus a handler that implements all the primitive | |
a59225b1 | 2643 | Emacs file operations for file names that match. |
b8d4c8d0 | 2644 | |
ebe479ec | 2645 | @vindex file-name-handler-alist |
b8d4c8d0 GM |
2646 | The variable @code{file-name-handler-alist} holds a list of handlers, |
2647 | together with regular expressions that determine when to apply each | |
2648 | handler. Each element has this form: | |
2649 | ||
2650 | @example | |
2651 | (@var{regexp} . @var{handler}) | |
2652 | @end example | |
2653 | ||
2654 | @noindent | |
2655 | All the Emacs primitives for file access and file name transformation | |
2656 | check the given file name against @code{file-name-handler-alist}. If | |
2657 | the file name matches @var{regexp}, the primitives handle that file by | |
2658 | calling @var{handler}. | |
2659 | ||
2660 | The first argument given to @var{handler} is the name of the | |
2661 | primitive, as a symbol; the remaining arguments are the arguments that | |
2662 | were passed to that primitive. (The first of these arguments is most | |
2663 | often the file name itself.) For example, if you do this: | |
2664 | ||
2665 | @example | |
2666 | (file-exists-p @var{filename}) | |
2667 | @end example | |
2668 | ||
2669 | @noindent | |
2670 | and @var{filename} has handler @var{handler}, then @var{handler} is | |
2671 | called like this: | |
2672 | ||
2673 | @example | |
2674 | (funcall @var{handler} 'file-exists-p @var{filename}) | |
2675 | @end example | |
2676 | ||
2677 | When a function takes two or more arguments that must be file names, | |
2678 | it checks each of those names for a handler. For example, if you do | |
2679 | this: | |
2680 | ||
2681 | @example | |
2682 | (expand-file-name @var{filename} @var{dirname}) | |
2683 | @end example | |
2684 | ||
2685 | @noindent | |
2686 | then it checks for a handler for @var{filename} and then for a handler | |
2687 | for @var{dirname}. In either case, the @var{handler} is called like | |
2688 | this: | |
2689 | ||
2690 | @example | |
2691 | (funcall @var{handler} 'expand-file-name @var{filename} @var{dirname}) | |
2692 | @end example | |
2693 | ||
2694 | @noindent | |
2695 | The @var{handler} then needs to figure out whether to handle | |
2696 | @var{filename} or @var{dirname}. | |
2697 | ||
2698 | If the specified file name matches more than one handler, the one | |
2699 | whose match starts last in the file name gets precedence. This rule | |
2700 | is chosen so that handlers for jobs such as uncompression are handled | |
2701 | first, before handlers for jobs such as remote file access. | |
2702 | ||
2703 | Here are the operations that a magic file name handler gets to handle: | |
2704 | ||
2705 | @ifnottex | |
2706 | @noindent | |
2707 | @code{access-file}, @code{add-name-to-file}, | |
2708 | @code{byte-compiler-base-file-name},@* | |
2a3f19ef MA |
2709 | @code{copy-directory}, @code{copy-file}, |
2710 | @code{delete-directory}, @code{delete-file}, | |
b8d4c8d0 GM |
2711 | @code{diff-latest-backup-file}, |
2712 | @code{directory-file-name}, | |
2713 | @code{directory-files}, | |
2714 | @code{directory-files-and-attributes}, | |
2715 | @code{dired-compress-file}, @code{dired-uncache},@* | |
2716 | @code{expand-file-name}, | |
2717 | @code{file-accessible-directory-p}, | |
2718 | @code{file-attributes}, | |
2719 | @code{file-directory-p}, | |
2720 | @code{file-executable-p}, @code{file-exists-p}, | |
2721 | @code{file-local-copy}, @code{file-remote-p}, | |
2722 | @code{file-modes}, @code{file-name-all-completions}, | |
2723 | @code{file-name-as-directory}, | |
2724 | @code{file-name-completion}, | |
2725 | @code{file-name-directory}, | |
2726 | @code{file-name-nondirectory}, | |
2727 | @code{file-name-sans-versions}, @code{file-newer-than-file-p}, | |
2728 | @code{file-ownership-preserved-p}, | |
2729 | @code{file-readable-p}, @code{file-regular-p}, @code{file-symlink-p}, | |
2730 | @code{file-truename}, @code{file-writable-p}, | |
2731 | @code{find-backup-file-name}, | |
4e47bf1f | 2732 | @c Not sure why it was here: @code{find-file-noselect},@* |
b8d4c8d0 GM |
2733 | @code{get-file-buffer}, |
2734 | @code{insert-directory}, | |
2735 | @code{insert-file-contents},@* | |
2736 | @code{load}, | |
2737 | @code{make-auto-save-file-name}, | |
2738 | @code{make-directory}, | |
2739 | @code{make-directory-internal}, | |
2740 | @code{make-symbolic-link},@* | |
2741 | @code{process-file}, | |
2742 | @code{rename-file}, @code{set-file-modes}, @code{set-file-times}, | |
2743 | @code{set-visited-file-modtime}, @code{shell-command}, | |
2744 | @code{start-file-process}, | |
2745 | @code{substitute-in-file-name},@* | |
2746 | @code{unhandled-file-name-directory}, | |
2747 | @code{vc-registered}, | |
2748 | @code{verify-visited-file-modtime},@* | |
2749 | @code{write-region}. | |
2750 | @end ifnottex | |
2751 | @iftex | |
2752 | @noindent | |
2753 | @flushleft | |
2754 | @code{access-file}, @code{add-name-to-file}, | |
2755 | @code{byte-com@discretionary{}{}{}piler-base-file-name}, | |
2a3f19ef MA |
2756 | @code{copy-directory}, @code{copy-file}, |
2757 | @code{delete-directory}, @code{delete-file}, | |
b8d4c8d0 GM |
2758 | @code{diff-latest-backup-file}, |
2759 | @code{directory-file-name}, | |
2760 | @code{directory-files}, | |
2761 | @code{directory-files-and-at@discretionary{}{}{}tributes}, | |
2762 | @code{dired-compress-file}, @code{dired-uncache}, | |
2763 | @code{expand-file-name}, | |
2764 | @code{file-accessible-direc@discretionary{}{}{}tory-p}, | |
2765 | @code{file-attributes}, | |
2766 | @code{file-direct@discretionary{}{}{}ory-p}, | |
2767 | @code{file-executable-p}, @code{file-exists-p}, | |
2768 | @code{file-local-copy}, @code{file-remote-p}, | |
2769 | @code{file-modes}, @code{file-name-all-completions}, | |
2770 | @code{file-name-as-directory}, | |
2771 | @code{file-name-completion}, | |
2772 | @code{file-name-directory}, | |
2773 | @code{file-name-nondirec@discretionary{}{}{}tory}, | |
2774 | @code{file-name-sans-versions}, @code{file-newer-than-file-p}, | |
2775 | @code{file-ownership-pre@discretionary{}{}{}served-p}, | |
2776 | @code{file-readable-p}, @code{file-regular-p}, @code{file-symlink-p}, | |
2777 | @code{file-truename}, @code{file-writable-p}, | |
2778 | @code{find-backup-file-name}, | |
4e47bf1f | 2779 | @c Not sure why it was here: @code{find-file-noselect}, |
b8d4c8d0 GM |
2780 | @code{get-file-buffer}, |
2781 | @code{insert-directory}, | |
2782 | @code{insert-file-contents}, | |
2783 | @code{load}, @code{make-direc@discretionary{}{}{}tory}, | |
2784 | @code{make-direc@discretionary{}{}{}tory-internal}, | |
2785 | @code{make-symbolic-link}, | |
2786 | @code{process-file}, | |
2787 | @code{rename-file}, @code{set-file-modes}, | |
2788 | @code{set-visited-file-modtime}, @code{shell-command}, | |
2789 | @code{start-file-process}, | |
2790 | @code{substitute-in-file-name}, | |
2791 | @code{unhandled-file-name-directory}, | |
2792 | @code{vc-regis@discretionary{}{}{}tered}, | |
2793 | @code{verify-visited-file-modtime}, | |
2794 | @code{write-region}. | |
2795 | @end flushleft | |
2796 | @end iftex | |
2797 | ||
2798 | Handlers for @code{insert-file-contents} typically need to clear the | |
2799 | buffer's modified flag, with @code{(set-buffer-modified-p nil)}, if the | |
2800 | @var{visit} argument is non-@code{nil}. This also has the effect of | |
2801 | unlocking the buffer if it is locked. | |
2802 | ||
2803 | The handler function must handle all of the above operations, and | |
2804 | possibly others to be added in the future. It need not implement all | |
2805 | these operations itself---when it has nothing special to do for a | |
2806 | certain operation, it can reinvoke the primitive, to handle the | |
2807 | operation ``in the usual way.'' It should always reinvoke the primitive | |
2808 | for an operation it does not recognize. Here's one way to do this: | |
2809 | ||
2810 | @smallexample | |
2811 | (defun my-file-handler (operation &rest args) | |
2812 | ;; @r{First check for the specific operations} | |
2813 | ;; @r{that we have special handling for.} | |
2814 | (cond ((eq operation 'insert-file-contents) @dots{}) | |
2815 | ((eq operation 'write-region) @dots{}) | |
2816 | @dots{} | |
2817 | ;; @r{Handle any operation we don't know about.} | |
2818 | (t (let ((inhibit-file-name-handlers | |
2819 | (cons 'my-file-handler | |
2820 | (and (eq inhibit-file-name-operation operation) | |
2821 | inhibit-file-name-handlers))) | |
2822 | (inhibit-file-name-operation operation)) | |
2823 | (apply operation args))))) | |
2824 | @end smallexample | |
2825 | ||
2826 | When a handler function decides to call the ordinary Emacs primitive for | |
2827 | the operation at hand, it needs to prevent the primitive from calling | |
2828 | the same handler once again, thus leading to an infinite recursion. The | |
2829 | example above shows how to do this, with the variables | |
2830 | @code{inhibit-file-name-handlers} and | |
2831 | @code{inhibit-file-name-operation}. Be careful to use them exactly as | |
2832 | shown above; the details are crucial for proper behavior in the case of | |
2833 | multiple handlers, and for operations that have two file names that may | |
2834 | each have handlers. | |
2835 | ||
2836 | @kindex safe-magic (@r{property}) | |
2837 | Handlers that don't really do anything special for actual access to the | |
2838 | file---such as the ones that implement completion of host names for | |
2839 | remote file names---should have a non-@code{nil} @code{safe-magic} | |
2840 | property. For instance, Emacs normally ``protects'' directory names | |
2841 | it finds in @code{PATH} from becoming magic, if they look like magic | |
2842 | file names, by prefixing them with @samp{/:}. But if the handler that | |
2843 | would be used for them has a non-@code{nil} @code{safe-magic} | |
2844 | property, the @samp{/:} is not added. | |
2845 | ||
2846 | @kindex operations (@r{property}) | |
2847 | A file name handler can have an @code{operations} property to | |
2848 | declare which operations it handles in a nontrivial way. If this | |
2849 | property has a non-@code{nil} value, it should be a list of | |
2850 | operations; then only those operations will call the handler. This | |
2851 | avoids inefficiency, but its main purpose is for autoloaded handler | |
2852 | functions, so that they won't be loaded except when they have real | |
2853 | work to do. | |
2854 | ||
2855 | Simply deferring all operations to the usual primitives does not | |
2856 | work. For instance, if the file name handler applies to | |
2857 | @code{file-exists-p}, then it must handle @code{load} itself, because | |
2858 | the usual @code{load} code won't work properly in that case. However, | |
2859 | if the handler uses the @code{operations} property to say it doesn't | |
2860 | handle @code{file-exists-p}, then it need not handle @code{load} | |
2861 | nontrivially. | |
2862 | ||
2863 | @defvar inhibit-file-name-handlers | |
2864 | This variable holds a list of handlers whose use is presently inhibited | |
2865 | for a certain operation. | |
2866 | @end defvar | |
2867 | ||
2868 | @defvar inhibit-file-name-operation | |
2869 | The operation for which certain handlers are presently inhibited. | |
2870 | @end defvar | |
2871 | ||
2872 | @defun find-file-name-handler file operation | |
2873 | This function returns the handler function for file name @var{file}, | |
2874 | or @code{nil} if there is none. The argument @var{operation} should | |
2875 | be the operation to be performed on the file---the value you will pass | |
2876 | to the handler as its first argument when you call it. If | |
2877 | @var{operation} equals @code{inhibit-file-name-operation}, or if it is | |
2878 | not found in the @code{operations} property of the handler, this | |
2879 | function returns @code{nil}. | |
2880 | @end defun | |
2881 | ||
2882 | @defun file-local-copy filename | |
2883 | This function copies file @var{filename} to an ordinary non-magic file | |
2884 | on the local machine, if it isn't on the local machine already. Magic | |
2885 | file names should handle the @code{file-local-copy} operation if they | |
2886 | refer to files on other machines. A magic file name that is used for | |
2887 | other purposes than remote file access should not handle | |
2888 | @code{file-local-copy}; then this function will treat the file as | |
2889 | local. | |
2890 | ||
2891 | If @var{filename} is local, whether magic or not, this function does | |
2892 | nothing and returns @code{nil}. Otherwise it returns the file name | |
2893 | of the local copy file. | |
2894 | @end defun | |
2895 | ||
2896 | @defun file-remote-p filename &optional identification connected | |
2897 | This function tests whether @var{filename} is a remote file. If | |
2898 | @var{filename} is local (not remote), the return value is @code{nil}. | |
2899 | If @var{filename} is indeed remote, the return value is a string that | |
2900 | identifies the remote system. | |
2901 | ||
2902 | This identifier string can include a host name and a user name, as | |
2903 | well as characters designating the method used to access the remote | |
2904 | system. For example, the remote identifier string for the filename | |
2905 | @code{/sudo::/some/file} is @code{/sudo:root@@localhost:}. | |
2906 | ||
2907 | If @code{file-remote-p} returns the same identifier for two different | |
2908 | filenames, that means they are stored on the same file system and can | |
2909 | be accessed locally with respect to each other. This means, for | |
2910 | example, that it is possible to start a remote process accessing both | |
f6b1b0a8 | 2911 | files at the same time. Implementers of file handlers need to ensure |
b8d4c8d0 GM |
2912 | this principle is valid. |
2913 | ||
2914 | @var{identification} specifies which part of the identifier shall be | |
2915 | returned as string. @var{identification} can be the symbol | |
2916 | @code{method}, @code{user} or @code{host}; any other value is handled | |
2917 | like @code{nil} and means to return the complete identifier string. | |
2918 | In the example above, the remote @code{user} identifier string would | |
2919 | be @code{root}. | |
2920 | ||
2921 | If @var{connected} is non-@code{nil}, this function returns @code{nil} | |
2922 | even if @var{filename} is remote, if Emacs has no network connection | |
2923 | to its host. This is useful when you want to avoid the delay of | |
2924 | making connections when they don't exist. | |
2925 | @end defun | |
2926 | ||
2927 | @defun unhandled-file-name-directory filename | |
4990219b CY |
2928 | This function returns the name of a directory that is not magic. It |
2929 | uses the directory part of @var{filename} if that is not magic. For a | |
2930 | magic file name, it invokes the file name handler, which therefore | |
2931 | decides what value to return. If @var{filename} is not accessible | |
2932 | from a local process, then the file name handler should indicate it by | |
2933 | returning @code{nil}. | |
b8d4c8d0 GM |
2934 | |
2935 | This is useful for running a subprocess; every subprocess must have a | |
2936 | non-magic directory to serve as its current directory, and this function | |
2937 | is a good way to come up with one. | |
2938 | @end defun | |
2939 | ||
178fdd41 | 2940 | @defopt remote-file-name-inhibit-cache |
b011fbfe GM |
2941 | The attributes of remote files can be cached for better performance. If |
2942 | they are changed outside of Emacs's control, the cached values become | |
178fdd41 MA |
2943 | invalid, and must be reread. |
2944 | ||
b011fbfe GM |
2945 | When this variable is set to @code{nil}, cached values are never |
2946 | expired. Use this setting with caution, only if you are sure nothing | |
2947 | other than Emacs ever changes the remote files. If it is set to | |
2948 | @code{t}, cached values are never used. This is the safest value, but | |
2949 | could result in performance degradation. | |
178fdd41 MA |
2950 | |
2951 | A compromise is to set it to a positive number. This means that | |
2952 | cached values are used for that amount of seconds since they were | |
b011fbfe GM |
2953 | cached. If a remote file is checked regularly, it might be a good |
2954 | idea to let-bind this variable to a value less than the time period | |
2955 | between consecutive checks. For example: | |
178fdd41 MA |
2956 | |
2957 | @example | |
2958 | (defun display-time-file-nonempty-p (file) | |
2959 | (let ((remote-file-name-inhibit-cache (- display-time-interval 5))) | |
2960 | (and (file-exists-p file) | |
2961 | (< 0 (nth 7 (file-attributes (file-chase-links file))))))) | |
2962 | @end example | |
2963 | @end defopt | |
2964 | ||
b8d4c8d0 GM |
2965 | @node Format Conversion |
2966 | @section File Format Conversion | |
2967 | ||
2968 | @cindex file format conversion | |
2969 | @cindex encoding file formats | |
2970 | @cindex decoding file formats | |
2971 | @cindex text properties in files | |
2972 | @cindex saving text properties | |
2973 | Emacs performs several steps to convert the data in a buffer (text, | |
2974 | text properties, and possibly other information) to and from a | |
2975 | representation suitable for storing into a file. This section describes | |
2976 | the fundamental functions that perform this @dfn{format conversion}, | |
2977 | namely @code{insert-file-contents} for reading a file into a buffer, | |
2978 | and @code{write-region} for writing a buffer into a file. | |
2979 | ||
2980 | @menu | |
76f444dc | 2981 | * Overview: Format Conversion Overview. @code{insert-file-contents} and @code{write-region}. |
b8d4c8d0 GM |
2982 | * Round-Trip: Format Conversion Round-Trip. Using @code{format-alist}. |
2983 | * Piecemeal: Format Conversion Piecemeal. Specifying non-paired conversion. | |
2984 | @end menu | |
2985 | ||
2986 | @node Format Conversion Overview | |
2987 | @subsection Overview | |
2988 | @noindent | |
2989 | The function @code{insert-file-contents}: | |
2990 | ||
2991 | @itemize | |
2992 | @item initially, inserts bytes from the file into the buffer; | |
2993 | @item decodes bytes to characters as appropriate; | |
2994 | @item processes formats as defined by entries in @code{format-alist}; and | |
2995 | @item calls functions in @code{after-insert-file-functions}. | |
2996 | @end itemize | |
2997 | ||
2998 | @noindent | |
2999 | The function @code{write-region}: | |
3000 | ||
3001 | @itemize | |
3002 | @item initially, calls functions in @code{write-region-annotate-functions}; | |
3003 | @item processes formats as defined by entries in @code{format-alist}; | |
3004 | @item encodes characters to bytes as appropriate; and | |
3005 | @item modifies the file with the bytes. | |
3006 | @end itemize | |
3007 | ||
3008 | This shows the symmetry of the lowest-level operations; reading and | |
3009 | writing handle things in opposite order. The rest of this section | |
3010 | describes the two facilities surrounding the three variables named | |
3011 | above, as well as some related functions. @ref{Coding Systems}, for | |
3012 | details on character encoding and decoding. | |
3013 | ||
3014 | @node Format Conversion Round-Trip | |
3015 | @subsection Round-Trip Specification | |
3016 | ||
3017 | The most general of the two facilities is controlled by the variable | |
3018 | @code{format-alist}, a list of @dfn{file format} specifications, which | |
3019 | describe textual representations used in files for the data in an Emacs | |
3020 | buffer. The descriptions for reading and writing are paired, which is | |
3021 | why we call this ``round-trip'' specification | |
3022 | (@pxref{Format Conversion Piecemeal}, for non-paired specification). | |
3023 | ||
3024 | @defvar format-alist | |
3025 | This list contains one format definition for each defined file format. | |
3026 | Each format definition is a list of this form: | |
3027 | ||
3028 | @example | |
c249fa9c | 3029 | (@var{name} @var{doc-string} @var{regexp} @var{from-fn} @var{to-fn} @var{modify} @var{mode-fn} @var{preserve}) |
b8d4c8d0 GM |
3030 | @end example |
3031 | @end defvar | |
3032 | ||
3033 | @cindex format definition | |
3034 | @noindent | |
3035 | Here is what the elements in a format definition mean: | |
3036 | ||
3037 | @table @var | |
3038 | @item name | |
3039 | The name of this format. | |
3040 | ||
3041 | @item doc-string | |
3042 | A documentation string for the format. | |
3043 | ||
3044 | @item regexp | |
3045 | A regular expression which is used to recognize files represented in | |
0706c025 | 3046 | this format. If @code{nil}, the format is never applied automatically. |
b8d4c8d0 GM |
3047 | |
3048 | @item from-fn | |
3049 | A shell command or function to decode data in this format (to convert | |
3050 | file data into the usual Emacs data representation). | |
3051 | ||
3052 | A shell command is represented as a string; Emacs runs the command as a | |
3053 | filter to perform the conversion. | |
3054 | ||
3055 | If @var{from-fn} is a function, it is called with two arguments, @var{begin} | |
3056 | and @var{end}, which specify the part of the buffer it should convert. | |
3057 | It should convert the text by editing it in place. Since this can | |
3058 | change the length of the text, @var{from-fn} should return the modified | |
3059 | end position. | |
3060 | ||
3061 | One responsibility of @var{from-fn} is to make sure that the beginning | |
3062 | of the file no longer matches @var{regexp}. Otherwise it is likely to | |
3063 | get called again. | |
3064 | ||
3065 | @item to-fn | |
3066 | A shell command or function to encode data in this format---that is, to | |
3067 | convert the usual Emacs data representation into this format. | |
3068 | ||
3069 | If @var{to-fn} is a string, it is a shell command; Emacs runs the | |
3070 | command as a filter to perform the conversion. | |
3071 | ||
3072 | If @var{to-fn} is a function, it is called with three arguments: | |
3073 | @var{begin} and @var{end}, which specify the part of the buffer it | |
3074 | should convert, and @var{buffer}, which specifies which buffer. There | |
3075 | are two ways it can do the conversion: | |
3076 | ||
3077 | @itemize @bullet | |
3078 | @item | |
3079 | By editing the buffer in place. In this case, @var{to-fn} should | |
3080 | return the end-position of the range of text, as modified. | |
3081 | ||
3082 | @item | |
3083 | By returning a list of annotations. This is a list of elements of the | |
3084 | form @code{(@var{position} . @var{string})}, where @var{position} is an | |
3085 | integer specifying the relative position in the text to be written, and | |
3086 | @var{string} is the annotation to add there. The list must be sorted in | |
3087 | order of position when @var{to-fn} returns it. | |
3088 | ||
3089 | When @code{write-region} actually writes the text from the buffer to the | |
3090 | file, it intermixes the specified annotations at the corresponding | |
3091 | positions. All this takes place without modifying the buffer. | |
3092 | @end itemize | |
3093 | ||
3094 | @item modify | |
3095 | A flag, @code{t} if the encoding function modifies the buffer, and | |
3096 | @code{nil} if it works by returning a list of annotations. | |
3097 | ||
3098 | @item mode-fn | |
3099 | A minor-mode function to call after visiting a file converted from this | |
3100 | format. The function is called with one argument, the integer 1; | |
3101 | that tells a minor-mode function to enable the mode. | |
c249fa9c GM |
3102 | |
3103 | @item preserve | |
3104 | A flag, @code{t} if @code{format-write-file} should not remove this format | |
3105 | from @code{buffer-file-format}. | |
b8d4c8d0 GM |
3106 | @end table |
3107 | ||
3108 | The function @code{insert-file-contents} automatically recognizes file | |
3109 | formats when it reads the specified file. It checks the text of the | |
3110 | beginning of the file against the regular expressions of the format | |
3111 | definitions, and if it finds a match, it calls the decoding function for | |
3112 | that format. Then it checks all the known formats over again. | |
3113 | It keeps checking them until none of them is applicable. | |
3114 | ||
3115 | Visiting a file, with @code{find-file-noselect} or the commands that use | |
3116 | it, performs conversion likewise (because it calls | |
3117 | @code{insert-file-contents}); it also calls the mode function for each | |
3118 | format that it decodes. It stores a list of the format names in the | |
3119 | buffer-local variable @code{buffer-file-format}. | |
3120 | ||
3121 | @defvar buffer-file-format | |
3122 | This variable states the format of the visited file. More precisely, | |
3123 | this is a list of the file format names that were decoded in the course | |
3124 | of visiting the current buffer's file. It is always buffer-local in all | |
3125 | buffers. | |
3126 | @end defvar | |
3127 | ||
3128 | When @code{write-region} writes data into a file, it first calls the | |
3129 | encoding functions for the formats listed in @code{buffer-file-format}, | |
3130 | in the order of appearance in the list. | |
3131 | ||
3132 | @deffn Command format-write-file file format &optional confirm | |
fa047ae7 GM |
3133 | This command writes the current buffer contents into the file @var{file} |
3134 | in a format based on @var{format}, which is a list of format names. It | |
3135 | constructs the actual format starting from @var{format}, then appending | |
3136 | any elements from the value of @code{buffer-file-format} with a non-nil | |
3137 | @var{preserve} flag (see above), if they are not already present in | |
3138 | @var{format}. It then updates @code{buffer-file-format} with this | |
3139 | format, making it the default for future saves. Except for the | |
3140 | @var{format} argument, this command is similar to @code{write-file}. In | |
3141 | particular, @var{confirm} has the same meaning and interactive treatment | |
3142 | as the corresponding argument to @code{write-file}. @xref{Definition of | |
3143 | write-file}. | |
b8d4c8d0 GM |
3144 | @end deffn |
3145 | ||
3146 | @deffn Command format-find-file file format | |
3147 | This command finds the file @var{file}, converting it according to | |
3148 | format @var{format}. It also makes @var{format} the default if the | |
3149 | buffer is saved later. | |
3150 | ||
3151 | The argument @var{format} is a list of format names. If @var{format} is | |
3152 | @code{nil}, no conversion takes place. Interactively, typing just | |
3153 | @key{RET} for @var{format} specifies @code{nil}. | |
3154 | @end deffn | |
3155 | ||
3156 | @deffn Command format-insert-file file format &optional beg end | |
3157 | This command inserts the contents of file @var{file}, converting it | |
3158 | according to format @var{format}. If @var{beg} and @var{end} are | |
3159 | non-@code{nil}, they specify which part of the file to read, as in | |
3160 | @code{insert-file-contents} (@pxref{Reading from Files}). | |
3161 | ||
3162 | The return value is like what @code{insert-file-contents} returns: a | |
3163 | list of the absolute file name and the length of the data inserted | |
3164 | (after conversion). | |
3165 | ||
3166 | The argument @var{format} is a list of format names. If @var{format} is | |
3167 | @code{nil}, no conversion takes place. Interactively, typing just | |
3168 | @key{RET} for @var{format} specifies @code{nil}. | |
3169 | @end deffn | |
3170 | ||
3171 | @defvar buffer-auto-save-file-format | |
3172 | This variable specifies the format to use for auto-saving. Its value is | |
3173 | a list of format names, just like the value of | |
3174 | @code{buffer-file-format}; however, it is used instead of | |
3175 | @code{buffer-file-format} for writing auto-save files. If the value | |
3176 | is @code{t}, the default, auto-saving uses the same format as a | |
3177 | regular save in the same buffer. This variable is always buffer-local | |
3178 | in all buffers. | |
3179 | @end defvar | |
3180 | ||
3181 | @node Format Conversion Piecemeal | |
3182 | @subsection Piecemeal Specification | |
3183 | ||
3184 | In contrast to the round-trip specification described in the previous | |
3185 | subsection (@pxref{Format Conversion Round-Trip}), you can use the variables | |
3186 | @code{after-insert-file-functions} and @code{write-region-annotate-functions} | |
3187 | to separately control the respective reading and writing conversions. | |
3188 | ||
3189 | Conversion starts with one representation and produces another | |
3190 | representation. When there is only one conversion to do, there is no | |
3191 | conflict about what to start with. However, when there are multiple | |
3192 | conversions involved, conflict may arise when two conversions need to | |
3193 | start with the same data. | |
3194 | ||
3195 | This situation is best understood in the context of converting text | |
3196 | properties during @code{write-region}. For example, the character at | |
3197 | position 42 in a buffer is @samp{X} with a text property @code{foo}. If | |
3198 | the conversion for @code{foo} is done by inserting into the buffer, say, | |
3199 | @samp{FOO:}, then that changes the character at position 42 from | |
3200 | @samp{X} to @samp{F}. The next conversion will start with the wrong | |
3201 | data straight away. | |
3202 | ||
3203 | To avoid conflict, cooperative conversions do not modify the buffer, | |
3204 | but instead specify @dfn{annotations}, a list of elements of the form | |
3205 | @code{(@var{position} . @var{string})}, sorted in order of increasing | |
3206 | @var{position}. | |
3207 | ||
3208 | If there is more than one conversion, @code{write-region} merges their | |
3209 | annotations destructively into one sorted list. Later, when the text | |
3210 | from the buffer is actually written to the file, it intermixes the | |
3211 | specified annotations at the corresponding positions. All this takes | |
3212 | place without modifying the buffer. | |
3213 | ||
3214 | @c ??? What about ``overriding'' conversions like those allowed | |
3215 | @c ??? for `write-region-annotate-functions', below? --ttn | |
3216 | ||
3217 | In contrast, when reading, the annotations intermixed with the text | |
ae12425c CY |
3218 | are handled immediately. @code{insert-file-contents} sets point to |
3219 | the beginning of some text to be converted, then calls the conversion | |
b8d4c8d0 | 3220 | functions with the length of that text. These functions should always |
ae12425c CY |
3221 | return with point at the beginning of the inserted text. This |
3222 | approach makes sense for reading because annotations removed by the | |
3223 | first converter can't be mistakenly processed by a later converter. | |
3224 | Each conversion function should scan for the annotations it | |
3225 | recognizes, remove the annotation, modify the buffer text (to set a | |
3226 | text property, for example), and return the updated length of the | |
3227 | text, as it stands after those changes. The value returned by one | |
3228 | function becomes the argument to the next function. | |
b8d4c8d0 GM |
3229 | |
3230 | @defvar write-region-annotate-functions | |
3231 | A list of functions for @code{write-region} to call. Each function in | |
3232 | the list is called with two arguments: the start and end of the region | |
3233 | to be written. These functions should not alter the contents of the | |
3234 | buffer. Instead, they should return annotations. | |
3235 | ||
ae12425c CY |
3236 | As a special case, a function may return with a different buffer |
3237 | current. Emacs takes this to mean that the current buffer contains | |
3238 | altered text to be output. It therefore changes the @var{start} and | |
3239 | @var{end} arguments of the @code{write-region} call, giving them the | |
3240 | values of @code{point-min} and @code{point-max} in the new buffer, | |
3241 | respectively. It also discards all previous annotations, because they | |
3242 | should have been dealt with by this function. | |
3243 | @end defvar | |
3244 | ||
3245 | @defvar write-region-post-annotation-function | |
3246 | The value of this variable, if non-@code{nil}, should be a function. | |
3247 | This function is called, with no arguments, after @code{write-region} | |
3248 | has completed. | |
3249 | ||
3250 | If any function in @code{write-region-annotate-functions} returns with | |
3251 | a different buffer current, Emacs calls | |
3252 | @code{write-region-post-annotation-function} more than once. Emacs | |
3253 | calls it with the last buffer that was current, and again with the | |
3254 | buffer before that, and so on back to the original buffer. | |
3255 | ||
3256 | Thus, a function in @code{write-region-annotate-functions} can create | |
3257 | a buffer, give this variable the local value of @code{kill-buffer} in | |
3258 | that buffer, set up the buffer with altered text, and make the buffer | |
3259 | current. The buffer will be killed after @code{write-region} is done. | |
b8d4c8d0 GM |
3260 | @end defvar |
3261 | ||
3262 | @defvar after-insert-file-functions | |
3263 | Each function in this list is called by @code{insert-file-contents} | |
3264 | with one argument, the number of characters inserted, and with point | |
3265 | at the beginning of the inserted text. Each function should leave | |
3266 | point unchanged, and return the new character count describing the | |
3267 | inserted text as modified by the function. | |
3268 | @c ??? The docstring mentions a handler from `file-name-handler-alist' | |
3269 | @c "intercepting" `insert-file-contents'. Hmmm. --ttn | |
3270 | @end defvar | |
3271 | ||
3272 | We invite users to write Lisp programs to store and retrieve text | |
3273 | properties in files, using these hooks, and thus to experiment with | |
3274 | various data formats and find good ones. Eventually we hope users | |
3275 | will produce good, general extensions we can install in Emacs. | |
3276 | ||
3277 | We suggest not trying to handle arbitrary Lisp objects as text property | |
3278 | names or values---because a program that general is probably difficult | |
3279 | to write, and slow. Instead, choose a set of possible data types that | |
3280 | are reasonably flexible, and not too hard to encode. |