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