README 7.85 KB
Newer Older
Mark's avatar
Mark committed
1
2
Armed Bear Common Lisp (ABCL) README
====================================
3

4
Armed Bear Common Lisp is a conforming implementation of ANSI X3J13
Mark's avatar
Mark committed
5
6
Common Lisp that runs in a Java virtual machine.  It compiles Lisp
code directly to Java byte code for execution.
7

8

9
LICENSE
Mark's avatar
Mark committed
10
-------
11
12

Armed Bear Common Lisp is distributed under the GNU General Public
13
License with a classpath exception (see "Classpath Exception" below).
14

15
16
A copy of GNU General Public License (GPLv2) is included in this
distribution, in <file:COPYING>.
17

18
We have modified our GPLv2 license section 13 to read:
19

20
21
22
23
     13. Linking this library statically or dynamically with other
     modules is making a combined work based on this library. Thus, the
     terms and conditions of the GNU General Public License cover the
     whole combination.
24

25
26
27
28
29
30
31
32
33
34
35
36
37
38
     The following paragraph details the "classpath exception" which ABCL
     allows as an exception to the statement about linking libraries.

     As a special exception, the copyright holders of this software give
     you permission to link this software with independent modules to
     produce an executable, regardless of the license terms of these
     independent modules, and to copy and distribute the resulting
     executable under terms of your choice, provided that you also meet,
     for each linked independent module, the terms and conditions of the
     license of that module. An independent module is a module which is
     not derived from or based on this software. If you modify this
     software, you may extend this exception to your version of the
     software, but you are not obligated to do so. If you do not wish to
     do so, delete this exception statement from your version.
39

40

41
RUNNING FROM DOCKER
Mark's avatar
Mark committed
42
-------------------
43

44
With [Docker Engine][] installed one may execute:
45

46
    docker build -t YOURID/abcl .
Mark's avatar
Mark committed
47
    docker run -it YOURID/abcl 
48

49
to get something like
50

51
    illin:~/work/abcl$ docker run -it YOURID/abcl
Mark's avatar
Mark committed
52
53
    Armed Bear Common Lisp 1.8.0
    Java 11.0.8 AdoptOpenJDK
54
55
56
57
    OpenJDK 64-Bit Server VM
    Low-level initialization completed in 0.295 seconds.
    Startup completed in 1.425 seconds.
    Type ":help" for a list of available commands.
Mark's avatar
Mark committed
58
    CL-USER(1): (lisp-implementation-version)
Mark's avatar
Mark committed
59
60
61
    "1.8.0"
    "OpenJDK_64-Bit_Server_VM-AdoptOpenJDK-11.0.8+10"
    "x86_64-Mac_OS_X-10.15.7"
62

Mark's avatar
Mark committed
63
64
To install Quicklisp for ABCL in the Docker container run:

Mark's avatar
Mark committed
65
66
    docker run -t YOURID/abcl abcl \
      --batch --load /home/abcl/work/abcl/ci/install-quicklisp.lisp
Mark's avatar
Mark committed
67

68
See <file:Dockerfile> for the build instructions.
69
70
71

[Docker Engine]: https://www.docker.com/products/docker-engine

72

73

74
RUNNING FROM BINARY RELEASE
Mark's avatar
Mark committed
75
---------------------------
76

77
78
79
After you have downloaded a binary release from either [the
distributed Maven POM graph][maven-abcl] or from
[abcl.org][abcl.org-release] archive unpack it into its own
Mark's avatar
Mark committed
80
directory. To run ABCL directly from this directory, make sure the
Mark's avatar
Mark committed
81
82
Java executable (`java`) (Java 6, 7, 8, 11, 13, 14, and 15 are
supported by ABCL 1.7.0) is in your shell's path.
83

Mark's avatar
Mark committed
84
85
86
[maven-abcl]:          <https://mvnrepository.com/artifact/org.abcl/abcl/1.8.0>
[maven-abcl-contrib]:  <https://mvnrepository.com/artifact/org.abcl/abcl-contrib/1.8.0>
[abcl.org-release]:    <http://abcl.org/releases/1.8.0/>
87

88
To start ABCL, simply issue the following command:
89

90
    cmd$ java -jar abcl.jar
91

92
which should result in output like the following
93

Mark's avatar
Mark committed
94
95
    Armed Bear Common Lisp 1.8.0
    Java 11.0.8 AdoptOpenJDK
96
    OpenJDK 64-Bit Server VM
Mark's avatar
Mark committed
97
98
    Low-level initialization completed in 0.222 seconds.
    Startup completed in 1.09 seconds.
99
    Type ":help" for a list of available commands.
100
    CL-USER(1):
101

102
103
Yer now at the interactive ABCL "Read Eval Print Loop" (REPL): hacks
'n glory await.
104

Mark's avatar
Mark committed
105
106

SLIME
107
108
-----

Mark's avatar
Mark committed
109
110
For usage of ABCL with the [Superior Lisp Interaction Mode for
Emacs][slime], one may easily start a Swank listener via:
111
112
113

    (require :asdf)
    (require :abcl-contrib)
Mark's avatar
Mark committed
114
115
    (asdf:load-system :quicklisp-abcl)
    (ql:quickload :swank)
Mark's avatar
Mark committed
116
117
118
    (swank:create-server :dont-close t)

[slime]: https://common-lisp.net/project/slime/
119

120

Mark's avatar
Mark committed
121
122
Building From Source Release
----------------------------
123

