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