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