Commit | Line | Data |
---|---|---|
a44af9f2 RS |
1 | @c -*-texinfo-*- |
2 | @c This is part of the GNU Emacs Lisp Reference Manual. | |
651f374c TTN |
3 | @c Copyright (C) 1990, 1991, 1992, 1993, 1998, 1999, 2002, 2003, 2004, |
4 | @c 2005 Free Software Foundation, Inc. | |
a44af9f2 RS |
5 | @c See the file elisp.texi for copying conditions. |
6 | @setfilename ../info/internals | |
7 | @node GNU Emacs Internals, Standard Errors, Tips, Top | |
8 | @comment node-name, next, previous, up | |
9 | @appendix GNU Emacs Internals | |
10 | ||
11 | This chapter describes how the runnable Emacs executable is dumped with | |
12 | the preloaded Lisp libraries in it, how storage is allocated, and some | |
13 | internal aspects of GNU Emacs that may be of interest to C programmers. | |
14 | ||
15 | @menu | |
2a233172 | 16 | * Building Emacs:: How the dumped Emacs is made. |
a44af9f2 RS |
17 | * Pure Storage:: A kludge to make preloaded Lisp functions sharable. |
18 | * Garbage Collection:: Reclaiming space for Lisp objects no longer used. | |
969fe9b5 | 19 | * Memory Usage:: Info about total size of Lisp objects made so far. |
a44af9f2 RS |
20 | * Writing Emacs Primitives:: Writing C code for Emacs. |
21 | * Object Internals:: Data formats of buffers, windows, processes. | |
22 | @end menu | |
23 | ||
969fe9b5 | 24 | @node Building Emacs |
a44af9f2 RS |
25 | @appendixsec Building Emacs |
26 | @cindex building Emacs | |
27 | @pindex temacs | |
28 | ||
29 | This section explains the steps involved in building the Emacs | |
30 | executable. You don't have to know this material to build and install | |
31 | Emacs, since the makefiles do all these things automatically. This | |
32 | information is pertinent to Emacs maintenance. | |
33 | ||
34 | Compilation of the C source files in the @file{src} directory | |
35 | produces an executable file called @file{temacs}, also called a | |
36 | @dfn{bare impure Emacs}. It contains the Emacs Lisp interpreter and I/O | |
37 | routines, but not the editing commands. | |
38 | ||
39 | @cindex @file{loadup.el} | |
40 | The command @w{@samp{temacs -l loadup}} uses @file{temacs} to create | |
41 | the real runnable Emacs executable. These arguments direct | |
42 | @file{temacs} to evaluate the Lisp files specified in the file | |
43 | @file{loadup.el}. These files set up the normal Emacs editing | |
574efc83 | 44 | environment, resulting in an Emacs that is still impure but no longer |
a44af9f2 RS |
45 | bare. |
46 | ||
47 | It takes a substantial time to load the standard Lisp files. Luckily, | |
48 | you don't have to do this each time you run Emacs; @file{temacs} can | |
574efc83 | 49 | dump out an executable program called @file{emacs} that has these files |
a44af9f2 RS |
50 | preloaded. @file{emacs} starts more quickly because it does not need to |
51 | load the files. This is the Emacs executable that is normally | |
52 | installed. | |
53 | ||
54 | To create @file{emacs}, use the command @samp{temacs -batch -l loadup | |
55 | dump}. The purpose of @samp{-batch} here is to prevent @file{temacs} | |
56 | from trying to initialize any of its data on the terminal; this ensures | |
57 | that the tables of terminal information are empty in the dumped Emacs. | |
58 | The argument @samp{dump} tells @file{loadup.el} to dump a new executable | |
59 | named @file{emacs}. | |
60 | ||
61 | Some operating systems don't support dumping. On those systems, you | |
62 | must start Emacs with the @samp{temacs -l loadup} command each time you | |
a890e1b0 RS |
63 | use it. This takes a substantial time, but since you need to start |
64 | Emacs once a day at most---or once a week if you never log out---the | |
65 | extra time is not too severe a problem. | |
a44af9f2 RS |
66 | |
67 | @cindex @file{site-load.el} | |
95260b26 | 68 | |
a44af9f2 | 69 | You can specify additional files to preload by writing a library named |
95260b26 GM |
70 | @file{site-load.el} that loads them. You may need to add a definition |
71 | ||
72 | @example | |
73 | #define SITELOAD_PURESIZE_EXTRA @var{n} | |
74 | @end example | |
75 | ||
76 | @noindent | |
77 | to make @var{n} added bytes of pure space to hold the additional files. | |
78 | (Try adding increments of 20000 until it is big enough.) However, the | |
79 | advantage of preloading additional files decreases as machines get | |
80 | faster. On modern machines, it is usually not advisable. | |
a44af9f2 | 81 | |
2a664e73 RS |
82 | After @file{loadup.el} reads @file{site-load.el}, it finds the |
83 | documentation strings for primitive and preloaded functions (and | |
568ffbee LT |
84 | variables) in the file @file{etc/DOC} where they are stored, by |
85 | calling @code{Snarf-documentation} (@pxref{Definition of | |
86 | Snarf-documentation,, Accessing Documentation}). | |
2a664e73 | 87 | |
a44af9f2 | 88 | @cindex @file{site-init.el} |
a890e1b0 | 89 | You can specify other Lisp expressions to execute just before dumping |
2a664e73 RS |
90 | by putting them in a library named @file{site-init.el}. This file is |
91 | executed after the documentation strings are found. | |
a44af9f2 | 92 | |
2a664e73 RS |
93 | If you want to preload function or variable definitions, there are |
94 | three ways you can do this and make their documentation strings | |
95 | accessible when you subsequently run Emacs: | |
96 | ||
97 | @itemize @bullet | |
98 | @item | |
99 | Arrange to scan these files when producing the @file{etc/DOC} file, | |
100 | and load them with @file{site-load.el}. | |
101 | ||
102 | @item | |
103 | Load the files with @file{site-init.el}, then copy the files into the | |
104 | installation directory for Lisp files when you install Emacs. | |
105 | ||
106 | @item | |
107 | Specify a non-@code{nil} value for | |
8241495d | 108 | @code{byte-compile-dynamic-docstrings} as a local variable in each of these |
2a664e73 RS |
109 | files, and load them with either @file{site-load.el} or |
110 | @file{site-init.el}. (This method has the drawback that the | |
111 | documentation strings take up space in Emacs all the time.) | |
112 | @end itemize | |
113 | ||
114 | It is not advisable to put anything in @file{site-load.el} or | |
115 | @file{site-init.el} that would alter any of the features that users | |
116 | expect in an ordinary unmodified Emacs. If you feel you must override | |
117 | normal features for your site, do it with @file{default.el}, so that | |
8241495d | 118 | users can override your changes if they wish. @xref{Startup Summary}. |
a44af9f2 | 119 | |
55f77e1c RS |
120 | In a package that can be preloaded, it is sometimes useful to |
121 | specify a computation to be done when Emacs subsequently starts up. | |
122 | For this, use @code{eval-at-startup}: | |
123 | ||
6d1e17be | 124 | @defmac eval-at-startup body@dots{} |
55f77e1c RS |
125 | This evaluates the @var{body} forms, either immediately if running in |
126 | an Emacs that has already started up, or later when Emacs does start | |
127 | up. Since the value of the @var{body} forms is not necessarily | |
128 | available when the @code{eval-at-startup} form is run, that form | |
129 | always returns @code{nil}. | |
6d1e17be | 130 | @end defmac |
55f77e1c | 131 | |
a44af9f2 RS |
132 | @defun dump-emacs to-file from-file |
133 | @cindex unexec | |
cb017dde | 134 | This function dumps the current state of Emacs into an executable file |
a44af9f2 RS |
135 | @var{to-file}. It takes symbols from @var{from-file} (this is normally |
136 | the executable file @file{temacs}). | |
137 | ||
cb017dde RS |
138 | If you want to use this function in an Emacs that was already dumped, |
139 | you must run Emacs with @samp{-batch}. | |
a44af9f2 RS |
140 | @end defun |
141 | ||
969fe9b5 | 142 | @node Pure Storage |
a44af9f2 RS |
143 | @appendixsec Pure Storage |
144 | @cindex pure storage | |
145 | ||
a890e1b0 RS |
146 | Emacs Lisp uses two kinds of storage for user-created Lisp objects: |
147 | @dfn{normal storage} and @dfn{pure storage}. Normal storage is where | |
8241495d | 148 | all the new data created during an Emacs session are kept; see the |
574efc83 RS |
149 | following section for information on normal storage. Pure storage is |
150 | used for certain data in the preloaded standard Lisp files---data that | |
151 | should never change during actual use of Emacs. | |
a44af9f2 RS |
152 | |
153 | Pure storage is allocated only while @file{temacs} is loading the | |
154 | standard preloaded Lisp libraries. In the file @file{emacs}, it is | |
574efc83 | 155 | marked as read-only (on operating systems that permit this), so that |
a44af9f2 RS |
156 | the memory space can be shared by all the Emacs jobs running on the |
157 | machine at once. Pure storage is not expandable; a fixed amount is | |
158 | allocated when Emacs is compiled, and if that is not sufficient for the | |
a890e1b0 RS |
159 | preloaded libraries, @file{temacs} crashes. If that happens, you must |
160 | increase the compilation parameter @code{PURESIZE} in the file | |
a44af9f2 RS |
161 | @file{src/puresize.h}. This normally won't happen unless you try to |
162 | preload additional libraries or add features to the standard ones. | |
163 | ||
164 | @defun purecopy object | |
8241495d RS |
165 | This function makes a copy in pure storage of @var{object}, and returns |
166 | it. It copies a string by simply making a new string with the same | |
568ffbee LT |
167 | characters, but without text properties, in pure storage. It |
168 | recursively copies the contents of vectors and cons cells. It does | |
169 | not make copies of other objects such as symbols, but just returns | |
170 | them unchanged. It signals an error if asked to copy markers. | |
a44af9f2 | 171 | |
c2cd5fb7 RS |
172 | This function is a no-op except while Emacs is being built and dumped; |
173 | it is usually called only in the file @file{emacs/lisp/loaddefs.el}, but | |
174 | a few packages call it just in case you decide to preload them. | |
a44af9f2 RS |
175 | @end defun |
176 | ||
177 | @defvar pure-bytes-used | |
a890e1b0 | 178 | The value of this variable is the number of bytes of pure storage |
a44af9f2 RS |
179 | allocated so far. Typically, in a dumped Emacs, this number is very |
180 | close to the total amount of pure storage available---if it were not, | |
181 | we would preallocate less. | |
182 | @end defvar | |
183 | ||
184 | @defvar purify-flag | |
a890e1b0 | 185 | This variable determines whether @code{defun} should make a copy of the |
a44af9f2 RS |
186 | function definition in pure storage. If it is non-@code{nil}, then the |
187 | function definition is copied into pure storage. | |
188 | ||
a890e1b0 | 189 | This flag is @code{t} while loading all of the basic functions for |
a44af9f2 | 190 | building Emacs initially (allowing those functions to be sharable and |
a890e1b0 RS |
191 | non-collectible). Dumping Emacs as an executable always writes |
192 | @code{nil} in this variable, regardless of the value it actually has | |
193 | before and after dumping. | |
a44af9f2 | 194 | |
a890e1b0 | 195 | You should not change this flag in a running Emacs. |
a44af9f2 RS |
196 | @end defvar |
197 | ||
969fe9b5 | 198 | @node Garbage Collection |
a44af9f2 RS |
199 | @appendixsec Garbage Collection |
200 | @cindex garbage collector | |
201 | ||
202 | @cindex memory allocation | |
203 | When a program creates a list or the user defines a new function (such | |
a890e1b0 RS |
204 | as by loading a library), that data is placed in normal storage. If |
205 | normal storage runs low, then Emacs asks the operating system to | |
a44af9f2 | 206 | allocate more memory in blocks of 1k bytes. Each block is used for one |
a890e1b0 RS |
207 | type of Lisp object, so symbols, cons cells, markers, etc., are |
208 | segregated in distinct blocks in memory. (Vectors, long strings, | |
209 | buffers and certain other editing types, which are fairly large, are | |
210 | allocated in individual blocks, one per object, while small strings are | |
211 | packed into blocks of 8k bytes.) | |
212 | ||
213 | It is quite common to use some storage for a while, then release it by | |
214 | (for example) killing a buffer or deleting the last pointer to an | |
a44af9f2 RS |
215 | object. Emacs provides a @dfn{garbage collector} to reclaim this |
216 | abandoned storage. (This name is traditional, but ``garbage recycler'' | |
217 | might be a more intuitive metaphor for this facility.) | |
218 | ||
a890e1b0 RS |
219 | The garbage collector operates by finding and marking all Lisp objects |
220 | that are still accessible to Lisp programs. To begin with, it assumes | |
221 | all the symbols, their values and associated function definitions, and | |
574efc83 | 222 | any data presently on the stack, are accessible. Any objects that can |
a890e1b0 RS |
223 | be reached indirectly through other accessible objects are also |
224 | accessible. | |
a44af9f2 | 225 | |
a890e1b0 | 226 | When marking is finished, all objects still unmarked are garbage. No |
a44af9f2 | 227 | matter what the Lisp program or the user does, it is impossible to refer |
a890e1b0 | 228 | to them, since there is no longer a way to reach them. Their space |
574efc83 RS |
229 | might as well be reused, since no one will miss them. The second |
230 | (``sweep'') phase of the garbage collector arranges to reuse them. | |
a44af9f2 | 231 | |
05aea714 | 232 | @c ??? Maybe add something describing weak hash tables here? |
95260b26 | 233 | |
a44af9f2 | 234 | @cindex free list |
a890e1b0 RS |
235 | The sweep phase puts unused cons cells onto a @dfn{free list} |
236 | for future allocation; likewise for symbols and markers. It compacts | |
237 | the accessible strings so they occupy fewer 8k blocks; then it frees the | |
574efc83 | 238 | other 8k blocks. Vectors, buffers, windows, and other large objects are |
a890e1b0 | 239 | individually allocated and freed using @code{malloc} and @code{free}. |
a44af9f2 RS |
240 | |
241 | @cindex CL note---allocate more storage | |
242 | @quotation | |
574efc83 | 243 | @b{Common Lisp note:} Unlike other Lisps, GNU Emacs Lisp does not |
a44af9f2 RS |
244 | call the garbage collector when the free list is empty. Instead, it |
245 | simply requests the operating system to allocate more storage, and | |
246 | processing continues until @code{gc-cons-threshold} bytes have been | |
247 | used. | |
248 | ||
249 | This means that you can make sure that the garbage collector will not | |
250 | run during a certain portion of a Lisp program by calling the garbage | |
251 | collector explicitly just before it (provided that portion of the | |
252 | program does not use so much space as to force a second garbage | |
253 | collection). | |
254 | @end quotation | |
255 | ||
256 | @deffn Command garbage-collect | |
a890e1b0 | 257 | This command runs a garbage collection, and returns information on |
a44af9f2 RS |
258 | the amount of space in use. (Garbage collection can also occur |
259 | spontaneously if you use more than @code{gc-cons-threshold} bytes of | |
260 | Lisp data since the previous garbage collection.) | |
261 | ||
a890e1b0 | 262 | @code{garbage-collect} returns a list containing the following |
a44af9f2 RS |
263 | information: |
264 | ||
a890e1b0 | 265 | @example |
a44af9f2 RS |
266 | @group |
267 | ((@var{used-conses} . @var{free-conses}) | |
268 | (@var{used-syms} . @var{free-syms}) | |
a890e1b0 | 269 | @end group |
969fe9b5 | 270 | (@var{used-miscs} . @var{free-miscs}) |
40d48fe9 | 271 | @var{used-string-chars} |
a44af9f2 | 272 | @var{used-vector-slots} |
f9f59935 | 273 | (@var{used-floats} . @var{free-floats}) |
40d48fe9 EZ |
274 | (@var{used-intervals} . @var{free-intervals}) |
275 | (@var{used-strings} . @var{free-strings})) | |
969fe9b5 RS |
276 | @end example |
277 | ||
278 | Here is an example: | |
279 | ||
280 | @example | |
a890e1b0 | 281 | @group |
a44af9f2 | 282 | (garbage-collect) |
f9f59935 RS |
283 | @result{} ((106886 . 13184) (9769 . 0) |
284 | (7731 . 4651) 347543 121628 | |
40d48fe9 EZ |
285 | (31 . 94) (1273 . 168) |
286 | (25474 . 3569)) | |
a44af9f2 | 287 | @end group |
a890e1b0 | 288 | @end example |
a44af9f2 RS |
289 | |
290 | Here is a table explaining each element: | |
291 | ||
292 | @table @var | |
293 | @item used-conses | |
294 | The number of cons cells in use. | |
295 | ||
296 | @item free-conses | |
297 | The number of cons cells for which space has been obtained from the | |
298 | operating system, but that are not currently being used. | |
299 | ||
300 | @item used-syms | |
301 | The number of symbols in use. | |
302 | ||
303 | @item free-syms | |
304 | The number of symbols for which space has been obtained from the | |
305 | operating system, but that are not currently being used. | |
306 | ||
969fe9b5 RS |
307 | @item used-miscs |
308 | The number of miscellaneous objects in use. These include markers and | |
309 | overlays, plus certain objects not visible to users. | |
a44af9f2 | 310 | |
969fe9b5 RS |
311 | @item free-miscs |
312 | The number of miscellaneous objects for which space has been obtained | |
313 | from the operating system, but that are not currently being used. | |
a44af9f2 RS |
314 | |
315 | @item used-string-chars | |
316 | The total size of all strings, in characters. | |
317 | ||
318 | @item used-vector-slots | |
319 | The total number of elements of existing vectors. | |
320 | ||
321 | @item used-floats | |
322 | @c Emacs 19 feature | |
323 | The number of floats in use. | |
324 | ||
325 | @item free-floats | |
326 | @c Emacs 19 feature | |
327 | The number of floats for which space has been obtained from the | |
328 | operating system, but that are not currently being used. | |
a9f0a989 RS |
329 | |
330 | @item used-intervals | |
331 | The number of intervals in use. Intervals are an internal | |
332 | data structure used for representing text properties. | |
333 | ||
334 | @item free-intervals | |
335 | The number of intervals for which space has been obtained | |
336 | from the operating system, but that are not currently being used. | |
40d48fe9 EZ |
337 | |
338 | @item used-strings | |
339 | The number of strings in use. | |
340 | ||
341 | @item free-strings | |
342 | The number of string headers for which the space was obtained from the | |
343 | operating system, but which are currently not in use. (A string | |
344 | object consists of a header and the storage for the string text | |
345 | itself; the latter is only allocated when the string is created.) | |
a44af9f2 RS |
346 | @end table |
347 | @end deffn | |
348 | ||
d64c55d8 RS |
349 | @defopt garbage-collection-messages |
350 | If this variable is non-@code{nil}, Emacs displays a message at the | |
351 | beginning and end of garbage collection. The default value is | |
352 | @code{nil}, meaning there are no such messages. | |
353 | @end defopt | |
354 | ||
e73c3ec4 RS |
355 | @defvar post-gc-hook |
356 | This is a normal hook that is run at the end of garbage collection. | |
357 | Garbage collection is inhibited while the hook functions run, so be | |
358 | careful writing them. | |
359 | @end defvar | |
360 | ||
a44af9f2 | 361 | @defopt gc-cons-threshold |
a890e1b0 | 362 | The value of this variable is the number of bytes of storage that must |
a44af9f2 | 363 | be allocated for Lisp objects after one garbage collection in order to |
a890e1b0 | 364 | trigger another garbage collection. A cons cell counts as eight bytes, |
a44af9f2 | 365 | a string as one byte per character plus a few bytes of overhead, and so |
a890e1b0 RS |
366 | on; space allocated to the contents of buffers does not count. Note |
367 | that the subsequent garbage collection does not happen immediately when | |
368 | the threshold is exhausted, but only the next time the Lisp evaluator is | |
a44af9f2 RS |
369 | called. |
370 | ||
f9f59935 | 371 | The initial threshold value is 400,000. If you specify a larger |
a44af9f2 RS |
372 | value, garbage collection will happen less often. This reduces the |
373 | amount of time spent garbage collecting, but increases total memory use. | |
574efc83 | 374 | You may want to do this when running a program that creates lots of |
a44af9f2 RS |
375 | Lisp data. |
376 | ||
a890e1b0 | 377 | You can make collections more frequent by specifying a smaller value, |
a44af9f2 RS |
378 | down to 10,000. A value less than 10,000 will remain in effect only |
379 | until the subsequent garbage collection, at which time | |
380 | @code{garbage-collect} will set the threshold back to 10,000. | |
0c17e67c SM |
381 | @end defopt |
382 | ||
383 | @defopt gc-cons-percentage | |
6696f2a4 RS |
384 | The value of this variable specifies the amount of consing before a |
385 | garbage collection occurs, as a fraction of the current heap size. | |
386 | This criterion and @code{gc-cons-threshold} apply in parallel, and | |
387 | garbage collection occurs only when both criteria are satisfied. | |
0c17e67c SM |
388 | |
389 | As the heap size increases, the time to perform a garbage collection | |
6696f2a4 RS |
390 | increases. Thus, it can be desirable to do them less frequently in |
391 | proportion. | |
a44af9f2 RS |
392 | @end defopt |
393 | ||
568ffbee | 394 | The value returned by @code{garbage-collect} describes the amount of |
969fe9b5 RS |
395 | memory used by Lisp data, broken down by data type. By contrast, the |
396 | function @code{memory-limit} provides information on the total amount of | |
397 | memory Emacs is currently using. | |
398 | ||
a44af9f2 RS |
399 | @c Emacs 19 feature |
400 | @defun memory-limit | |
401 | This function returns the address of the last byte Emacs has allocated, | |
402 | divided by 1024. We divide the value by 1024 to make sure it fits in a | |
403 | Lisp integer. | |
404 | ||
405 | You can use this to get a general idea of how your actions affect the | |
406 | memory usage. | |
407 | @end defun | |
408 | ||
3c4c00e6 RS |
409 | @defvar memory-full |
410 | This variable is @code{t} if Emacs is close to out of memory for Lisp | |
411 | objects, and @code{nil} otherwise. | |
412 | @end defvar | |
413 | ||
5b2279a3 RS |
414 | @defun memory-use-counts |
415 | This returns a list of numbers that count the number of objects | |
416 | created in this Emacs session. Each of these counters increments for | |
417 | a certain kind of object. See the documentation string for details. | |
418 | @end defun | |
419 | ||
66c0f054 RS |
420 | @defvar gcs-done |
421 | This variable contains the total number of garbage collections | |
422 | done so far in this Emacs session. | |
f0514b34 | 423 | @end defvar |
66c0f054 RS |
424 | |
425 | @defvar gc-elapsed | |
426 | This variable contains the total number of seconds of elapsed time | |
427 | during garbage collection so far in this Emacs session, as a floating | |
428 | point number. | |
f0514b34 | 429 | @end defvar |
66c0f054 | 430 | |
969fe9b5 RS |
431 | @node Memory Usage |
432 | @section Memory Usage | |
433 | ||
434 | These functions and variables give information about the total amount | |
435 | of memory allocation that Emacs has done, broken down by data type. | |
436 | Note the difference between these and the values returned by | |
437 | @code{(garbage-collect)}; those count objects that currently exist, but | |
438 | these count the number or size of all allocations, including those for | |
439 | objects that have since been freed. | |
440 | ||
441 | @defvar cons-cells-consed | |
442 | The total number of cons cells that have been allocated so far | |
443 | in this Emacs session. | |
444 | @end defvar | |
445 | ||
446 | @defvar floats-consed | |
447 | The total number of floats that have been allocated so far | |
448 | in this Emacs session. | |
449 | @end defvar | |
450 | ||
451 | @defvar vector-cells-consed | |
452 | The total number of vector cells that have been allocated so far | |
453 | in this Emacs session. | |
454 | @end defvar | |
455 | ||
456 | @defvar symbols-consed | |
457 | The total number of symbols that have been allocated so far | |
458 | in this Emacs session. | |
459 | @end defvar | |
460 | ||
461 | @defvar string-chars-consed | |
462 | The total number of string characters that have been allocated so far | |
463 | in this Emacs session. | |
464 | @end defvar | |
465 | ||
466 | @defvar misc-objects-consed | |
467 | The total number of miscellaneous objects that have been allocated so | |
468 | far in this Emacs session. These include markers and overlays, plus | |
469 | certain objects not visible to users. | |
470 | @end defvar | |
471 | ||
472 | @defvar intervals-consed | |
473 | The total number of intervals that have been allocated so far | |
474 | in this Emacs session. | |
475 | @end defvar | |
476 | ||
40d48fe9 EZ |
477 | @defvar strings-consed |
478 | The total number of strings that have been allocated so far in this | |
479 | Emacs session. | |
480 | @end defvar | |
481 | ||
969fe9b5 | 482 | @node Writing Emacs Primitives |
a44af9f2 RS |
483 | @appendixsec Writing Emacs Primitives |
484 | @cindex primitive function internals | |
485 | ||
486 | Lisp primitives are Lisp functions implemented in C. The details of | |
487 | interfacing the C function so that Lisp can call it are handled by a few | |
488 | C macros. The only way to really understand how to write new C code is | |
489 | to read the source, but we can explain some things here. | |
490 | ||
491 | An example of a special form is the definition of @code{or}, from | |
492 | @file{eval.c}. (An ordinary function would have the same general | |
493 | appearance.) | |
494 | ||
495 | @cindex garbage collection protection | |
496 | @smallexample | |
497 | @group | |
498 | DEFUN ("or", For, Sor, 0, UNEVALLED, 0, | |
f1842270 RS |
499 | doc: /* Eval args until one of them yields non-nil, then return that value. |
500 | The remaining args are not evalled at all. | |
501 | If all args return nil, return nil. | |
a44af9f2 RS |
502 | @end group |
503 | @group | |
f1842270 | 504 | usage: (or CONDITIONS ...) */) |
a44af9f2 RS |
505 | (args) |
506 | Lisp_Object args; | |
507 | @{ | |
51485df2 | 508 | register Lisp_Object val = Qnil; |
a44af9f2 RS |
509 | struct gcpro gcpro1; |
510 | @end group | |
511 | ||
512 | @group | |
51485df2 | 513 | GCPRO1 (args); |
a44af9f2 RS |
514 | @end group |
515 | ||
516 | @group | |
51485df2 | 517 | while (CONSP (args)) |
a44af9f2 | 518 | @{ |
51485df2 | 519 | val = Feval (XCAR (args)); |
95260b26 | 520 | if (!NILP (val)) |
51485df2 RS |
521 | break; |
522 | args = XCDR (args); | |
a44af9f2 | 523 | @} |
a44af9f2 RS |
524 | @end group |
525 | ||
526 | @group | |
527 | UNGCPRO; | |
528 | return val; | |
529 | @} | |
530 | @end group | |
531 | @end smallexample | |
532 | ||
533 | Let's start with a precise explanation of the arguments to the | |
a890e1b0 | 534 | @code{DEFUN} macro. Here is a template for them: |
a44af9f2 RS |
535 | |
536 | @example | |
537 | DEFUN (@var{lname}, @var{fname}, @var{sname}, @var{min}, @var{max}, @var{interactive}, @var{doc}) | |
538 | @end example | |
539 | ||
540 | @table @var | |
541 | @item lname | |
a890e1b0 RS |
542 | This is the name of the Lisp symbol to define as the function name; in |
543 | the example above, it is @code{or}. | |
a44af9f2 RS |
544 | |
545 | @item fname | |
546 | This is the C function name for this function. This is | |
547 | the name that is used in C code for calling the function. The name is, | |
548 | by convention, @samp{F} prepended to the Lisp name, with all dashes | |
549 | (@samp{-}) in the Lisp name changed to underscores. Thus, to call this | |
550 | function from C code, call @code{For}. Remember that the arguments must | |
551 | be of type @code{Lisp_Object}; various macros and functions for creating | |
552 | values of type @code{Lisp_Object} are declared in the file | |
553 | @file{lisp.h}. | |
554 | ||
555 | @item sname | |
556 | This is a C variable name to use for a structure that holds the data for | |
557 | the subr object that represents the function in Lisp. This structure | |
558 | conveys the Lisp symbol name to the initialization routine that will | |
559 | create the symbol and store the subr object as its definition. By | |
560 | convention, this name is always @var{fname} with @samp{F} replaced with | |
561 | @samp{S}. | |
562 | ||
563 | @item min | |
a890e1b0 RS |
564 | This is the minimum number of arguments that the function requires. The |
565 | function @code{or} allows a minimum of zero arguments. | |
a44af9f2 RS |
566 | |
567 | @item max | |
a890e1b0 RS |
568 | This is the maximum number of arguments that the function accepts, if |
569 | there is a fixed maximum. Alternatively, it can be @code{UNEVALLED}, | |
570 | indicating a special form that receives unevaluated arguments, or | |
571 | @code{MANY}, indicating an unlimited number of evaluated arguments (the | |
572 | equivalent of @code{&rest}). Both @code{UNEVALLED} and @code{MANY} are | |
573 | macros. If @var{max} is a number, it may not be less than @var{min} and | |
51485df2 | 574 | it may not be greater than eight. |
a44af9f2 RS |
575 | |
576 | @item interactive | |
577 | This is an interactive specification, a string such as might be used as | |
578 | the argument of @code{interactive} in a Lisp function. In the case of | |
579 | @code{or}, it is 0 (a null pointer), indicating that @code{or} cannot be | |
a890e1b0 RS |
580 | called interactively. A value of @code{""} indicates a function that |
581 | should receive no arguments when called interactively. | |
a44af9f2 RS |
582 | |
583 | @item doc | |
f1842270 RS |
584 | This is the documentation string. It uses C comment syntax rather |
585 | than C string syntax because comment syntax requires nothing special | |
586 | to include multiple lines. The @samp{doc:} identifies the comment | |
587 | that follows as the documentation string. The @samp{/*} and @samp{*/} | |
588 | delimiters that begin and end the comment are not part of the | |
589 | documentation string. | |
590 | ||
591 | If the last line of the documentation string begins with the keyword | |
592 | @samp{usage:}, the rest of the line is treated as the argument list | |
593 | for documentation purposes. This way, you can use different argument | |
594 | names in the documentation string from the ones used in the C code. | |
0a692803 DL |
595 | @samp{usage:} is required if the function has an unlimited number of |
596 | arguments. | |
f1842270 RS |
597 | |
598 | All the usual rules for documentation strings in Lisp code | |
599 | (@pxref{Documentation Tips}) apply to C code documentation strings | |
600 | too. | |
a44af9f2 RS |
601 | @end table |
602 | ||
a890e1b0 RS |
603 | After the call to the @code{DEFUN} macro, you must write the argument |
604 | name list that every C function must have, followed by ordinary C | |
605 | declarations for the arguments. For a function with a fixed maximum | |
606 | number of arguments, declare a C argument for each Lisp argument, and | |
574efc83 RS |
607 | give them all type @code{Lisp_Object}. When a Lisp function has no |
608 | upper limit on the number of arguments, its implementation in C actually | |
609 | receives exactly two arguments: the first is the number of Lisp | |
610 | arguments, and the second is the address of a block containing their | |
611 | values. They have types @code{int} and @w{@code{Lisp_Object *}}. | |
a44af9f2 RS |
612 | |
613 | Within the function @code{For} itself, note the use of the macros | |
614 | @code{GCPRO1} and @code{UNGCPRO}. @code{GCPRO1} is used to ``protect'' | |
615 | a variable from garbage collection---to inform the garbage collector that | |
616 | it must look in that variable and regard its contents as an accessible | |
617 | object. This is necessary whenever you call @code{Feval} or anything | |
618 | that can directly or indirectly call @code{Feval}. At such a time, any | |
619 | Lisp object that you intend to refer to again must be protected somehow. | |
620 | @code{UNGCPRO} cancels the protection of the variables that are | |
621 | protected in the current function. It is necessary to do this explicitly. | |
622 | ||
70bb4402 RS |
623 | It suffices to ensure that at least one pointer to each object is |
624 | GC-protected; as long as the object is not recycled, all pointers to | |
625 | it remain valid. So if you are sure that a local variable points to | |
626 | an object that will be preserved by some other pointer, that local | |
568ffbee LT |
627 | variable does not need a @code{GCPRO}. (Formerly, strings were an |
628 | exception to this rule; in older Emacs versions, every pointer to a | |
629 | string needed to be marked by GC.) | |
70bb4402 RS |
630 | |
631 | The macro @code{GCPRO1} protects just one local variable. If you | |
632 | want to protect two, use @code{GCPRO2} instead; repeating | |
633 | @code{GCPRO1} will not work. Macros, @code{GCPRO3}, @code{GCPRO4}, | |
634 | @code{GCPRO5}, and @code{GCPRO6} also exist. These macros implicitly | |
635 | use local variables such as @code{gcpro1}; you must declare these | |
636 | explicitly, with type @code{struct gcpro}. Thus, if you use | |
637 | @code{GCPRO2}, you must declare @code{gcpro1} and @code{gcpro2}. | |
a890e1b0 RS |
638 | Alas, we can't explain all the tricky details here. |
639 | ||
70bb4402 RS |
640 | Built-in functions that take a variable number of arguments actually |
641 | accept two arguments at the C level: the number of Lisp arguments, and | |
642 | a @code{Lisp_Object *} pointer to a C vector containing those Lisp | |
643 | arguments. This C vector may be part of a Lisp vector, but it need | |
568ffbee | 644 | not be. The responsibility for using @code{GCPRO} to protect the Lisp |
236a1914 RS |
645 | arguments from GC if necessary rests with the caller in this case, |
646 | since the caller allocated or found the storage for them. | |
70bb4402 | 647 | |
e610024b | 648 | You must not use C initializers for static or global variables unless |
05aea714 | 649 | the variables are never written once Emacs is dumped. These variables |
8241495d RS |
650 | with initializers are allocated in an area of memory that becomes |
651 | read-only (on certain operating systems) as a result of dumping Emacs. | |
652 | @xref{Pure Storage}. | |
e610024b RS |
653 | |
654 | Do not use static variables within functions---place all static | |
655 | variables at top level in the file. This is necessary because Emacs on | |
656 | some operating systems defines the keyword @code{static} as a null | |
657 | macro. (This definition is used because those systems put all variables | |
658 | declared static in a place that becomes read-only after dumping, whether | |
659 | they have initializers or not.) | |
77223f05 | 660 | |
a890e1b0 RS |
661 | Defining the C function is not enough to make a Lisp primitive |
662 | available; you must also create the Lisp symbol for the primitive and | |
663 | store a suitable subr object in its function cell. The code looks like | |
664 | this: | |
a44af9f2 RS |
665 | |
666 | @example | |
667 | defsubr (&@var{subr-structure-name}); | |
668 | @end example | |
669 | ||
670 | @noindent | |
a890e1b0 RS |
671 | Here @var{subr-structure-name} is the name you used as the third |
672 | argument to @code{DEFUN}. | |
673 | ||
674 | If you add a new primitive to a file that already has Lisp primitives | |
675 | defined in it, find the function (near the end of the file) named | |
676 | @code{syms_of_@var{something}}, and add the call to @code{defsubr} | |
677 | there. If the file doesn't have this function, or if you create a new | |
678 | file, add to it a @code{syms_of_@var{filename}} (e.g., | |
679 | @code{syms_of_myfile}). Then find the spot in @file{emacs.c} where all | |
680 | of these functions are called, and add a call to | |
681 | @code{syms_of_@var{filename}} there. | |
a44af9f2 | 682 | |
568ffbee | 683 | @anchor{Defining Lisp variables in C} |
8241495d | 684 | @vindex byte-boolean-vars |
574efc83 RS |
685 | The function @code{syms_of_@var{filename}} is also the place to define |
686 | any C variables that are to be visible as Lisp variables. | |
a890e1b0 RS |
687 | @code{DEFVAR_LISP} makes a C variable of type @code{Lisp_Object} visible |
688 | in Lisp. @code{DEFVAR_INT} makes a C variable of type @code{int} | |
689 | visible in Lisp with a value that is always an integer. | |
690 | @code{DEFVAR_BOOL} makes a C variable of type @code{int} visible in Lisp | |
8241495d RS |
691 | with a value that is either @code{t} or @code{nil}. Note that variables |
692 | defined with @code{DEFVAR_BOOL} are automatically added to the list | |
693 | @code{byte-boolean-vars} used by the byte compiler. | |
a44af9f2 | 694 | |
969fe9b5 | 695 | If you define a file-scope C variable of type @code{Lisp_Object}, |
8241495d | 696 | you must protect it from garbage-collection by calling @code{staticpro} |
969fe9b5 RS |
697 | in @code{syms_of_@var{filename}}, like this: |
698 | ||
699 | @example | |
700 | staticpro (&@var{variable}); | |
701 | @end example | |
702 | ||
a890e1b0 | 703 | Here is another example function, with more complicated arguments. |
969fe9b5 RS |
704 | This comes from the code in @file{window.c}, and it demonstrates the use |
705 | of macros and functions to manipulate Lisp objects. | |
a44af9f2 RS |
706 | |
707 | @smallexample | |
708 | @group | |
709 | DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p, | |
710 | Scoordinates_in_window_p, 2, 2, | |
711 | "xSpecify coordinate pair: \nXExpression which evals to window: ", | |
88510b17 | 712 | "Return non-nil if COORDINATES is in WINDOW.\n\ |
969fe9b5 RS |
713 | COORDINATES is a cons of the form (X . Y), X and Y being distances\n\ |
714 | ... | |
a44af9f2 RS |
715 | @end group |
716 | @group | |
969fe9b5 RS |
717 | If they are on the border between WINDOW and its right sibling,\n\ |
718 | `vertical-line' is returned.") | |
719 | (coordinates, window) | |
720 | register Lisp_Object coordinates, window; | |
a44af9f2 | 721 | @{ |
969fe9b5 | 722 | int x, y; |
a44af9f2 RS |
723 | @end group |
724 | ||
725 | @group | |
969fe9b5 RS |
726 | CHECK_LIVE_WINDOW (window, 0); |
727 | CHECK_CONS (coordinates, 1); | |
728 | x = XINT (Fcar (coordinates)); | |
729 | y = XINT (Fcdr (coordinates)); | |
a44af9f2 | 730 | @end group |
969fe9b5 | 731 | |
a44af9f2 | 732 | @group |
969fe9b5 RS |
733 | switch (coordinates_in_window (XWINDOW (window), &x, &y)) |
734 | @{ | |
735 | case 0: /* NOT in window at all. */ | |
736 | return Qnil; | |
a44af9f2 | 737 | @end group |
969fe9b5 | 738 | |
a44af9f2 | 739 | @group |
969fe9b5 RS |
740 | case 1: /* In text part of window. */ |
741 | return Fcons (make_number (x), make_number (y)); | |
a44af9f2 | 742 | @end group |
969fe9b5 | 743 | |
a44af9f2 | 744 | @group |
969fe9b5 RS |
745 | case 2: /* In mode line of window. */ |
746 | return Qmode_line; | |
a44af9f2 | 747 | @end group |
969fe9b5 | 748 | |
a44af9f2 | 749 | @group |
969fe9b5 RS |
750 | case 3: /* On right border of window. */ |
751 | return Qvertical_line; | |
752 | @end group | |
753 | ||
754 | @group | |
755 | default: | |
756 | abort (); | |
757 | @} | |
a44af9f2 RS |
758 | @} |
759 | @end group | |
760 | @end smallexample | |
761 | ||
a890e1b0 RS |
762 | Note that C code cannot call functions by name unless they are defined |
763 | in C. The way to call a function written in Lisp is to use | |
764 | @code{Ffuncall}, which embodies the Lisp function @code{funcall}. Since | |
765 | the Lisp function @code{funcall} accepts an unlimited number of | |
766 | arguments, in C it takes two: the number of Lisp-level arguments, and a | |
767 | one-dimensional array containing their values. The first Lisp-level | |
768 | argument is the Lisp function to call, and the rest are the arguments to | |
769 | pass to it. Since @code{Ffuncall} can call the evaluator, you must | |
770 | protect pointers from garbage collection around the call to | |
771 | @code{Ffuncall}. | |
772 | ||
773 | The C functions @code{call0}, @code{call1}, @code{call2}, and so on, | |
774 | provide handy ways to call a Lisp function conveniently with a fixed | |
775 | number of arguments. They work by calling @code{Ffuncall}. | |
a44af9f2 RS |
776 | |
777 | @file{eval.c} is a very good file to look through for examples; | |
778 | @file{lisp.h} contains the definitions for some important macros and | |
779 | functions. | |
780 | ||
0a692803 DL |
781 | If you define a function which is side-effect free, update the code |
782 | in @file{byte-opt.el} which binds @code{side-effect-free-fns} and | |
783 | @code{side-effect-and-error-free-fns} so that the compiler optimizer | |
784 | knows about it. | |
8241495d | 785 | |
969fe9b5 | 786 | @node Object Internals |
a44af9f2 RS |
787 | @appendixsec Object Internals |
788 | @cindex object internals | |
789 | ||
790 | GNU Emacs Lisp manipulates many different types of data. The actual | |
f9f59935 RS |
791 | data are stored in a heap and the only access that programs have to it |
792 | is through pointers. Pointers are thirty-two bits wide in most | |
a44af9f2 | 793 | implementations. Depending on the operating system and type of machine |
568ffbee LT |
794 | for which you compile Emacs, twenty-nine bits are used to address the |
795 | object, and the remaining three bits are used for the tag that | |
796 | identifies the object's type. | |
a44af9f2 | 797 | |
a890e1b0 RS |
798 | Because Lisp objects are represented as tagged pointers, it is always |
799 | possible to determine the Lisp data type of any object. The C data type | |
800 | @code{Lisp_Object} can hold any Lisp object of any data type. Ordinary | |
801 | variables have type @code{Lisp_Object}, which means they can hold any | |
802 | type of Lisp value; you can determine the actual data type only at run | |
803 | time. The same is true for function arguments; if you want a function | |
804 | to accept only a certain type of argument, you must check the type | |
805 | explicitly using a suitable predicate (@pxref{Type Predicates}). | |
a44af9f2 RS |
806 | @cindex type checking internals |
807 | ||
808 | @menu | |
809 | * Buffer Internals:: Components of a buffer structure. | |
810 | * Window Internals:: Components of a window structure. | |
811 | * Process Internals:: Components of a process structure. | |
812 | @end menu | |
813 | ||
969fe9b5 | 814 | @node Buffer Internals |
a44af9f2 RS |
815 | @appendixsubsec Buffer Internals |
816 | @cindex internals, of buffer | |
817 | @cindex buffer internals | |
818 | ||
819 | Buffers contain fields not directly accessible by the Lisp programmer. | |
820 | We describe them here, naming them by the names used in the C code. | |
821 | Many are accessible indirectly in Lisp programs via Lisp primitives. | |
822 | ||
95260b26 GM |
823 | Two structures are used to represent buffers in C. The |
824 | @code{buffer_text} structure contains fields describing the text of a | |
825 | buffer; the @code{buffer} structure holds other fields. In the case | |
826 | of indirect buffers, two or more @code{buffer} structures reference | |
827 | the same @code{buffer_text} structure. | |
828 | ||
829 | Here is a list of the @code{struct buffer_text} fields: | |
830 | ||
a44af9f2 | 831 | @table @code |
95260b26 | 832 | @item beg |
05aea714 | 833 | This field contains the actual address of the buffer contents. |
95260b26 | 834 | |
d7255d62 | 835 | @item gpt |
95260b26 | 836 | This holds the character position of the gap in the buffer. |
88510b17 | 837 | @xref{Buffer Gap}. |
95260b26 GM |
838 | |
839 | @item z | |
840 | This field contains the character position of the end of the buffer | |
841 | text. | |
842 | ||
843 | @item gpt_byte | |
844 | Contains the byte position of the gap. | |
845 | ||
846 | @item z_byte | |
847 | Holds the byte position of the end of the buffer text. | |
848 | ||
849 | @item gap_size | |
88510b17 | 850 | Contains the size of buffer's gap. @xref{Buffer Gap}. |
95260b26 GM |
851 | |
852 | @item modiff | |
853 | This field counts buffer-modification events for this buffer. It is | |
854 | incremented for each such event, and never otherwise changed. | |
855 | ||
856 | @item save_modiff | |
857 | Contains the previous value of @code{modiff}, as of the last time a | |
858 | buffer was visited or saved in a file. | |
88510b17 | 859 | |
95260b26 GM |
860 | @item overlay_modiff |
861 | Counts modifications to overlays analogous to @code{modiff}. | |
88510b17 | 862 | |
95260b26 GM |
863 | @item beg_unchanged |
864 | Holds the number of characters at the start of the text that are known | |
865 | to be unchanged since the last redisplay that finished. | |
88510b17 | 866 | |
95260b26 GM |
867 | @item end_unchanged |
868 | Holds the number of characters at the end of the text that are known to | |
869 | be unchanged since the last redisplay that finished. | |
88510b17 | 870 | |
95260b26 GM |
871 | @item unchanged_modified |
872 | Contains the value of @code{modiff} at the time of the last redisplay | |
873 | that finished. If this value matches @code{modiff}, | |
874 | @code{beg_unchanged} and @code{end_unchanged} contain no useful | |
875 | information. | |
88510b17 | 876 | |
95260b26 GM |
877 | @item overlay_unchanged_modified |
878 | Contains the value of @code{overlay_modiff} at the time of the last | |
879 | redisplay that finished. If this value matches @code{overlay_modiff}, | |
880 | @code{beg_unchanged} and @code{end_unchanged} contain no useful | |
881 | information. | |
88510b17 | 882 | |
95260b26 GM |
883 | @item markers |
884 | The markers that refer to this buffer. This is actually a single | |
885 | marker, and successive elements in its marker @code{chain} are the other | |
886 | markers referring to this buffer text. | |
a44af9f2 | 887 | |
95260b26 GM |
888 | @item intervals |
889 | Contains the interval tree which records the text properties of this | |
890 | buffer. | |
891 | @end table | |
892 | ||
893 | The fields of @code{struct buffer} are: | |
894 | ||
895 | @table @code | |
896 | @item next | |
897 | Points to the next buffer, in the chain of all buffers including killed | |
898 | buffers. This chain is used only for garbage collection, in order to | |
899 | collect killed buffers properly. Note that vectors, and most kinds of | |
900 | objects allocated as vectors, are all on one chain, but buffers are on a | |
901 | separate chain of their own. | |
902 | ||
903 | @item own_text | |
904 | This is a @code{struct buffer_text} structure. In an ordinary buffer, | |
905 | it holds the buffer contents. In indirect buffers, this field is not | |
906 | used. | |
907 | ||
908 | @item text | |
909 | This points to the @code{buffer_text} structure that is used for this | |
910 | buffer. In an ordinary buffer, this is the @code{own_text} field above. | |
911 | In an indirect buffer, this is the @code{own_text} field of the base | |
912 | buffer. | |
913 | ||
914 | @item pt | |
915 | Contains the character position of point in a buffer. | |
916 | ||
917 | @item pt_byte | |
918 | Contains the byte position of point in a buffer. | |
919 | ||
920 | @item begv | |
88510b17 | 921 | This field contains the character position of the beginning of the |
95260b26 GM |
922 | accessible range of text in the buffer. |
923 | ||
924 | @item begv_byte | |
88510b17 | 925 | This field contains the byte position of the beginning of the |
95260b26 GM |
926 | accessible range of text in the buffer. |
927 | ||
928 | @item zv | |
88510b17 | 929 | This field contains the character position of the end of the |
95260b26 GM |
930 | accessible range of text in the buffer. |
931 | ||
932 | @item zv_byte | |
88510b17 | 933 | This field contains the byte position of the end of the |
95260b26 GM |
934 | accessible range of text in the buffer. |
935 | ||
936 | @item base_buffer | |
937 | In an indirect buffer, this points to the base buffer. In an ordinary | |
938 | buffer, it is null. | |
939 | ||
940 | @item local_var_flags | |
941 | This field contains flags indicating that certain variables are local in | |
942 | this buffer. Such variables are declared in the C code using | |
943 | @code{DEFVAR_PER_BUFFER}, and their buffer-local bindings are stored in | |
944 | fields in the buffer structure itself. (Some of these fields are | |
945 | described in this table.) | |
a44af9f2 RS |
946 | |
947 | @item modtime | |
948 | This field contains the modification time of the visited file. It is | |
8241495d RS |
949 | set when the file is written or read. Before writing the buffer into a |
950 | file, this field is compared to the modification time of the file to see | |
951 | if the file has changed on disk. @xref{Buffer Modification}. | |
a44af9f2 RS |
952 | |
953 | @item auto_save_modified | |
954 | This field contains the time when the buffer was last auto-saved. | |
955 | ||
95260b26 GM |
956 | @item auto_save_failure_time |
957 | The time at which we detected a failure to auto-save, or -1 if we didn't | |
958 | have a failure. | |
959 | ||
a44af9f2 RS |
960 | @item last_window_start |
961 | This field contains the @code{window-start} position in the buffer as of | |
962 | the last time the buffer was displayed in a window. | |
963 | ||
95260b26 GM |
964 | @item clip_changed |
965 | This flag is set when narrowing changes in a buffer. | |
966 | ||
967 | @item prevent_redisplay_optimizations_p | |
88510b17 | 968 | this flag indicates that redisplay optimizations should not be used |
95260b26 GM |
969 | to display this buffer. |
970 | ||
a890e1b0 RS |
971 | @item undo_list |
972 | This field points to the buffer's undo list. @xref{Undo}. | |
a44af9f2 | 973 | |
95260b26 GM |
974 | @item name |
975 | The buffer name is a string that names the buffer. It is guaranteed to | |
976 | be unique. @xref{Buffer Names}. | |
977 | ||
978 | @item filename | |
979 | The name of the file visited in this buffer, or @code{nil}. | |
88510b17 | 980 | |
95260b26 GM |
981 | @item directory |
982 | The directory for expanding relative file names. | |
983 | ||
984 | @item save_length | |
985 | Length of the file this buffer is visiting, when last read or saved. | |
986 | This and other fields concerned with saving are not kept in the | |
987 | @code{buffer_text} structure because indirect buffers are never saved. | |
988 | ||
989 | @item auto_save_file_name | |
88510b17 | 990 | File name used for auto-saving this buffer. This is not in the |
95260b26 GM |
991 | @code{buffer_text} because it's not used in indirect buffers at all. |
992 | ||
993 | @item read_only | |
994 | Non-@code{nil} means this buffer is read-only. | |
995 | ||
996 | @item mark | |
997 | This field contains the mark for the buffer. The mark is a marker, | |
998 | hence it is also included on the list @code{markers}. @xref{The Mark}. | |
999 | ||
1000 | @item local_var_alist | |
1001 | This field contains the association list describing the buffer-local | |
1002 | variable bindings of this buffer, not including the built-in | |
1003 | buffer-local bindings that have special slots in the buffer object. | |
1004 | (Those slots are omitted from this table.) @xref{Buffer-Local | |
1005 | Variables}. | |
1006 | ||
1007 | @item major_mode | |
1008 | Symbol naming the major mode of this buffer, e.g., @code{lisp-mode}. | |
1009 | ||
1010 | @item mode_name | |
1011 | Pretty name of major mode, e.g., @code{"Lisp"}. | |
1012 | ||
1013 | @item mode_line_format | |
1014 | Mode line element that controls the format of the mode line. If this | |
1015 | is @code{nil}, no mode line will be displayed. | |
1016 | ||
1017 | @item header_line_format | |
88510b17 | 1018 | This field is analoguous to @code{mode_line_format} for the mode |
95260b26 GM |
1019 | line displayed at the top of windows. |
1020 | ||
1021 | @item keymap | |
1022 | This field holds the buffer's local keymap. @xref{Keymaps}. | |
1023 | ||
1024 | @item abbrev_table | |
1025 | This buffer's local abbrevs. | |
1026 | ||
1027 | @item syntax_table | |
a44af9f2 RS |
1028 | This field contains the syntax table for the buffer. @xref{Syntax Tables}. |
1029 | ||
95260b26 GM |
1030 | @item category_table |
1031 | This field contains the category table for the buffer. | |
1032 | ||
1033 | @item case_fold_search | |
1034 | The value of @code{case-fold-search} in this buffer. | |
1035 | ||
1036 | @item tab_width | |
1037 | The value of @code{tab-width} in this buffer. | |
1038 | ||
1039 | @item fill_column | |
1040 | The value of @code{fill-column} in this buffer. | |
1041 | ||
1042 | @item left_margin | |
1043 | The value of @code{left-margin} in this buffer. | |
1044 | ||
1045 | @item auto_fill_function | |
1046 | The value of @code{auto-fill-function} in this buffer. | |
1047 | ||
a44af9f2 RS |
1048 | @item downcase_table |
1049 | This field contains the conversion table for converting text to lower case. | |
969fe9b5 | 1050 | @xref{Case Tables}. |
a44af9f2 RS |
1051 | |
1052 | @item upcase_table | |
1053 | This field contains the conversion table for converting text to upper case. | |
969fe9b5 | 1054 | @xref{Case Tables}. |
a44af9f2 RS |
1055 | |
1056 | @item case_canon_table | |
1057 | This field contains the conversion table for canonicalizing text for | |
969fe9b5 | 1058 | case-folding search. @xref{Case Tables}. |
a44af9f2 RS |
1059 | |
1060 | @item case_eqv_table | |
1061 | This field contains the equivalence table for case-folding search. | |
969fe9b5 | 1062 | @xref{Case Tables}. |
a44af9f2 | 1063 | |
95260b26 GM |
1064 | @item truncate_lines |
1065 | The value of @code{truncate-lines} in this buffer. | |
a44af9f2 | 1066 | |
95260b26 GM |
1067 | @item ctl_arrow |
1068 | The value of @code{ctl-arrow} in this buffer. | |
a44af9f2 | 1069 | |
95260b26 GM |
1070 | @item selective_display |
1071 | The value of @code{selective-display} in this buffer. | |
a44af9f2 | 1072 | |
95260b26 GM |
1073 | @item selective_display_ellipsis |
1074 | The value of @code{selective-display-ellipsis} in this buffer. | |
a44af9f2 | 1075 | |
95260b26 GM |
1076 | @item minor_modes |
1077 | An alist of the minor modes of this buffer. | |
a890e1b0 | 1078 | |
95260b26 GM |
1079 | @item overwrite_mode |
1080 | The value of @code{overwrite_mode} in this buffer. | |
a890e1b0 | 1081 | |
95260b26 GM |
1082 | @item abbrev_mode |
1083 | The value of @code{abbrev-mode} in this buffer. | |
bfe721d1 | 1084 | |
95260b26 GM |
1085 | @item display_table |
1086 | This field contains the buffer's display table, or @code{nil} if it doesn't | |
1087 | have one. @xref{Display Tables}. | |
a890e1b0 | 1088 | |
95260b26 GM |
1089 | @item save_modified |
1090 | This field contains the time when the buffer was last saved, as an integer. | |
1091 | @xref{Buffer Modification}. | |
1092 | ||
1093 | @item mark_active | |
1094 | This field is non-@code{nil} if the buffer's mark is active. | |
a890e1b0 RS |
1095 | |
1096 | @item overlays_before | |
1097 | This field holds a list of the overlays in this buffer that end at or | |
1098 | before the current overlay center position. They are sorted in order of | |
1099 | decreasing end position. | |
1100 | ||
1101 | @item overlays_after | |
1102 | This field holds a list of the overlays in this buffer that end after | |
1103 | the current overlay center position. They are sorted in order of | |
1104 | increasing beginning position. | |
969fe9b5 | 1105 | |
95260b26 GM |
1106 | @item overlay_center |
1107 | This field holds the current overlay center position. @xref{Overlays}. | |
1108 | ||
969fe9b5 RS |
1109 | @item enable_multibyte_characters |
1110 | This field holds the buffer's local value of | |
1111 | @code{enable-multibyte-characters}---either @code{t} or @code{nil}. | |
95260b26 GM |
1112 | |
1113 | @item buffer_file_coding_system | |
1114 | The value of @code{buffer-file-coding-system} in this buffer. | |
1115 | ||
1116 | @item file_format | |
1117 | The value of @code{buffer-file-format} in this buffer. | |
1118 | ||
980aaec7 LT |
1119 | @item auto_save_file_format |
1120 | The value of @code{buffer-auto-save-file-format} in this buffer. | |
1121 | ||
95260b26 GM |
1122 | @item pt_marker |
1123 | In an indirect buffer, or a buffer that is the base of an indirect | |
1124 | buffer, this holds a marker that records point for this buffer when the | |
1125 | buffer is not current. | |
1126 | ||
1127 | @item begv_marker | |
1128 | In an indirect buffer, or a buffer that is the base of an indirect | |
1129 | buffer, this holds a marker that records @code{begv} for this buffer | |
1130 | when the buffer is not current. | |
88510b17 | 1131 | |
95260b26 GM |
1132 | @item zv_marker |
1133 | In an indirect buffer, or a buffer that is the base of an indirect | |
1134 | buffer, this holds a marker that records @code{zv} for this buffer when | |
1135 | the buffer is not current. | |
1136 | ||
1137 | @item file_truename | |
1138 | The truename of the visited file, or @code{nil}. | |
1139 | ||
1140 | @item invisibility_spec | |
1141 | The value of @code{buffer-invisibility-spec} in this buffer. | |
1142 | ||
1143 | @item last_selected_window | |
1144 | This is the last window that was selected with this buffer in it, or @code{nil} | |
1145 | if that window no longer displays this buffer. | |
1146 | ||
1147 | @item display_count | |
1148 | This field is incremented each time the buffer is displayed in a window. | |
1149 | ||
1150 | @item left_margin_width | |
1151 | The value of @code{left-margin-width} in this buffer. | |
1152 | ||
1153 | @item right_margin_width | |
1154 | The value of @code{right-margin-width} in this buffer. | |
1155 | ||
1156 | @item indicate_empty_lines | |
1157 | Non-@code{nil} means indicate empty lines (lines with no text) with a | |
1158 | small bitmap in the fringe, when using a window system that can do it. | |
1159 | ||
1160 | @item display_time | |
1161 | This holds a time stamp that is updated each time this buffer is | |
1162 | displayed in a window. | |
1163 | ||
1164 | @item scroll_up_aggressively | |
1165 | The value of @code{scroll-up-aggressively} in this buffer. | |
88510b17 | 1166 | |
95260b26 GM |
1167 | @item scroll_down_aggressively |
1168 | The value of @code{scroll-down-aggressively} in this buffer. | |
a44af9f2 RS |
1169 | @end table |
1170 | ||
969fe9b5 | 1171 | @node Window Internals |
a44af9f2 RS |
1172 | @appendixsubsec Window Internals |
1173 | @cindex internals, of window | |
1174 | @cindex window internals | |
1175 | ||
1176 | Windows have the following accessible fields: | |
1177 | ||
1178 | @table @code | |
1179 | @item frame | |
a890e1b0 | 1180 | The frame that this window is on. |
a44af9f2 RS |
1181 | |
1182 | @item mini_p | |
a890e1b0 | 1183 | Non-@code{nil} if this window is a minibuffer window. |
a44af9f2 | 1184 | |
95260b26 GM |
1185 | @item parent |
1186 | Internally, Emacs arranges windows in a tree; each group of siblings has | |
1187 | a parent window whose area includes all the siblings. This field points | |
1188 | to a window's parent. | |
1189 | ||
1190 | Parent windows do not display buffers, and play little role in display | |
1191 | except to shape their child windows. Emacs Lisp programs usually have | |
1192 | no access to the parent windows; they operate on the windows at the | |
1193 | leaves of the tree, which actually display buffers. | |
1194 | ||
1195 | The following four fields also describe the window tree structure. | |
1196 | ||
1197 | @item hchild | |
1198 | In a window subdivided horizontally by child windows, the leftmost child. | |
1199 | Otherwise, @code{nil}. | |
1200 | ||
1201 | @item vchild | |
1202 | In a window subdivided vertically by child windows, the topmost child. | |
1203 | Otherwise, @code{nil}. | |
1204 | ||
1205 | @item next | |
1206 | The next sibling of this window. It is @code{nil} in a window that is | |
1207 | the rightmost or bottommost of a group of siblings. | |
1208 | ||
1209 | @item prev | |
1210 | The previous sibling of this window. It is @code{nil} in a window that | |
1211 | is the leftmost or topmost of a group of siblings. | |
1212 | ||
1213 | @item left | |
1214 | This is the left-hand edge of the window, measured in columns. (The | |
1215 | leftmost column on the screen is @w{column 0}.) | |
1216 | ||
1217 | @item top | |
1218 | This is the top edge of the window, measured in lines. (The top line on | |
1219 | the screen is @w{line 0}.) | |
1220 | ||
1221 | @item height | |
1222 | The height of the window, measured in lines. | |
1223 | ||
1224 | @item width | |
1225 | The width of the window, measured in columns. This width includes the | |
1226 | scroll bar and fringes, and/or the separator line on the right of the | |
1227 | window (if any). | |
1228 | ||
a44af9f2 | 1229 | @item buffer |
574efc83 | 1230 | The buffer that the window is displaying. This may change often during |
a44af9f2 RS |
1231 | the life of the window. |
1232 | ||
95260b26 GM |
1233 | @item start |
1234 | The position in the buffer that is the first character to be displayed | |
1235 | in the window. | |
a44af9f2 RS |
1236 | |
1237 | @item pointm | |
1238 | @cindex window point internals | |
a890e1b0 | 1239 | This is the value of point in the current buffer when this window is |
a44af9f2 RS |
1240 | selected; when it is not selected, it retains its previous value. |
1241 | ||
a890e1b0 RS |
1242 | @item force_start |
1243 | If this flag is non-@code{nil}, it says that the window has been | |
1244 | scrolled explicitly by the Lisp program. This affects what the next | |
1245 | redisplay does if point is off the screen: instead of scrolling the | |
1246 | window to show the text around point, it moves point to a location that | |
1247 | is on the screen. | |
1248 | ||
95260b26 | 1249 | @item frozen_window_start_p |
88510b17 | 1250 | This field is set temporarily to 1 to indicate to redisplay that |
95260b26 GM |
1251 | @code{start} of this window should not be changed, even if point |
1252 | gets invisible. | |
1253 | ||
1254 | @item start_at_line_beg | |
1255 | Non-@code{nil} means current value of @code{start} was the beginning of a line | |
1256 | when it was chosen. | |
1257 | ||
1258 | @item too_small_ok | |
1259 | Non-@code{nil} means don't delete this window for becoming ``too small''. | |
1260 | ||
1261 | @item height_fixed_p | |
1262 | This field is temporarily set to 1 to fix the height of the selected | |
1263 | window when the echo area is resized. | |
1264 | ||
1265 | @item use_time | |
1266 | This is the last time that the window was selected. The function | |
1267 | @code{get-lru-window} uses this field. | |
1268 | ||
1269 | @item sequence_number | |
1270 | A unique number assigned to this window when it was created. | |
1271 | ||
a890e1b0 | 1272 | @item last_modified |
95260b26 | 1273 | The @code{modiff} field of the window's buffer, as of the last time |
a890e1b0 RS |
1274 | a redisplay completed in this window. |
1275 | ||
95260b26 GM |
1276 | @item last_overlay_modified |
1277 | The @code{overlay_modiff} field of the window's buffer, as of the last | |
1278 | time a redisplay completed in this window. | |
1279 | ||
a890e1b0 | 1280 | @item last_point |
95260b26 GM |
1281 | The buffer's value of point, as of the last time a redisplay completed |
1282 | in this window. | |
a890e1b0 | 1283 | |
95260b26 GM |
1284 | @item last_had_star |
1285 | A non-@code{nil} value means the window's buffer was ``modified'' when the | |
1286 | window was last updated. | |
a44af9f2 | 1287 | |
95260b26 GM |
1288 | @item vertical_scroll_bar |
1289 | This window's vertical scroll bar. | |
a44af9f2 | 1290 | |
95260b26 GM |
1291 | @item left_margin_width |
1292 | The width of the left margin in this window, or @code{nil} not to | |
1293 | specify it (in which case the buffer's value of @code{left-margin-width} | |
1294 | is used. | |
a890e1b0 | 1295 | |
95260b26 GM |
1296 | @item right_margin_width |
1297 | Likewise for the right margin. | |
a890e1b0 | 1298 | |
13ede7fc | 1299 | @ignore |
95260b26 GM |
1300 | @item last_mark_x |
1301 | @item last_mark_y | |
1302 | ???Not used. | |
1303 | @end ignore | |
a44af9f2 | 1304 | |
95260b26 GM |
1305 | @item window_end_pos |
1306 | This is computed as @code{z} minus the buffer position of the last glyph | |
1307 | in the current matrix of the window. The value is only valid if | |
1308 | @code{window_end_valid} is not @code{nil}. | |
a44af9f2 | 1309 | |
95260b26 GM |
1310 | @item window_end_bytepos |
1311 | The byte position corresponding to @code{window_end_pos}. | |
a890e1b0 | 1312 | |
95260b26 GM |
1313 | @item window_end_vpos |
1314 | The window-relative vertical position of the line containing | |
1315 | @code{window_end_pos}. | |
a44af9f2 | 1316 | |
95260b26 GM |
1317 | @item window_end_valid |
1318 | This field is set to a non-@code{nil} value if @code{window_end_pos} is truly | |
1319 | valid. This is @code{nil} if nontrivial redisplay is preempted since in that | |
1320 | case the display that @code{window_end_pos} was computed for did not get | |
1321 | onto the screen. | |
1322 | ||
1323 | @item redisplay_end_trigger | |
1324 | If redisplay in this window goes beyond this buffer position, it runs | |
2a233172 | 1325 | the @code{redisplay-end-trigger-hook}. |
95260b26 | 1326 | |
13ede7fc | 1327 | @ignore |
95260b26 GM |
1328 | @item orig_height |
1329 | @item orig_top | |
1330 | ??? Are temporary storage areas. | |
1331 | @end ignore | |
1332 | ||
1333 | @item cursor | |
1334 | A structure describing where the cursor is in this window. | |
1335 | ||
1336 | @item last_cursor | |
1337 | The value of @code{cursor} as of the last redisplay that finished. | |
1338 | ||
1339 | @item phys_cursor | |
1340 | A structure describing where the cursor of this window physically is. | |
1341 | ||
1342 | @item phys_cursor_type | |
1343 | The type of cursor that was last displayed on this window. | |
1344 | ||
1345 | @item phys_cursor_on_p | |
1346 | This field is non-zero if the cursor is physically on. | |
1347 | ||
1348 | @item cursor_off_p | |
1349 | Non-zero means the cursor in this window is logically on. | |
1350 | ||
1351 | @item last_cursor_off_p | |
1352 | This field contains the value of @code{cursor_off_p} as of the time of | |
1353 | the last redisplay. | |
1354 | ||
1355 | @item must_be_updated_p | |
1356 | This is set to 1 during redisplay when this window must be updated. | |
1357 | ||
a44af9f2 | 1358 | @item hscroll |
a890e1b0 | 1359 | This is the number of columns that the display in the window is scrolled |
a44af9f2 RS |
1360 | horizontally to the left. Normally, this is 0. |
1361 | ||
95260b26 GM |
1362 | @item vscroll |
1363 | Vertical scroll amount, in pixels. Normally, this is 0. | |
1364 | ||
1365 | @item dedicated | |
1366 | Non-@code{nil} if this window is dedicated to its buffer. | |
a44af9f2 RS |
1367 | |
1368 | @item display_table | |
a890e1b0 RS |
1369 | The window's display table, or @code{nil} if none is specified for it. |
1370 | ||
1371 | @item update_mode_line | |
1372 | Non-@code{nil} means this window's mode line needs to be updated. | |
1373 | ||
1374 | @item base_line_number | |
1375 | The line number of a certain position in the buffer, or @code{nil}. | |
1376 | This is used for displaying the line number of point in the mode line. | |
1377 | ||
1378 | @item base_line_pos | |
1379 | The position in the buffer for which the line number is known, or | |
1380 | @code{nil} meaning none is known. | |
1381 | ||
1382 | @item region_showing | |
1383 | If the region (or part of it) is highlighted in this window, this field | |
1384 | holds the mark position that made one end of that region. Otherwise, | |
1385 | this field is @code{nil}. | |
95260b26 GM |
1386 | |
1387 | @item column_number_displayed | |
1388 | The column number currently displayed in this window's mode line, or @code{nil} | |
1389 | if column numbers are not being displayed. | |
1390 | ||
1391 | @item current_matrix | |
1392 | A glyph matrix describing the current display of this window. | |
1393 | ||
1394 | @item desired_matrix | |
1395 | A glyph matrix describing the desired display of this window. | |
a44af9f2 RS |
1396 | @end table |
1397 | ||
969fe9b5 | 1398 | @node Process Internals |
a44af9f2 RS |
1399 | @appendixsubsec Process Internals |
1400 | @cindex internals, of process | |
1401 | @cindex process internals | |
1402 | ||
1403 | The fields of a process are: | |
1404 | ||
1405 | @table @code | |
1406 | @item name | |
1407 | A string, the name of the process. | |
1408 | ||
1409 | @item command | |
1410 | A list containing the command arguments that were used to start this | |
1411 | process. | |
1412 | ||
1413 | @item filter | |
1414 | A function used to accept output from the process instead of a buffer, | |
1415 | or @code{nil}. | |
1416 | ||
1417 | @item sentinel | |
1418 | A function called whenever the process receives a signal, or @code{nil}. | |
1419 | ||
1420 | @item buffer | |
1421 | The associated buffer of the process. | |
1422 | ||
1423 | @item pid | |
2a233172 | 1424 | An integer, the operating system's process @acronym{ID}. |
a44af9f2 RS |
1425 | |
1426 | @item childp | |
1427 | A flag, non-@code{nil} if this is really a child process. | |
1428 | It is @code{nil} for a network connection. | |
1429 | ||
a44af9f2 | 1430 | @item mark |
574efc83 RS |
1431 | A marker indicating the position of the end of the last output from this |
1432 | process inserted into the buffer. This is often but not always the end | |
1433 | of the buffer. | |
a44af9f2 RS |
1434 | |
1435 | @item kill_without_query | |
a890e1b0 RS |
1436 | If this is non-@code{nil}, killing Emacs while this process is still |
1437 | running does not ask for confirmation about killing the process. | |
1438 | ||
1439 | @item raw_status_low | |
1440 | @itemx raw_status_high | |
1441 | These two fields record 16 bits each of the process status returned by | |
1442 | the @code{wait} system call. | |
1443 | ||
1444 | @item status | |
1445 | The process status, as @code{process-status} should return it. | |
1446 | ||
1447 | @item tick | |
1448 | @itemx update_tick | |
1449 | If these two fields are not equal, a change in the status of the process | |
1450 | needs to be reported, either by running the sentinel or by inserting a | |
1451 | message in the process buffer. | |
1452 | ||
1453 | @item pty_flag | |
ad800164 | 1454 | Non-@code{nil} if communication with the subprocess uses a @acronym{PTY}; |
a890e1b0 RS |
1455 | @code{nil} if it uses a pipe. |
1456 | ||
1457 | @item infd | |
1458 | The file descriptor for input from the process. | |
1459 | ||
1460 | @item outfd | |
1461 | The file descriptor for output to the process. | |
1462 | ||
1463 | @item subtty | |
1464 | The file descriptor for the terminal that the subprocess is using. (On | |
1465 | some systems, there is no need to record this, so the value is | |
1466 | @code{nil}.) | |
bfe721d1 KH |
1467 | |
1468 | @item tty_name | |
1469 | The name of the terminal that the subprocess is using, | |
1470 | or @code{nil} if it is using pipes. | |
95260b26 GM |
1471 | |
1472 | @item decode_coding_system | |
1473 | Coding-system for decoding the input from this process. | |
1474 | ||
1475 | @item decoding_buf | |
1476 | A working buffer for decoding. | |
1477 | ||
1478 | @item decoding_carryover | |
1479 | Size of carryover in decoding. | |
1480 | ||
1481 | @item encode_coding_system | |
1482 | Coding-system for encoding the output to this process. | |
1483 | ||
1484 | @item encoding_buf | |
a39c2e0d | 1485 | A working buffer for encoding. |
95260b26 GM |
1486 | |
1487 | @item encoding_carryover | |
1488 | Size of carryover in encoding. | |
1489 | ||
1490 | @item inherit_coding_system_flag | |
1491 | Flag to set @code{coding-system} of the process buffer from the | |
1492 | coding system used to decode process output. | |
a44af9f2 | 1493 | @end table |
ab5796a9 MB |
1494 | |
1495 | @ignore | |
1496 | arch-tag: 4b2c33bc-d7e4-43f5-bc20-27c0db52a53e | |
1497 | @end ignore |