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