summaryrefslogtreecommitdiff
path: root/README.org
blob: dd7144dddbb6f3f011626358f8400874d3bcda89 (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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
#+LINK: oj-source-forge https://sourceforge.net/projects/openjava/
README
OpenJava 1.1 build 20030219
Feb 19, 2003
by Michiaki Tatsubori  mich@acm.org


OpenJava is an extensible language based on Java(TM). The OpenJava MOP
(Metaobject Protocol) is the extension interface of the language.
Through the MOP, the programmers can customize the language to
implement a new language mechanism.

OpenJava helps people who want to develop better Java libraries, that
is, easy-to-use and efficient ones.  It also helps people who are
developing their own extended Java languages.  OpenJava can be regarded
as a toolkit for constructing a Java preprocessor.


** How to set up OpenJava

This directory contains the OpenJava version 1.0a release in both source
and bytecode form.  You should find the following files and subdirectories
in this release:

   README        This file.
   COPYRIGHT     Copyright notices are described in this text file.
   src/          OpenJava source files in Java-packaged form.
   classes/      OpenJava bytecode files in Java-packaged form.
   htdocs/       OpenJava API in HTML format.
   bin/          Shell scripts useful to use OpenJava system.
   tutorial/     Tutorial files in HTML format containing some examples of
                 meta-programming in the example subfolder.
   docs/         Other notes.


To set up, you must do either 1) or 2)
1) Set CLASSPATH environment variable to include 'classes' directory.
2) Use ojc (for solaris), ojc.sh (for unix), or ojc.exe (for windows
with cygwin) command in bin directory.

Additionally, make sure that your Java compiler is in your PATH as the
name 'javac'.  Otherwise OpenJava compiler fails to generate bytecode.


** How to run

The detailed explanation is shown in the programmer's guide above.
The execution way is similar to :

    $ java openjava.ojc.Main sourcecode.oj

or :

    solaris% bin/ojc.ksh sourcecode.oj
    linux$ bin/ojc.sh sourcecode.oj
    windows> bin/ojc.bat sourcecode.oj

For example, type in the top directory,

    $ java -classpath .:classes openjava.ojc.Main \
    examples/verbose/VerboseClass.oj
    $ java -classpath .:classes openjava.ojc.Main \
    examples/verbose/Hello.oj


** Contact

This is an alpha-test release of the OpenJava and is designed to run
under the JDK 1.1 or 1.2 and Java compiler.  The detailed specifications
of OpenJava might change in future.  If you have any comment or find
bugs, please contact the author at :

    mich@acm.org

The OpenJava home page, where the latest information regarding
OpenJava and other documents around OpenJava are available, is at :

    http://openjava.sourceforge.net/


Enjoy,

Michiaki Tatsubori
mich@acm.org


Java(TM) is a trademark of Sun Microsystems, Inc.

** Maintenance

This is a mostly unmodified version of the original code from
[[oj-source-forge][OJ project on SourceForge]], however, slightly updated and
hopefully eventually mirrored on Maven central.

Bugs may be submitted, but it would be preferred if you can fix them and submit
patches.  I do not intend necessarily intend this to be a new home for this
project.