Mercurial > emacs
annotate lispref/internals.texi @ 16070:5aa311b84644
On fatal signal, delete socket-file:
Include signal.h.
(xmalloc, fatal, error): New functions.
(delete_socket, handle_signals): New functions.
(progname, socket_name): New variables.
[HAVE_SOCKETS] (main): Call handle_signals; set the new variables.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Mon, 02 Sep 1996 05:39:36 +0000 |
parents | 43d4b9cf0b69 |
children | 981e116b4ac6 |
rev | line source |
---|---|
6451 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993 Free Software Foundation, Inc. | |
4 @c See the file elisp.texi for copying conditions. | |
5 @setfilename ../info/internals | |
6 @node GNU Emacs Internals, Standard Errors, Tips, Top | |
7 @comment node-name, next, previous, up | |
8 @appendix GNU Emacs Internals | |
9 | |
10 This chapter describes how the runnable Emacs executable is dumped with | |
11 the preloaded Lisp libraries in it, how storage is allocated, and some | |
12 internal aspects of GNU Emacs that may be of interest to C programmers. | |
13 | |
14 @menu | |
15 * Building Emacs:: How to preload Lisp libraries into Emacs. | |
16 * Pure Storage:: A kludge to make preloaded Lisp functions sharable. | |
17 * Garbage Collection:: Reclaiming space for Lisp objects no longer used. | |
18 * Writing Emacs Primitives:: Writing C code for Emacs. | |
19 * Object Internals:: Data formats of buffers, windows, processes. | |
20 @end menu | |
21 | |
22 @node Building Emacs, Pure Storage, GNU Emacs Internals, GNU Emacs Internals | |
23 @appendixsec Building Emacs | |
24 @cindex building Emacs | |
25 @pindex temacs | |
26 | |
27 This section explains the steps involved in building the Emacs | |
28 executable. You don't have to know this material to build and install | |
29 Emacs, since the makefiles do all these things automatically. This | |
30 information is pertinent to Emacs maintenance. | |
31 | |
32 Compilation of the C source files in the @file{src} directory | |
33 produces an executable file called @file{temacs}, also called a | |
34 @dfn{bare impure Emacs}. It contains the Emacs Lisp interpreter and I/O | |
35 routines, but not the editing commands. | |
36 | |
37 @cindex @file{loadup.el} | |
38 The command @w{@samp{temacs -l loadup}} uses @file{temacs} to create | |
39 the real runnable Emacs executable. These arguments direct | |
40 @file{temacs} to evaluate the Lisp files specified in the file | |
41 @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
|
42 environment, resulting in an Emacs that is still impure but no longer |
6451 | 43 bare. |
44 | |
45 It takes a substantial time to load the standard Lisp files. Luckily, | |
46 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
|
47 dump out an executable program called @file{emacs} that has these files |
6451 | 48 preloaded. @file{emacs} starts more quickly because it does not need to |
49 load the files. This is the Emacs executable that is normally | |
50 installed. | |
51 | |
52 To create @file{emacs}, use the command @samp{temacs -batch -l loadup | |
53 dump}. The purpose of @samp{-batch} here is to prevent @file{temacs} | |
54 from trying to initialize any of its data on the terminal; this ensures | |
55 that the tables of terminal information are empty in the dumped Emacs. | |
56 The argument @samp{dump} tells @file{loadup.el} to dump a new executable | |
57 named @file{emacs}. | |
58 | |
59 Some operating systems don't support dumping. On those systems, you | |
60 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
|
61 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
|
62 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
|
63 extra time is not too severe a problem. |
6451 | 64 |
65 @cindex @file{site-load.el} | |
66 You can specify additional files to preload by writing a library named | |
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
|
67 @file{site-load.el} that loads them. You may need to increase the value |
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
|
68 of @code{PURESIZE}, in @file{src/puresize.h}, to make room for 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
|
69 additional data. (Try adding increments of 20000 until it is big |
6451 | 70 enough.) However, the advantage of preloading additional files |
71 decreases as machines get faster. On modern machines, it is usually not | |
72 advisable. | |
73 | |
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
|
74 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
|
75 documentation strings for primitive and preloaded functions (and |
2f15f316326d
Clarify site-load.el vs site-init.el and how to deal with doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
76 variables) in the file @file{etc/DOC} where they are stored, by calling |
2f15f316326d
Clarify site-load.el vs site-init.el and how to deal with doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
77 @code{Snarf-documentation} (@pxref{Accessing Documentation}). |
2f15f316326d
Clarify site-load.el vs site-init.el and how to deal with doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
78 |
6451 | 79 @cindex @file{site-init.el} |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
80 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
|
81 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
|
82 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
|
83 |
2f15f316326d
Clarify site-load.el vs site-init.el and how to deal with doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
84 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
|
85 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
|
86 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
|
87 |
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
|
88 @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
|
89 @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
|
90 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
|
91 and load them with @file{site-load.el}. |
6451 | 92 |
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
|
93 @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
|
94 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
|
95 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
|
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 @item |
2f15f316326d
Clarify site-load.el vs site-init.el and how to deal with doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
98 Specify a non-@code{nil} value for |
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 @code{byte-compile-dynamic-docstrings} as a local variable in each these |
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 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
|
101 @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
|
102 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
|
103 @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
|
104 |
2f15f316326d
Clarify site-load.el vs site-init.el and how to deal with doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
105 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
|
106 @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
|
107 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
|
108 normal features for your site, do it with @file{default.el}, so that |
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 users can override your changes if they wish. @xref{Start-up Summary}. |
6451 | 110 |
111 @defun dump-emacs to-file from-file | |
112 @cindex unexec | |
113 This function dumps the current state of Emacs into an executable file | |
114 @var{to-file}. It takes symbols from @var{from-file} (this is normally | |
115 the executable file @file{temacs}). | |
116 | |
117 If you use this function in an Emacs that was already dumped, you must | |
118 set @code{command-line-processed} to @code{nil} first for good results. | |
119 @xref{Command Line Arguments}. | |
120 @end defun | |
121 | |
122 @deffn Command emacs-version | |
123 This function returns a string describing the version of Emacs that is | |
124 running. It is useful to include this string in bug reports. | |
125 | |
126 @example | |
127 @group | |
128 (emacs-version) | |
12098 | 129 @result{} "GNU Emacs 19.29.1 (i386-debian-linux) \ |
130 of Tue Jun 6 1995 on balloon" | |
6451 | 131 @end group |
132 @end example | |
133 | |
134 Called interactively, the function prints the same information in the | |
135 echo area. | |
136 @end deffn | |
137 | |
138 @defvar emacs-build-time | |
12098 | 139 The value of this variable is the time at which Emacs was built at the |
6451 | 140 local site. |
141 | |
142 @example | |
143 @group | |
144 emacs-build-time | |
12098 | 145 @result{} "Tue Jun 6 14:55:57 1995" |
6451 | 146 @end group |
147 @end example | |
148 @end defvar | |
149 | |
150 @defvar emacs-version | |
151 The value of this variable is the version of Emacs being run. It is a | |
12098 | 152 string such as @code{"19.29.1"}. |
6451 | 153 @end defvar |
154 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
155 The following two variables did not exist before Emacs version 19.23, |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
156 which reduces their usefulness at present, but we hope they will be |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
157 convenient in the future. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
158 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
159 @defvar emacs-major-version |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
160 The major version number of Emacs, as an integer. For Emacs version |
12098 | 161 19.29, the value is 19. |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
162 @end defvar |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
163 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
164 @defvar emacs-minor-version |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
165 The minor version number of Emacs, as an integer. For Emacs version |
12098 | 166 19.29, the value is 29. |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
167 @end defvar |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
168 |
6451 | 169 @node Pure Storage, Garbage Collection, Building Emacs, GNU Emacs Internals |
170 @appendixsec Pure Storage | |
171 @cindex pure storage | |
172 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
173 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
|
174 @dfn{normal storage} and @dfn{pure storage}. Normal storage is where |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
175 all the new data created during an Emacs session is kept; see the |
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
176 following section for information on normal storage. Pure storage is |
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
177 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
|
178 should never change during actual use of Emacs. |
6451 | 179 |
180 Pure storage is allocated only while @file{temacs} is loading the | |
181 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
|
182 marked as read-only (on operating systems that permit this), so that |
6451 | 183 the memory space can be shared by all the Emacs jobs running on the |
184 machine at once. Pure storage is not expandable; a fixed amount is | |
185 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
|
186 preloaded libraries, @file{temacs} crashes. If that happens, you must |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
187 increase the compilation parameter @code{PURESIZE} in the file |
6451 | 188 @file{src/puresize.h}. This normally won't happen unless you try to |
189 preload additional libraries or add features to the standard ones. | |
190 | |
191 @defun purecopy object | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
192 This function makes a copy of @var{object} in pure storage and returns |
6451 | 193 it. It copies strings by simply making a new string with the same |
194 characters in pure storage. It recursively copies the contents of | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
195 vectors and cons cells. It does not make copies of other objects such |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
196 as symbols, but just returns them unchanged. It signals an error if |
6451 | 197 asked to copy markers. |
198 | |
11139
311f3ea4a759
Minor purecopy correction.
Richard M. Stallman <rms@gnu.org>
parents:
10487
diff
changeset
|
199 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
|
200 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
|
201 a few packages call it just in case you decide to preload them. |
6451 | 202 @end defun |
203 | |
204 @defvar pure-bytes-used | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
205 The value of this variable is the number of bytes of pure storage |
6451 | 206 allocated so far. Typically, in a dumped Emacs, this number is very |
207 close to the total amount of pure storage available---if it were not, | |
208 we would preallocate less. | |
209 @end defvar | |
210 | |
211 @defvar purify-flag | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
212 This variable determines whether @code{defun} should make a copy of the |
6451 | 213 function definition in pure storage. If it is non-@code{nil}, then the |
214 function definition is copied into pure storage. | |
215 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
216 This flag is @code{t} while loading all of the basic functions for |
6451 | 217 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
|
218 non-collectible). Dumping Emacs as an executable always writes |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
219 @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
|
220 before and after dumping. |
6451 | 221 |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
222 You should not change this flag in a running Emacs. |
6451 | 223 @end defvar |
224 | |
225 @node Garbage Collection, Writing Emacs Primitives, Pure Storage, GNU Emacs Internals | |
226 @appendixsec Garbage Collection | |
227 @cindex garbage collector | |
228 | |
229 @cindex memory allocation | |
230 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
|
231 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
|
232 normal storage runs low, then Emacs asks the operating system to |
6451 | 233 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
|
234 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
|
235 segregated in distinct blocks in memory. (Vectors, long strings, |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
236 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
|
237 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
|
238 packed into blocks of 8k bytes.) |
6451 | 239 |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
240 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
|
241 (for example) killing a buffer or deleting the last pointer to an |
6451 | 242 object. Emacs provides a @dfn{garbage collector} to reclaim this |
243 abandoned storage. (This name is traditional, but ``garbage recycler'' | |
244 might be a more intuitive metaphor for this facility.) | |
245 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
246 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
|
247 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
|
248 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
|
249 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
|
250 be reached indirectly through other accessible objects are also |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
251 accessible. |
6451 | 252 |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
253 When marking is finished, all objects still unmarked are garbage. No |
6451 | 254 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
|
255 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
|
256 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
|
257 (``sweep'') phase of the garbage collector arranges to reuse them. |
6451 | 258 |
259 @cindex free list | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
260 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
|
261 for future allocation; likewise for symbols and markers. It compacts |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
262 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
|
263 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
|
264 individually allocated and freed using @code{malloc} and @code{free}. |
6451 | 265 |
266 @cindex CL note---allocate more storage | |
267 @quotation | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
268 @b{Common Lisp note:} Unlike other Lisps, GNU Emacs Lisp does not |
6451 | 269 call the garbage collector when the free list is empty. Instead, it |
270 simply requests the operating system to allocate more storage, and | |
271 processing continues until @code{gc-cons-threshold} bytes have been | |
272 used. | |
273 | |
274 This means that you can make sure that the garbage collector will not | |
275 run during a certain portion of a Lisp program by calling the garbage | |
276 collector explicitly just before it (provided that portion of the | |
277 program does not use so much space as to force a second garbage | |
278 collection). | |
279 @end quotation | |
280 | |
281 @deffn Command garbage-collect | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
282 This command runs a garbage collection, and returns information on |
6451 | 283 the amount of space in use. (Garbage collection can also occur |
284 spontaneously if you use more than @code{gc-cons-threshold} bytes of | |
285 Lisp data since the previous garbage collection.) | |
286 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
287 @code{garbage-collect} returns a list containing the following |
6451 | 288 information: |
289 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
290 @example |
6451 | 291 @group |
292 ((@var{used-conses} . @var{free-conses}) | |
293 (@var{used-syms} . @var{free-syms}) | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
294 @end group |
6451 | 295 (@var{used-markers} . @var{free-markers}) |
296 @var{used-string-chars} | |
297 @var{used-vector-slots} | |
298 (@var{used-floats} . @var{free-floats})) | |
299 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
300 @group |
6451 | 301 (garbage-collect) |
302 @result{} ((3435 . 2332) (1688 . 0) | |
303 (57 . 417) 24510 3839 (4 . 1)) | |
304 @end group | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
305 @end example |
6451 | 306 |
307 Here is a table explaining each element: | |
308 | |
309 @table @var | |
310 @item used-conses | |
311 The number of cons cells in use. | |
312 | |
313 @item free-conses | |
314 The number of cons cells for which space has been obtained from the | |
315 operating system, but that are not currently being used. | |
316 | |
317 @item used-syms | |
318 The number of symbols in use. | |
319 | |
320 @item free-syms | |
321 The number of symbols for which space has been obtained from the | |
322 operating system, but that are not currently being used. | |
323 | |
324 @item used-markers | |
325 The number of markers in use. | |
326 | |
327 @item free-markers | |
328 The number of markers for which space has been obtained from the | |
329 operating system, but that are not currently being used. | |
330 | |
331 @item used-string-chars | |
332 The total size of all strings, in characters. | |
333 | |
334 @item used-vector-slots | |
335 The total number of elements of existing vectors. | |
336 | |
337 @item used-floats | |
338 @c Emacs 19 feature | |
339 The number of floats in use. | |
340 | |
341 @item free-floats | |
342 @c Emacs 19 feature | |
343 The number of floats for which space has been obtained from the | |
344 operating system, but that are not currently being used. | |
345 @end table | |
346 @end deffn | |
347 | |
15769
43d4b9cf0b69
Describe garbage-collection-messages.
Richard M. Stallman <rms@gnu.org>
parents:
14514
diff
changeset
|
348 @defopt garbage-collection-messages |
43d4b9cf0b69
Describe garbage-collection-messages.
Richard M. Stallman <rms@gnu.org>
parents:
14514
diff
changeset
|
349 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
|
350 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
|
351 @code{nil}, meaning there are no such messages. |
43d4b9cf0b69
Describe garbage-collection-messages.
Richard M. Stallman <rms@gnu.org>
parents:
14514
diff
changeset
|
352 @end defopt |
43d4b9cf0b69
Describe garbage-collection-messages.
Richard M. Stallman <rms@gnu.org>
parents:
14514
diff
changeset
|
353 |
6451 | 354 @defopt gc-cons-threshold |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
355 The value of this variable is the number of bytes of storage that must |
6451 | 356 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
|
357 trigger another garbage collection. A cons cell counts as eight bytes, |
6451 | 358 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
|
359 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
|
360 that the subsequent garbage collection does not happen immediately when |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
361 the threshold is exhausted, but only the next time the Lisp evaluator is |
6451 | 362 called. |
363 | |
12098 | 364 The initial threshold value is 300,000. If you specify a larger |
6451 | 365 value, garbage collection will happen less often. This reduces the |
366 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
|
367 You may want to do this when running a program that creates lots of |
6451 | 368 Lisp data. |
369 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
370 You can make collections more frequent by specifying a smaller value, |
6451 | 371 down to 10,000. A value less than 10,000 will remain in effect only |
372 until the subsequent garbage collection, at which time | |
373 @code{garbage-collect} will set the threshold back to 10,000. | |
374 @end defopt | |
375 | |
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 | |
386 @node Writing Emacs Primitives, Object Internals, Garbage Collection, GNU Emacs Internals | |
387 @appendixsec Writing Emacs Primitives | |
388 @cindex primitive function internals | |
389 | |
390 Lisp primitives are Lisp functions implemented in C. The details of | |
391 interfacing the C function so that Lisp can call it are handled by a few | |
392 C macros. The only way to really understand how to write new C code is | |
393 to read the source, but we can explain some things here. | |
394 | |
395 An example of a special form is the definition of @code{or}, from | |
396 @file{eval.c}. (An ordinary function would have the same general | |
397 appearance.) | |
398 | |
399 @cindex garbage collection protection | |
400 @smallexample | |
401 @group | |
402 DEFUN ("or", For, Sor, 0, UNEVALLED, 0, | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
403 "Eval args until one of them yields non-nil, then return that value.\n\ |
6451 | 404 The remaining args are not evalled at all.\n\ |
405 @end group | |
406 @group | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
407 If all args return nil, return nil.") |
6451 | 408 (args) |
409 Lisp_Object args; | |
410 @{ | |
411 register Lisp_Object val; | |
412 Lisp_Object args_left; | |
413 struct gcpro gcpro1; | |
414 @end group | |
415 | |
416 @group | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
417 if (NULL (args)) |
6451 | 418 return Qnil; |
419 | |
420 args_left = args; | |
421 GCPRO1 (args_left); | |
422 @end group | |
423 | |
424 @group | |
425 do | |
426 @{ | |
427 val = Feval (Fcar (args_left)); | |
428 if (!NULL (val)) | |
429 break; | |
430 args_left = Fcdr (args_left); | |
431 @} | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
432 while (!NULL (args_left)); |
6451 | 433 @end group |
434 | |
435 @group | |
436 UNGCPRO; | |
437 return val; | |
438 @} | |
439 @end group | |
440 @end smallexample | |
441 | |
442 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
|
443 @code{DEFUN} macro. Here is a template for them: |
6451 | 444 |
445 @example | |
446 DEFUN (@var{lname}, @var{fname}, @var{sname}, @var{min}, @var{max}, @var{interactive}, @var{doc}) | |
447 @end example | |
448 | |
449 @table @var | |
450 @item lname | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
451 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
|
452 the example above, it is @code{or}. |
6451 | 453 |
454 @item fname | |
455 This is the C function name for this function. This is | |
456 the name that is used in C code for calling the function. The name is, | |
457 by convention, @samp{F} prepended to the Lisp name, with all dashes | |
458 (@samp{-}) in the Lisp name changed to underscores. Thus, to call this | |
459 function from C code, call @code{For}. Remember that the arguments must | |
460 be of type @code{Lisp_Object}; various macros and functions for creating | |
461 values of type @code{Lisp_Object} are declared in the file | |
462 @file{lisp.h}. | |
463 | |
464 @item sname | |
465 This is a C variable name to use for a structure that holds the data for | |
466 the subr object that represents the function in Lisp. This structure | |
467 conveys the Lisp symbol name to the initialization routine that will | |
468 create the symbol and store the subr object as its definition. By | |
469 convention, this name is always @var{fname} with @samp{F} replaced with | |
470 @samp{S}. | |
471 | |
472 @item min | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
473 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
|
474 function @code{or} allows a minimum of zero arguments. |
6451 | 475 |
476 @item max | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
477 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
|
478 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
|
479 indicating a special form that receives unevaluated arguments, or |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
480 @code{MANY}, indicating an unlimited number of evaluated arguments (the |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
481 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
|
482 macros. If @var{max} is a number, it may not be less than @var{min} and |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
483 it may not be greater than seven. |
6451 | 484 |
485 @item interactive | |
486 This is an interactive specification, a string such as might be used as | |
487 the argument of @code{interactive} in a Lisp function. In the case of | |
488 @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
|
489 called interactively. A value of @code{""} indicates a function that |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
490 should receive no arguments when called interactively. |
6451 | 491 |
492 @item doc | |
493 This is the documentation string. It is written just like a | |
494 documentation string for a function defined in Lisp, except you must | |
495 write @samp{\n\} at the end of each line. In particular, the first line | |
496 should be a single sentence. | |
497 @end table | |
498 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
499 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
|
500 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
|
501 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
|
502 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
|
503 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
|
504 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
|
505 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
|
506 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
|
507 values. They have types @code{int} and @w{@code{Lisp_Object *}}. |
6451 | 508 |
509 Within the function @code{For} itself, note the use of the macros | |
510 @code{GCPRO1} and @code{UNGCPRO}. @code{GCPRO1} is used to ``protect'' | |
511 a variable from garbage collection---to inform the garbage collector that | |
512 it must look in that variable and regard its contents as an accessible | |
513 object. This is necessary whenever you call @code{Feval} or anything | |
514 that can directly or indirectly call @code{Feval}. At such a time, any | |
515 Lisp object that you intend to refer to again must be protected somehow. | |
516 @code{UNGCPRO} cancels the protection of the variables that are | |
517 protected in the current function. It is necessary to do this explicitly. | |
518 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
519 For most data types, it suffices to protect at least one pointer to |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
520 the object; as long as the object is not recycled, all pointers to it |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
521 remain valid. This is not so for strings, because the garbage collector |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
522 can move them. When the garbage collector moves a string, it relocates |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
523 all the pointers it knows about; any other pointers become invalid. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
524 Therefore, you must protect all pointers to strings across any point |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
525 where garbage collection may be possible. |
6451 | 526 |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
527 The macro @code{GCPRO1} protects just one local variable. If you want |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
528 to protect two, use @code{GCPRO2} instead; repeating @code{GCPRO1} will |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
529 not work. Macros @code{GCPRO3} and @code{GCPRO4} also exist. |
6451 | 530 |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
531 These macros implicitly use local variables such as @code{gcpro1}; you |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
532 must declare these explicitly, with type @code{struct gcpro}. Thus, if |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
533 you use @code{GCPRO2}, you must declare @code{gcpro1} and @code{gcpro2}. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
534 Alas, we can't explain all the tricky details here. |
6451 | 535 |
10487 | 536 You must not use C initializers for static or global variables unless |
537 they are never written once Emacs is dumped. These variables with | |
538 initializers are allocated in an area of memory that becomes read-only | |
539 (on certain operating systems) as a result of dumping Emacs. @xref{Pure | |
540 Storage}. | |
10476
4d87344e6dfb
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7601
diff
changeset
|
541 |
10487 | 542 Do not use static variables within functions---place all static |
543 variables at top level in the file. This is necessary because Emacs on | |
544 some operating systems defines the keyword @code{static} as a null | |
545 macro. (This definition is used because those systems put all variables | |
546 declared static in a place that becomes read-only after dumping, whether | |
547 they have initializers or not.) | |
10476
4d87344e6dfb
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7601
diff
changeset
|
548 |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
549 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
|
550 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
|
551 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
|
552 this: |
6451 | 553 |
554 @example | |
555 defsubr (&@var{subr-structure-name}); | |
556 @end example | |
557 | |
558 @noindent | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
559 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
|
560 argument to @code{DEFUN}. |
6451 | 561 |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
562 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
|
563 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
|
564 @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
|
565 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
|
566 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
|
567 @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
|
568 of these functions are called, and add a call to |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
569 @code{syms_of_@var{filename}} there. |
6451 | 570 |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
571 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
|
572 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
|
573 @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
|
574 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
|
575 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
|
576 @code{DEFVAR_BOOL} makes a C variable of type @code{int} visible in Lisp |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
577 with a value that is either @code{t} or @code{nil}. |
6451 | 578 |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
579 Here is another example function, with more complicated arguments. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
580 This comes from the code for the X Window System, and it demonstrates |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
581 the use of macros and functions to manipulate Lisp objects. |
6451 | 582 |
583 @smallexample | |
584 @group | |
585 DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p, | |
586 Scoordinates_in_window_p, 2, 2, | |
587 "xSpecify coordinate pair: \nXExpression which evals to window: ", | |
588 "Return non-nil if POSITIONS is in WINDOW.\n\ | |
589 \(POSITIONS is a list, (SCREEN-X SCREEN-Y)\)\n\ | |
590 @end group | |
591 @group | |
592 Returned value is list of positions expressed\n\ | |
593 relative to window upper left corner.") | |
594 (coordinate, window) | |
595 register Lisp_Object coordinate, window; | |
596 @{ | |
597 register Lisp_Object xcoord, ycoord; | |
598 @end group | |
599 | |
600 @group | |
601 if (!CONSP (coordinate)) wrong_type_argument (Qlistp, coordinate); | |
602 CHECK_WINDOW (window, 2); | |
603 xcoord = Fcar (coordinate); | |
604 ycoord = Fcar (Fcdr (coordinate)); | |
605 CHECK_NUMBER (xcoord, 0); | |
606 CHECK_NUMBER (ycoord, 1); | |
607 @end group | |
608 @group | |
609 if ((XINT (xcoord) < XINT (XWINDOW (window)->left)) | |
610 || (XINT (xcoord) >= (XINT (XWINDOW (window)->left) | |
611 + XINT (XWINDOW (window)->width)))) | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
612 return Qnil; |
6451 | 613 XFASTINT (xcoord) -= XFASTINT (XWINDOW (window)->left); |
614 @end group | |
615 @group | |
616 if (XINT (ycoord) == (screen_height - 1)) | |
617 return Qnil; | |
618 @end group | |
619 @group | |
620 if ((XINT (ycoord) < XINT (XWINDOW (window)->top)) | |
621 || (XINT (ycoord) >= (XINT (XWINDOW (window)->top) | |
622 + XINT (XWINDOW (window)->height)) - 1)) | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
623 return Qnil; |
6451 | 624 @end group |
625 @group | |
626 XFASTINT (ycoord) -= XFASTINT (XWINDOW (window)->top); | |
627 return (Fcons (xcoord, Fcons (ycoord, Qnil))); | |
628 @} | |
629 @end group | |
630 @end smallexample | |
631 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
632 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
|
633 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
|
634 @code{Ffuncall}, which embodies the Lisp function @code{funcall}. Since |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
635 the Lisp function @code{funcall} accepts an unlimited number of |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
636 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
|
637 one-dimensional array containing their values. The first Lisp-level |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
638 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
|
639 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
|
640 protect pointers from garbage collection around the call to |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
641 @code{Ffuncall}. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
642 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
643 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
|
644 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
|
645 number of arguments. They work by calling @code{Ffuncall}. |
6451 | 646 |
647 @file{eval.c} is a very good file to look through for examples; | |
648 @file{lisp.h} contains the definitions for some important macros and | |
649 functions. | |
650 | |
651 @node Object Internals, , Writing Emacs Primitives, GNU Emacs Internals | |
652 @appendixsec Object Internals | |
653 @cindex object internals | |
654 | |
655 GNU Emacs Lisp manipulates many different types of data. The actual | |
656 data are stored in a heap and the only access that programs have to it is | |
657 through pointers. Pointers are thirty-two bits wide in most | |
658 implementations. Depending on the operating system and type of machine | |
659 for which you compile Emacs, twenty-four to twenty-six bits are used to | |
660 address the object, and the remaining six to eight bits are used for a | |
661 tag that identifies the object's type. | |
662 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
663 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
|
664 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
|
665 @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
|
666 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
|
667 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
|
668 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
|
669 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
|
670 explicitly using a suitable predicate (@pxref{Type Predicates}). |
6451 | 671 @cindex type checking internals |
672 | |
673 @menu | |
674 * Buffer Internals:: Components of a buffer structure. | |
675 * Window Internals:: Components of a window structure. | |
676 * Process Internals:: Components of a process structure. | |
677 @end menu | |
678 | |
679 @node Buffer Internals, Window Internals, Object Internals, Object Internals | |
680 @appendixsubsec Buffer Internals | |
681 @cindex internals, of buffer | |
682 @cindex buffer internals | |
683 | |
684 Buffers contain fields not directly accessible by the Lisp programmer. | |
685 We describe them here, naming them by the names used in the C code. | |
686 Many are accessible indirectly in Lisp programs via Lisp primitives. | |
687 | |
688 @table @code | |
689 @item name | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
690 The buffer name is a string that names the buffer. It is guaranteed to |
6451 | 691 be unique. @xref{Buffer Names}. |
692 | |
693 @item save_modified | |
694 This field contains the time when the buffer was last saved, as an integer. | |
695 @xref{Buffer Modification}. | |
696 | |
697 @item modtime | |
698 This field contains the modification time of the visited file. It is | |
699 set when the file is written or read. Every time the buffer is written | |
700 to the file, this field is compared to the modification time of the | |
701 file. @xref{Buffer Modification}. | |
702 | |
703 @item auto_save_modified | |
704 This field contains the time when the buffer was last auto-saved. | |
705 | |
706 @item last_window_start | |
707 This field contains the @code{window-start} position in the buffer as of | |
708 the last time the buffer was displayed in a window. | |
709 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
710 @item undo_list |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
711 This field points to the buffer's undo list. @xref{Undo}. |
6451 | 712 |
713 @item syntax_table_v | |
714 This field contains the syntax table for the buffer. @xref{Syntax Tables}. | |
715 | |
716 @item downcase_table | |
717 This field contains the conversion table for converting text to lower case. | |
718 @xref{Case Table}. | |
719 | |
720 @item upcase_table | |
721 This field contains the conversion table for converting text to upper case. | |
722 @xref{Case Table}. | |
723 | |
724 @item case_canon_table | |
725 This field contains the conversion table for canonicalizing text for | |
726 case-folding search. @xref{Case Table}. | |
727 | |
728 @item case_eqv_table | |
729 This field contains the equivalence table for case-folding search. | |
730 @xref{Case Table}. | |
731 | |
732 @item display_table | |
733 This field contains the buffer's display table, or @code{nil} if it doesn't | |
734 have one. @xref{Display Tables}. | |
735 | |
736 @item markers | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
737 This field contains the chain of all markers that currently point into |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
738 the buffer. Deletion of text in the buffer, and motion of the buffer's |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
739 gap, must check each of these markers and perhaps update it. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
740 @xref{Markers}. |
6451 | 741 |
742 @item backed_up | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
743 This field is a flag that tells whether a backup file has been made |
6451 | 744 for the visited file of this buffer. |
745 | |
746 @item mark | |
747 This field contains the mark for the buffer. The mark is a marker, | |
748 hence it is also included on the list @code{markers}. @xref{The Mark}. | |
749 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
750 @item mark_active |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
751 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
|
752 |
6451 | 753 @item local_var_alist |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
754 This field contains the association list describing the variables local |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
755 in this buffer, and their values, with the exception of local variables |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
756 that have special slots in the buffer object. (Those slots are omitted |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
757 from this table.) @xref{Buffer-Local Variables}. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
758 |
12098 | 759 @item base_buffer |
760 This field holds the buffer's base buffer (if it is an indirect buffer), | |
761 or @code{nil}. | |
762 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
763 @item keymap |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
764 This field holds the buffer's local keymap. @xref{Keymaps}. |
6451 | 765 |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
766 @item overlay_center |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
767 This field holds the current overlay center position. @xref{Overlays}. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
768 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
769 @item overlays_before |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
770 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
|
771 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
|
772 decreasing end position. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
773 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
774 @item overlays_after |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
775 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
|
776 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
|
777 increasing beginning position. |
6451 | 778 @end table |
779 | |
780 @node Window Internals, Process Internals, Buffer Internals, Object Internals | |
781 @appendixsubsec Window Internals | |
782 @cindex internals, of window | |
783 @cindex window internals | |
784 | |
785 Windows have the following accessible fields: | |
786 | |
787 @table @code | |
788 @item frame | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
789 The frame that this window is on. |
6451 | 790 |
791 @item mini_p | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
792 Non-@code{nil} if this window is a minibuffer window. |
6451 | 793 |
794 @item buffer | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
795 The buffer that the window is displaying. This may change often during |
6451 | 796 the life of the window. |
797 | |
798 @item dedicated | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
799 Non-@code{nil} if this window is dedicated to its buffer. |
6451 | 800 |
801 @item pointm | |
802 @cindex window point internals | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
803 This is the value of point in the current buffer when this window is |
6451 | 804 selected; when it is not selected, it retains its previous value. |
805 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
806 @item start |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
807 The position in the buffer that is the first character to be displayed |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
808 in the window. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
809 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
810 @item force_start |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
811 If this flag is non-@code{nil}, it says that the window has been |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
812 scrolled explicitly by the Lisp program. This affects what the next |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
813 redisplay does if point is off the screen: instead of scrolling the |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
814 window to show the text around point, it moves point to a location that |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
815 is on the screen. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
816 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
817 @item last_modified |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
818 The @code{modified} field of the window's buffer, as of the last time |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
819 a redisplay completed in this window. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
820 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
821 @item last_point |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
822 The buffer's value of point, as of the last time |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
823 a redisplay completed in this window. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
824 |
6451 | 825 @item left |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
826 This is the left-hand edge of the window, measured in columns. (The |
6451 | 827 leftmost column on the screen is @w{column 0}.) |
828 | |
829 @item top | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
830 This is the top edge of the window, measured in lines. (The top line on |
6451 | 831 the screen is @w{line 0}.) |
832 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
833 @item height |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
834 The height of the window, measured in lines. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
835 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
836 @item width |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
837 The width of the window, measured in columns. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
838 |
6451 | 839 @item next |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
840 This is the window that is the next in the chain of siblings. It is |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
841 @code{nil} in a window that is the rightmost or bottommost of a group of |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
842 siblings. |
6451 | 843 |
844 @item prev | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
845 This is the window that is the previous in the chain of siblings. It is |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
846 @code{nil} in a window that is the leftmost or topmost of a group of |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
847 siblings. |
6451 | 848 |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
849 @item parent |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
850 Internally, Emacs arranges windows in a tree; each group of siblings has |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
851 a parent window whose area includes all the siblings. This field points |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
852 to a window's parent. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
853 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
854 Parent windows do not display buffers, and play little role in display |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
855 except to shape their child windows. Emacs Lisp programs usually have |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
856 no access to the parent windows; they operate on the windows at the |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
857 leaves of the tree, which actually display buffers. |
6451 | 858 |
859 @item hscroll | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
860 This is the number of columns that the display in the window is scrolled |
6451 | 861 horizontally to the left. Normally, this is 0. |
862 | |
863 @item use_time | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
864 This is the last time that the window was selected. The function |
6451 | 865 @code{get-lru-window} uses this field. |
866 | |
867 @item display_table | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
868 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
|
869 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
870 @item update_mode_line |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
871 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
|
872 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
873 @item base_line_number |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
874 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
|
875 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
|
876 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
877 @item base_line_pos |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
878 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
|
879 @code{nil} meaning none is known. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
880 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
881 @item region_showing |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
882 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
|
883 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
|
884 this field is @code{nil}. |
6451 | 885 @end table |
886 | |
887 @node Process Internals, , Window Internals, Object Internals | |
888 @appendixsubsec Process Internals | |
889 @cindex internals, of process | |
890 @cindex process internals | |
891 | |
892 The fields of a process are: | |
893 | |
894 @table @code | |
895 @item name | |
896 A string, the name of the process. | |
897 | |
898 @item command | |
899 A list containing the command arguments that were used to start this | |
900 process. | |
901 | |
902 @item filter | |
903 A function used to accept output from the process instead of a buffer, | |
904 or @code{nil}. | |
905 | |
906 @item sentinel | |
907 A function called whenever the process receives a signal, or @code{nil}. | |
908 | |
909 @item buffer | |
910 The associated buffer of the process. | |
911 | |
912 @item pid | |
913 An integer, the Unix process @sc{id}. | |
914 | |
915 @item childp | |
916 A flag, non-@code{nil} if this is really a child process. | |
917 It is @code{nil} for a network connection. | |
918 | |
919 @item mark | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
920 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
|
921 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
|
922 of the buffer. |
6451 | 923 |
924 @item kill_without_query | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
925 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
|
926 running does not ask for confirmation about killing the process. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
927 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
928 @item raw_status_low |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
929 @itemx raw_status_high |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
930 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
|
931 the @code{wait} system call. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
932 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
933 @item status |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
934 The process status, as @code{process-status} should return it. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
935 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
936 @item tick |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
937 @itemx update_tick |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
938 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
|
939 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
|
940 message in the process buffer. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
941 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
942 @item pty_flag |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
943 Non-@code{nil} if communication with the subprocess uses a @sc{pty}; |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
944 @code{nil} if it uses a pipe. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
945 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
946 @item infd |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
947 The file descriptor for input from the process. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
948 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
949 @item outfd |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
950 The file descriptor for output to the process. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
951 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
952 @item subtty |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6451
diff
changeset
|
953 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
|
954 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
|
955 @code{nil}.) |
12098 | 956 |
957 @item tty_name | |
958 The name of the terminal that the subprocess is using, | |
959 or @code{nil} if it is using pipes. | |
6451 | 960 @end table |