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