124
125
126
ABCL may be built from its source code by executing the build
instructions <file:build.xml> expressed by the venerable Apache Ant
tool.
127

Mark's avatar
Mark committed
128
To build, one must have a Java 6, 7, 8, 11, 13, 14, 15, 16 or 17 Java
Mark's avatar
Mark committed
129
130
131
Development Kit (openjdk) installed locally. Just the Java Runtime
Environment (JRE) isn't enough, as you need the Java compiler
('javac') to compile the Java source of the ABCL implementation.
132

133
Download a binary distribution [Ant version 1.7.1 or greater][ant].
134
135
136
Unpack the files somewhere convenient, ensuring that the 'ant' (or
'ant.bat' under Windows) executable is in your path and executable.

137
[ant]: http://ant.apache.org/bindownload.cgi
138

139
Then simply executing 
140

141
    cmd$ ant
142

143
144
145
from the directory containing the <file:build.xml> instructions will
create an executable wrapper ('abcl' under UNIX, 'abcl.bat' under
Windows).  Use this wrapper to start ABCL.
146

147
148
149
The build may be customized by copying <file:abcl.properties.in> to
<file:abcl.properties>, which will cause Ant to attempt to build
incrementally as well as optimizing the runtime for a contemporary
150
151
64bit desktop/server machine running Java 8 or 11.  The file contains
incomplete documentation on how it may be edited for subsequent
152
153
154
155
156
157
158
159
160
customization.  As an alternative to copying the prototype, if one has
a version of bash locally, one may issue via Ant

    ant abcl.properties.autoconfigure.openjdk.11

or from the shell as

    bash ci/create-abcl-properties.bash openjdk11

Mark's avatar
Mark committed
161
Currently supported platforms are 'openjdk6', 'openjdk7', 'openjdk8',
Mark's avatar
Mark committed
162
163
'openjdk11', 'openjdk13', 'openjdk14', 'openjdk15', 'openjd16', and
'openjdk17'.
164
165


166
167
Using NetBeans
--------------
168

169
170
Alternatively, one may install the [Netbeans visual integrated
development environment][netbeans], which contains both the Java
Mark's avatar
Mark committed
171
172
173
Development Kit as well as the Ant build tool.  The source
distribution contains Netbeans-specific project artifacts under
<file:nbproject> for loading ABCL as a Netbeans project.
174

175
176
177
With Netbeans, one should be able to open the ABCL directory as a
project whereupon the usual build, run, and debug targets as invoked
in the GUI are available.  Use the 'slime' config with a suitably
Mark's avatar
Mark committed
178
179
linked SLIME `swank.asd` ASDF configuration
<file:~/.config/common-lisp/source-registry.conf.d/> to connect a REPL
180
to the NetBeans debug process.
181

182
[netbeans]: http://netbeans.org/downloads/
183

184

Mark's avatar
Mark committed
185
186
Bugs
----
187

Mark's avatar
Mark committed
188
189
Armed Bear Common Lisp strives to be a conforming ANSI X3J13 Common
Lisp implementation.  Any other behavior should be reported as a bug.
190

Mark's avatar
Mark committed
191
192
193
194
ABCL has a [User Manual][manual] stating its conformance to the ANSI
standard, providing a compliant and practical Common Lisp
implementation.

Mark's avatar
Mark committed
195
[manual]: https://abcl.org/releases/1.8.0/abcl-1.8.0.pdf
196
197


198
199
Tests
-----
200

Mark's avatar
Mark committed
201
ABCL 1.8.0 currently fails ~49 out of 21848 total tests, whereas ABCL
202
203
204
1.5.0 failed 48 out of 21708 total tests in the [revised and expanded
ANSI CL test suite][ansi-test] (derived from the tests originally
written for GCL).
205
206

[ansi-test]: git+https://gitlab.common-lisp.net/ansi-test/ansi-test.git
207
208

Maxima's test suite runs without failures.
209

Mark's avatar
Mark committed
210
211
ABCL comes with a test suite.  Consult the output of `ant help.test`
for more information.
212

213

Mark's avatar
Mark committed
214
215
216
217
Support
-------

ABCL has many deficiencies, both known and unknown.  Descriptions,
Mark's avatar
Mark committed
218
tests, and even patches to address them will be gladly accepted.
219

Mark's avatar
Mark committed
220
221
222
Please report problems to the [development mailing list][mailing-list]
or via opening an issue on either the [ABCL trac instance][trac] or
[github][].
223

Mark's avatar
Mark committed
224
225
226
[mailing-list]: https://mailman.common-lisp.net/pipermail/armedbear-devel/
[github]: https://github.com/armedbear/abcl/issues
[trac]: https://abcl.org/trac/
227
228


Mark's avatar
Mark committed
229
Authors
Mark's avatar
Mark committed
230
-------
231

232
On behalf of all ABCL development team and contributors,
233

234
    Mark Evenson
Mark's avatar
Mark committed
235
    Erik Hülsmann
236
    Rudolf Schlatte
237
    Alessio Stalla
238
    Ville Voutilainen
239

240
    alan
Mark's avatar
Mark committed
241
242
    dmiles
    Dmitry Nadezhin
243
    olof ferada
244
245
    pipping
    slyrus
246
    vibhu
247

Mark's avatar
Mark committed
248
    András Simon
Mark's avatar
Mark committed
249
250
    Peter Graves

Mark's avatar
Mark committed
251
252
Have fun!

Mark's avatar
Mark committed
253
October 2020