1 | GENERAL INFORMATION |
---|
2 | =================== |
---|
3 | |
---|
4 | ABCL (Armed Bear Common Lisp) is an implementation of ANSI Common Lisp |
---|
5 | that runs in a Java virtual machine. It compiles its code to Java |
---|
6 | byte code. |
---|
7 | |
---|
8 | |
---|
9 | LICENSE |
---|
10 | ======= |
---|
11 | |
---|
12 | Armed Bear Common Lisp is distributed under the GNU General Public |
---|
13 | License with classpath exception (described below). |
---|
14 | |
---|
15 | A copy of GNU General Public License (GPL) is included in this |
---|
16 | distribution, in the file COPYING. |
---|
17 | |
---|
18 | Linking this software statically or dynamically with other modules is |
---|
19 | making a combined work based on this software. Thus, the terms and |
---|
20 | conditions of the GNU General Public License cover the whole |
---|
21 | combination. |
---|
22 | |
---|
23 | As a special exception, the copyright holders of this software give |
---|
24 | you permission to link this software with independent modules to |
---|
25 | produce an executable, regardless of the license terms of these |
---|
26 | independent modules, and to copy and distribute the resulting |
---|
27 | executable under terms of your choice, provided that you also meet, |
---|
28 | for each linked independent module, the terms and conditions of the |
---|
29 | license of that module. An independent module is a module which is not |
---|
30 | derived from or based on this software. If you modify this software, |
---|
31 | you may extend this exception to your version of the software, but you |
---|
32 | are not obligated to do so. If you do not wish to do so, delete this |
---|
33 | exception statement from your version. |
---|
34 | |
---|
35 | |
---|
36 | BUILDING |
---|
37 | ======== |
---|
38 | |
---|
39 | If you want to build ABCL, you have 3 options. The first option |
---|
40 | applies when you come from a Lisp background. The second and thirds |
---|
41 | options are more appropriate when you come from Java development: |
---|
42 | |
---|
43 | I) Bootstrap ABCL using a Common Lisp implementation Supported |
---|
44 | implementations for this process: SBCL, CMUCL, OpenMCL, Allegro |
---|
45 | CL, LispWorks or CLISP. |
---|
46 | |
---|
47 | II) Use the Ant make-like build tool for Java environments |
---|
48 | The tested lowest working version is Ant 1.7.0. |
---|
49 | |
---|
50 | III) Use the Netbeans 6.x IDE to open ABCL as a project. |
---|
51 | |
---|
52 | |
---|
53 | In both cases you need a supported JDK version (1.5 and 1.6 have been |
---|
54 | tested). Just the JRE isn't enough. |
---|
55 | |
---|
56 | |
---|
57 | |
---|
58 | I. Lisp-based build |
---|
59 | ------------------- |
---|
60 | |
---|
61 | Copy the file 'customizations.lisp.in' to customization.lisp', in the |
---|
62 | directory containing this README file, editing to suit your situation, |
---|
63 | paying attention to the comments in the file. |
---|
64 | |
---|
65 | Start up one of the supported Common Lisp implementations in the |
---|
66 | directory containing this README file. |
---|
67 | |
---|
68 | Load build-abcl.lisp: |
---|
69 | |
---|
70 | (load "build-abcl.lisp") |
---|
71 | |
---|
72 | Then do: |
---|
73 | |
---|
74 | (build-abcl:build-abcl :clean t :full t) |
---|
75 | |
---|
76 | Wait for the build to finish and exit the host Lisp. |
---|
77 | |
---|
78 | Use abcl.bat on Windows or ./abcl on Unix to start ABCL. |
---|
79 | Note: abcl.bat and abcl contain absolute paths, so you'll need |
---|
80 | to edit them if you move things around after the build. |
---|
81 | |
---|
82 | In case of failure in the javac stage, you might try this: |
---|
83 | |
---|
84 | (build-abcl:build-abcl :clean t :full t :batch nil) |
---|
85 | |
---|
86 | This invokes javac separately for each .java file, which avoids running |
---|
87 | into limitations on command line length (but is a lot slower). |
---|
88 | |
---|
89 | |
---|
90 | II. Ant-based build |
---|
91 | ------------------- |
---|
92 | |
---|
93 | With Ant in your path, executing |
---|
94 | |
---|
95 | ant -find build.xml abcl.wrapper |
---|
96 | |
---|
97 | from the directory containing this README file will create an |
---|
98 | executable wrapper ('abcl' under UNIX, 'abcl.bat' under Windows). |
---|
99 | Use this wrapper to start the ABCL Java program. |
---|
100 | |
---|
101 | |
---|
102 | III. Netbeans-based build |
---|
103 | ------------------------- |
---|
104 | |
---|
105 | One should be able to open the project as a project in Netbeans 6.x. |
---|
106 | |
---|
107 | |
---|
108 | BUGS |
---|
109 | ==== |
---|
110 | |
---|
111 | A lot of (renewed) energy has been spent to make ABCL a compliant and |
---|
112 | practically useable Common Lisp implementation. Because of this, ABCL |
---|
113 | 0.0.13 now fails only 50 out of 21702 tests in the ANSI CL test suite. |
---|
114 | Next to that, the fail count of the Maxima test suite has been reduced |
---|
115 | from over 1400 in 0.0.10 to little more than 600 in 0.0.11, to xxx in |
---|
116 | 0.13. |
---|
117 | |
---|
118 | ABCL's CLOS does not handle on-the-fly redefinition of classes |
---|
119 | correctly, and in any event is intolerably slow. There is no support |
---|
120 | for the long form of DEFINE-METHOD-COMBINATION, and certain other |
---|
121 | required CLOS features are also missing. Enough CLOS is there to run |
---|
122 | ASDF and CL-PPCRE, if you're in no hurry. |
---|
123 | |
---|
124 | There is no MOP worth mentioning. |
---|
125 | |
---|
126 | Since this is a early public release, there might be build |
---|
127 | problems as well as runtime bugs. |
---|
128 | |
---|
129 | Please report problems to the j-devel mailing list: |
---|
130 | |
---|
131 | armedbear-j-devel@lists.sourceforge.net |
---|
132 | |
---|
133 | Have fun! |
---|
134 | |
---|
135 | On behalf of all ABCL development team and contributors, |
---|
136 | Erik Huelsmann |
---|
137 | Feburary 21, 2009 |
---|