blob: 5097ec7d9353e83dc0d538625c4c85178da60d47 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
-*- outline -*-
* Overview
This directory includes an example program for extending Guile with a
new (and even useful) data type, putting it into a shared library, so it
can be called from an unmodified guile interpreter. Further, the shared
library defines a new guile module.
* Build Instructions
To build the example, simply type
make libbox-module
in this directory.
* The Box Data Type
A box is simply an object for storing one other object in. It can be
used for passing parameters by reference, for example. You simply
store an object into a box, pass it to another procedure which can
store a new object into it and thus return a value via the box.
** Usage
Box objects are created with `make-box', set with `box-set!' and
examined with `box-ref'. Note that these procedures are placed in a
module called (box-module) and can thus only be accessed after using
this module. See the following example session for usage details.
** The Module (box-module)
Extend your LD_LIBRARY_PATH variable (or equivalent) to include . and
.libs and make sure that your current working directory is the one
this file is contained in.
$ guile
guile> (use-modules (box-module))
guile> (define b (make-box))
guile> b
#<box #f>
guile> (box-set! b '(list of values))
guile> b
#<box (list of values)>
guile> (box-ref b)
(list of values)
guile> (quit)
$
** The Module (box-mixed)
The following example uses the module (box-mixed), also included in
this directory. It uses the shared library libbox-module like the
module (box-module) above, but does not export the procedures from
that module. It only implements some procedures for dealing with box
objects.
$ guile
guile> (use-modules (box-mixed))
guile> (define bl (make-box-list 1 2 3))
guile> bl
(#<box 1> #<box 2> #<box 3>)
guile> (box-map (lambda (el) (make-box-list (list el))) bl)
(#<box (#<box (1)>)> #<box (#<box (2)>)> #<box (#<box (3)>)>)
guile> (quit)
$
If you like this example so much that you want to have it available
for normal usage, install the dynamic libraries in the .libs directory
to the directory $(prefix)/lib and the scheme file `box-module.scm' in
a directory in your GUILE_LOAD_PATH.
|
