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