Commit | Line | Data |
---|---|---|
38a93523 NJ |
1 | \input texinfo |
2 | @c -*-texinfo-*- | |
3 | @c %**start of header | |
4 | @setfilename guile.info | |
5 | @settitle Guile Reference Manual | |
370babab | 6 | @set guile |
a7c5a2e5 | 7 | @set MANUAL-REVISION 1 |
38a93523 | 8 | @c %**end of header |
d3830c6b | 9 | @include version.texi |
b89c4943 | 10 | @include lib-version.texi |
22b5f518 | 11 | @include effective-version.texi |
d3830c6b KR |
12 | |
13 | @copying | |
a7c5a2e5 | 14 | This manual documents Guile version @value{VERSION}. |
d3830c6b | 15 | |
0f7e6c56 | 16 | Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010 Free |
83c3d755 | 17 | Software Foundation. |
d3830c6b | 18 | |
3229f68b MV |
19 | Permission is granted to copy, distribute and/or modify this document |
20 | under the terms of the GNU Free Documentation License, Version 1.2 or | |
31c73458 | 21 | any later version published by the Free Software Foundation; with |
3229f68b MV |
22 | no Invariant Sections, with the Front-Cover Texts being ``A GNU |
23 | Manual,'' and with the Back-Cover Text ``You are free to copy and | |
24 | modify this GNU Manual.''. A copy of the license is included in the | |
e03bb21b | 25 | section entitled ``GNU Free Documentation License''. |
d3830c6b KR |
26 | @end copying |
27 | ||
38a93523 | 28 | |
2a946b44 | 29 | @c Notes |
370babab | 30 | @c |
2a946b44 NJ |
31 | @c We no longer use the category "primitive" to distinguish C-defined |
32 | @c Scheme procedures from those defined in Scheme. Instead, the | |
33 | @c reference manual now includes a C declaration as well as a Scheme | |
34 | @c declaration for each procedure that is available in both Scheme and | |
35 | @c C. | |
370babab | 36 | @c |
2a946b44 NJ |
37 | @c When adding a new reference entry to the Guile manual, please |
38 | @c document it with @deffn using one of the following categories: | |
39 | @c | |
40 | @c {Scheme Procedure} | |
41 | @c {Scheme Syntax} | |
42 | @c {C Function} | |
43 | @c {C Macro} | |
44 | @c | |
45 | @c If the entry is for a new primitive, it should have both a @deffn | |
46 | @c {Scheme Procedure} line and a @deffnx {C Function} line; see the | |
47 | @c manual source for plenty of existing examples of this. | |
48 | @c | |
49 | @c For {C Function} entries where the return type and all parameter | |
50 | @c types are SCM, we omit the SCMs. This is easier to read and also | |
51 | @c gets round the problem that Texinfo doesn't allow a @deftypefnx | |
52 | @c inside a @deffn. | |
38a93523 | 53 | @c |
370babab NJ |
54 | @c For a list of Guile primitives that are not yet incorporated into the |
55 | @c reference manual, see the file `new-docstrings.texi', which holds all | |
56 | @c the docstrings snarfed from the libguile C sources for primitives | |
57 | @c that are not in the reference manual. If you have worked with some | |
58 | @c of these concepts, implemented them, or just happen to know what they | |
59 | @c do, please write up a little explanation -- it would be a big help. | |
2a946b44 NJ |
60 | @c Alternatively, if you know of any reason why some of these should |
61 | @c *not* go in the manual, please let the mailing list | |
62 | @c <guile-devel@gnu.org> know. | |
38a93523 NJ |
63 | |
64 | @c Define indices that are used in the Guile Scheme part of the | |
65 | @c reference manual to group stuff according to whether it is R5RS or a | |
66 | @c Guile extension. | |
5c4b24e1 | 67 | @defcodeindex rn |
38a93523 | 68 | |
0624ce33 NJ |
69 | @c vnew - For (some) new items, indicates the Guile version in which |
70 | @c item first appeared. In future, this could be made to expand to | |
71 | @c something like a "New in Guile 45!" banner. | |
198586ed NJ |
72 | @macro vnew{VERSION} |
73 | @end macro | |
74 | ||
20685804 | 75 | |
17bf4bfa KR |
76 | @c The following, @le{} and @ge{}, are standard tex directives, given |
77 | @c definitions for use in non-tex. | |
78 | @c | |
79 | @ifnottex | |
80 | @macro ge | |
81 | >= | |
82 | @end macro | |
83 | @macro le | |
84 | <= | |
85 | @end macro | |
86 | @end ifnottex | |
87 | ||
27281a53 KR |
88 | @c @cross{} is a \times symbol in tex, or an "x" in info. In tex it works |
89 | @c inside or outside $ $. | |
90 | @tex | |
91 | \gdef\cross{\ifmmode\times\else$\times$\fi} | |
92 | @end tex | |
93 | @ifnottex | |
94 | @macro cross | |
95 | x | |
96 | @end macro | |
97 | @end ifnottex | |
98 | ||
d6f53bd5 KR |
99 | @c @m{T,N} is $T$ in tex or @math{N} otherwise. This is an easy way to give |
100 | @c different forms for math in tex and info. | |
101 | @iftex | |
102 | @macro m {T,N} | |
103 | @tex$\T\$@end tex | |
104 | @end macro | |
105 | @end iftex | |
106 | @ifnottex | |
107 | @macro m {T,N} | |
108 | @math{\N\} | |
109 | @end macro | |
110 | @end ifnottex | |
111 | ||
7ac44f03 KR |
112 | @c @nicode{S} is plain S in info, or @code{S} elsewhere. This can be used |
113 | @c when the quotes that @code{} gives in info aren't wanted, but the | |
114 | @c fontification in tex or html is wanted. @alias is used rather | |
115 | @c than @macro because backslashes don't work properly in an @macro. | |
20685804 | 116 | @ifinfo |
7ac44f03 | 117 | @alias nicode=asis |
20685804 KR |
118 | @end ifinfo |
119 | @ifnotinfo | |
7ac44f03 | 120 | @alias nicode=code |
20685804 KR |
121 | @end ifnotinfo |
122 | ||
123 | ||
38a93523 NJ |
124 | @c @iftex |
125 | @c @cropmarks | |
126 | @c @end iftex | |
127 | ||
128 | @dircategory The Algorithmic Language Scheme | |
129 | @direntry | |
c16da59f | 130 | * Guile Reference: (guile). The Guile reference manual. |
38a93523 NJ |
131 | @end direntry |
132 | ||
3229f68b | 133 | @setchapternewpage odd |
38a93523 | 134 | |
38a93523 NJ |
135 | @titlepage |
136 | @sp 10 | |
137 | @comment The title is printed in a large font. | |
138 | @title Guile Reference Manual | |
a7c5a2e5 | 139 | @subtitle Edition @value{EDITION}, revision @value{MANUAL-REVISION}, for use with Guile @value{VERSION} |
24dbb5ed | 140 | @c @subtitle $Id: guile.texi,v 1.49 2008-03-19 22:51:23 ossau Exp $ |
391b4ae0 MV |
141 | |
142 | @c See preface.texi for the list of authors | |
143 | @author The Guile Developers | |
370babab | 144 | |
38a93523 NJ |
145 | @c The following two commands start the copyright page. |
146 | @page | |
147 | @vskip 0pt plus 1filll | |
148 | @vskip 0pt plus 1filll | |
d3830c6b | 149 | @insertcopying |
38a93523 NJ |
150 | @end titlepage |
151 | ||
152 | @c @smallbook | |
153 | @finalout | |
154 | @headings double | |
155 | ||
156 | @c Where to find Guile examples. | |
157 | @set example-dir doc/examples | |
158 | ||
801892e7 | 159 | @ifnottex |
3229f68b | 160 | @node Top, Preface, (dir), (dir) |
38a93523 NJ |
161 | @top The Guile Reference Manual |
162 | ||
d3830c6b KR |
163 | @insertcopying |
164 | @sp 1 | |
801892e7 | 165 | @end ifnottex |
38a93523 NJ |
166 | |
167 | @menu | |
9401323e | 168 | |
3229f68b | 169 | * Preface:: |
3d9af0c9 | 170 | * Introduction:: |
9401323e | 171 | |
3229f68b MV |
172 | * Programming in Scheme:: |
173 | * Programming in C:: | |
38a93523 | 174 | |
3229f68b | 175 | * API Reference:: |
38a93523 | 176 | |
3229f68b | 177 | * Guile Modules:: |
c55cb58a | 178 | * Standard Library:: |
38a93523 | 179 | |
eb12b401 NJ |
180 | * GOOPS:: |
181 | ||
090d51ed | 182 | * Guile Implementation:: |
8680d53b | 183 | |
92826dd0 LC |
184 | * Autoconf Support:: |
185 | ||
c6ae9c77 MV |
186 | Appendices |
187 | ||
188 | * GNU Free Documentation License:: The license of this manual. | |
189 | ||
38a93523 NJ |
190 | Indices |
191 | ||
192 | * Concept Index:: | |
193 | * Procedure Index:: | |
194 | * Variable Index:: | |
195 | * Type Index:: | |
255ea784 | 196 | * R5RS Index:: |
38a93523 NJ |
197 | |
198 | @end menu | |
199 | ||
05c4ffe1 KR |
200 | @contents |
201 | ||
38a93523 NJ |
202 | @include preface.texi |
203 | ||
38a93523 NJ |
204 | @include intro.texi |
205 | ||
3229f68b MV |
206 | @node Programming in Scheme |
207 | @chapter Programming in Scheme | |
9401323e | 208 | |
ce9d0562 NJ |
209 | Guile's core language is Scheme, and an awful lot can be achieved simply |
210 | by using Guile to write and run Scheme programs. In this part of the | |
211 | manual, we explain how to use Guile in this mode, and describe the tools | |
212 | that Guile provides to help you with script writing, debugging and | |
213 | packaging your programs for distribution. | |
38a93523 | 214 | |
ce9d0562 NJ |
215 | For readers who are not yet familiar with the Scheme language, this part |
216 | includes a chapter that presents the basic concepts of the language, and | |
217 | gives references to freely available Scheme tutorial material on the | |
218 | web. | |
219 | ||
3229f68b MV |
220 | For detailed reference information on the variables, functions |
221 | etc. that make up Guile's application programming interface (API), | |
222 | @xref{API Reference}. | |
223 | ||
224 | @menu | |
225 | * Basic Ideas:: Basic ideas in Scheme. | |
226 | * Guile Scheme:: Guile's implementation of Scheme. | |
227 | * Guile Scripting:: How to write Guile scripts. | |
46f7666d NJ |
228 | * Using Guile Interactively:: Guile's REPL features. |
229 | * Using Guile in Emacs:: Guile and Emacs. | |
3229f68b MV |
230 | * Further Reading:: Where to find out more about Scheme. |
231 | @end menu | |
9401323e | 232 | |
3229f68b | 233 | @include scheme-ideas.texi |
38a93523 | 234 | @include scheme-intro.texi |
07d83abe | 235 | @include scheme-scripts.texi |
46f7666d | 236 | @include scheme-using.texi |
9401323e NJ |
237 | @include scheme-reading.texi |
238 | ||
3229f68b MV |
239 | @node Programming in C |
240 | @chapter Programming in C | |
241 | ||
242 | This part of the manual explains the general concepts that you need to | |
243 | understand when interfacing to Guile from C. You will learn about how | |
244 | the latent typing of Scheme is embedded into the static typing of C, how | |
245 | the garbage collection of Guile is made available to C code, and how | |
246 | continuations influence the control flow in a C program. | |
247 | ||
248 | This knowledge should make it straightforward to add new functions to | |
249 | Guile that can be called from Scheme. Adding new data types is also | |
250 | possible and is done by defining @dfn{smobs}. | |
251 | ||
252 | The @ref{Programming Overview} section of this part contains general | |
253 | musings and guidelines about programming with Guile. It explores | |
8c3fa3e5 | 254 | different ways to design a program around Guile, or how to embed Guile |
3229f68b MV |
255 | into existing programs. |
256 | ||
0f7e6c56 AW |
257 | For a pedagogical yet detailed explanation of how the data representation of |
258 | Guile is implemented, @xref{Data Representation}. You don't need to know the | |
259 | details given there to use Guile from C, but they are useful when you want to | |
260 | modify Guile itself or when you are just curious about how it is all done. | |
3229f68b MV |
261 | |
262 | For detailed reference information on the variables, functions | |
263 | etc. that make up Guile's application programming interface (API), | |
264 | @xref{API Reference}. | |
265 | ||
266 | @menu | |
267 | * Linking Programs With Guile:: More precisely, with the libguile library. | |
268 | * Linking Guile with Libraries:: To extend Guile itself. | |
269 | * General Libguile Concepts:: General concepts for using libguile. | |
270 | * Defining New Types (Smobs):: Adding new types to Guile. | |
271 | * Function Snarfing:: A way to define new functions. | |
272 | * Programming Overview:: An overview of Guile programming. | |
273 | @end menu | |
274 | ||
275 | @include libguile-linking.texi | |
276 | @include libguile-extensions.texi | |
277 | @include libguile-concepts.texi | |
278 | @include libguile-smobs.texi | |
279 | @include libguile-snarf.texi | |
237be238 | 280 | @include libguile-program.texi |
ce9d0562 | 281 | |
3229f68b MV |
282 | @node API Reference |
283 | @chapter API Reference | |
9401323e | 284 | |
a7a7bb95 NJ |
285 | Guile provides an application programming interface (@dfn{API}) to |
286 | developers in two core languages: Scheme and C. This part of the manual | |
287 | contains reference documentation for all of the functionality that is | |
288 | available through both Scheme and C interfaces. | |
289 | ||
3229f68b MV |
290 | @menu |
291 | * API Overview:: Overview of the Guile API. | |
029fa896 | 292 | * Discouraged and Deprecated:: Obsolete back-compatible APIs. |
98f445f4 | 293 | * The SCM Type:: The fundamental data type for C code. |
3229f68b MV |
294 | * Initialization:: Initializing Guile. |
295 | * Snarfing Macros:: Macros for snarfing initialization actions. | |
296 | * Simple Data Types:: Numbers, strings, booleans and so on. | |
297 | * Compound Data Types:: Data types for holding other data. | |
298 | * Smobs:: Defining new data types in C. | |
e4955559 AW |
299 | * Procedures:: Procedures. |
300 | * Macros:: Extending the syntax of Scheme. | |
3229f68b MV |
301 | * Utility Functions:: General utility functions. |
302 | * Binding Constructs:: Definitions and variable bindings. | |
303 | * Control Mechanisms:: Controlling the flow of program execution. | |
304 | * Input and Output:: Ports, reading and writing. | |
2115b8eb | 305 | * LALR(1) Parsing:: Generating LALR(1) parsers. |
00ce5125 | 306 | * Read/Load/Eval/Compile:: Reading and evaluating Scheme code. |
3229f68b MV |
307 | * Memory Management:: Memory management and garbage collection. |
308 | * Objects:: Low level object orientation support. | |
309 | * Modules:: Designing reusable code libraries. | |
726b8ba3 | 310 | * Foreign Function Interface:: Interacting with C procedures and data. |
3229f68b MV |
311 | * Scheduling:: Threads, mutexes, asyncs and dynamic roots. |
312 | * Options and Config:: Configuration, features and runtime options. | |
313 | * Translation:: Support for translating other languages. | |
089a0a34 | 314 | * Internationalization:: Support for gettext, etc. |
c9ef3741 | 315 | * Debugging:: Debugging infrastructure and Scheme interface. |
3229f68b MV |
316 | @end menu |
317 | ||
07d83abe | 318 | @include api-overview.texi |
029fa896 | 319 | @include api-discdepr.texi |
07d83abe MV |
320 | @include api-scm.texi |
321 | @include api-init.texi | |
322 | @include api-snarf.texi | |
323 | @include api-data.texi | |
324 | @include api-compound.texi | |
325 | @include api-smobs.texi | |
326 | @include api-procedures.texi | |
e4955559 | 327 | @include api-macros.texi |
07d83abe MV |
328 | @include api-utility.texi |
329 | @include api-binding.texi | |
330 | @include api-control.texi | |
331 | @include api-io.texi | |
2115b8eb | 332 | @include api-lalr.texi |
07d83abe MV |
333 | @include api-evaluation.texi |
334 | @include api-memory.texi | |
335 | @include api-modules.texi | |
726b8ba3 | 336 | @include api-foreign.texi |
07d83abe | 337 | @include api-scheduling.texi |
38a93523 | 338 | @c object orientation support here |
07d83abe MV |
339 | @include api-options.texi |
340 | @include api-translation.texi | |
089a0a34 | 341 | @include api-i18n.texi |
07d83abe | 342 | @include api-debug.texi |
38a93523 | 343 | |
3229f68b MV |
344 | @node Guile Modules |
345 | @chapter Guile Modules | |
346 | ||
347 | @menu | |
348 | * SLIB:: Using the SLIB Scheme library. | |
349 | * POSIX:: POSIX system calls and networking. | |
350 | * getopt-long:: Command line handling. | |
351 | * SRFI Support:: Support for various SRFIs. | |
352 | * Readline Support:: Module for using the readline library. | |
353 | * Value History:: Maintaining a value history in the REPL. | |
354 | * Pretty Printing:: Nicely formatting Scheme objects for output. | |
355 | * Formatted Output:: The @code{format} procedure. | |
3229f68b MV |
356 | * File Tree Walk:: Traversing the file system. |
357 | * Queues:: First-in first-out queuing. | |
71abb271 | 358 | * Streams:: Sequences of values. |
40296bab | 359 | * Buffered Input:: Ports made from a reader function. |
3229f68b MV |
360 | * Expect:: Controlling interactive programs with Guile. |
361 | * The Scheme shell (scsh):: Using scsh interfaces in Guile. | |
24dbb5ed | 362 | * Tracing:: Tracing program execution. |
3229f68b | 363 | @end menu |
38a93523 NJ |
364 | |
365 | @include slib.texi | |
366 | @include posix.texi | |
3229f68b | 367 | @include mod-getopt-long.texi |
fc8529c7 | 368 | @include srfi-modules.texi |
fc8529c7 | 369 | @include repl-modules.texi |
c2537425 | 370 | @include misc-modules.texi |
38a93523 NJ |
371 | @include expect.texi |
372 | @include scsh.texi | |
24dbb5ed | 373 | @include scheme-debugging.texi |
38a93523 | 374 | |
c55cb58a AW |
375 | @node Standard Library |
376 | @chapter Standard Library | |
377 | ||
378 | @lowersections | |
379 | @include standard-library.texi | |
380 | @raisesections | |
381 | ||
eb12b401 NJ |
382 | @include goops.texi |
383 | ||
090d51ed AW |
384 | @node Guile Implementation |
385 | @chapter Guile Implementation | |
8680d53b | 386 | |
0b8f3ac5 AW |
387 | At some point, after one has been programming in Scheme for some time, |
388 | another level of Scheme comes into view: its implementation. Knowledge | |
389 | of how Scheme can be implemented turns out to be necessary to become | |
390 | an expert hacker. As Peter Norvig notes in his retrospective on | |
391 | PAIP@footnote{PAIP is the common abbreviation for @cite{Paradigms of | |
392 | Artificial Intelligence Programming}, an old but still useful text on | |
393 | Lisp. Norvig's retrospective sums up the lessons of PAIP, and can be | |
394 | found at @uref{http://norvig.com/Lisp-retro.html}.}, ``The expert Lisp | |
395 | programmer eventually develops a good `efficiency model'.'' | |
396 | ||
397 | By this Norvig means that over time, the Lisp hacker eventually | |
398 | develops an understanding of how much her code ``costs'' in terms of | |
399 | space and time. | |
400 | ||
401 | This chapter describes Guile as an implementation of Scheme: its | |
402 | history, how it represents and evaluates its data, and its compiler. | |
403 | This knowledge can help you to make that step from being one who is | |
404 | merely familiar with Scheme to being a real hacker. | |
8680d53b AW |
405 | |
406 | @menu | |
0f7e6c56 AW |
407 | * History:: A brief history of Guile. |
408 | * Data Representation:: How Guile represents Scheme data. | |
409 | * A Virtual Machine for Guile:: How compiled procedures work. | |
410 | * Compiling to the Virtual Machine:: Not as hard as you might think. | |
8680d53b AW |
411 | @end menu |
412 | ||
413 | @include history.texi | |
3229f68b | 414 | @include data-rep.texi |
8680d53b AW |
415 | @include vm.texi |
416 | @include compiler.texi | |
417 | ||
ca445ba5 AW |
418 | @include autoconf.texi |
419 | ||
c6ae9c77 MV |
420 | @include fdl.texi |
421 | ||
38a93523 NJ |
422 | @iftex |
423 | @page | |
424 | @unnumbered{Indices} | |
425 | @end iftex | |
426 | ||
427 | @include indices.texi | |
9401323e | 428 | @include scheme-indices.texi |
38a93523 | 429 | |
38a93523 | 430 | @bye |