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