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