diff options
| -rwxr-xr-x | doc/manual/index.html | 88 | ||||
| -rwxr-xr-x | make/Manifest | 2 | ||||
| -rwxr-xr-x | make/build.xml | 8 | ||||
| -rw-r--r-- | www/index.html | 10 |
4 files changed, 99 insertions, 9 deletions
diff --git a/doc/manual/index.html b/doc/manual/index.html index d2f1be5..aea36e3 100755 --- a/doc/manual/index.html +++ b/doc/manual/index.html @@ -12,7 +12,12 @@ Chapter 1 - Introduction Chapter 2 - Using GlueGen <UL> +<LI> <a href = "#SecAcquiring">Acquiring and Building GlueGen</a> + <UL> + <LI> <a href = "#SecCommon">Common Build Problems</a> + </UL> <LI> <a href = "#SecBasic">Basic Operation</a> +<LI> <a href = "#SecAnt">Running GlueGen as an Ant Task</a> <LI> <a href = "#SecPCPP">PCPP</a> <LI> <a href = "#SecError">Error Reporting</a> <LI> <a href = "#SecStub">Stub Headers</a> @@ -304,11 +309,52 @@ libraries for other languages. </P> +<H2> Chapter 2 - Using GlueGen </H2> + +<H3><a name="SecAcquiring">Acquiring and Building GlueGen</a></H3> + +The source code for GlueGen may be obtained via CVS: + +<pre> + cvs -d :pserver:[email protected]:/cvs co gluegen +</pre> + +To build GlueGen, first download the current ANTLR jar file from <a +href="http://antlr.org/">antlr.org</a>. (NOTE: do not place this jar +file in the Extensions directory of the JRE or JDK, as this will cause +the build to fail.) Next, copy <code>make/gluegen.properties</code> +from the GlueGen workspace to your home directory (pointed to by the +Java system property <code>user.home</code>; on Windows this is +e.g. <code>C:\Documents and Settings\username</code>). Edit the copy +of gluegen.properties in your home directory to point the +<code>antlr.jar</code> property to the location of the ANTLR jar file +on your local disk. Finally, cd to the <code>make/</code> subdirectory +and type "ant". Ant 1.6.x or later is required. + +<H4><a name="SecCommon">Common Build Problems</a></H4> + +<P> + +<dl> +<dt> <strong>CharScanner; panic: ClassNotFoundException: com.sun.gluegen.cgram.CToken</strong> +<dd> This occurs because ANTLR was dropped into the Extensions + directory of the JRE/JDK. On Windows and Linux, delete any ANTLR + jars from jre/lib/ext, and on Mac OS X, delete them from + /Library/Java/Extensions. Use the antlr.jar property in the + build.xml to point to a JRE-external location of this jar file. +</dl> + +</P> + <H3><a name="SecBasic">Basic Operation</a></H3> <P> -GlueGen accepts four kinds of command-line arguments: +GlueGen can be run either as an executable jar file (<code>java -jar +gluegen.jar</code>; note that antlr.jar must be in the same directory +as gluegen.jar in order for this invocation to work) or from within +Ant as described in the following section. When run from the command +line, GlueGen accepts four kinds of command-line arguments: <UL> <LI> -I<em>dir</em> (optional) adds <em>dir</em> to the include path. @@ -342,6 +388,46 @@ GlueGen accepts four kinds of command-line arguments: headers and point GlueGen at the .c file. </UL> +<H3><a name="SecAnt">Running GlueGen as an Ant Task</a></H3> + +<P> + +GlueGen can also be invoked as a subtask within Ant. In order to do +so, a path element should be defined as follows: + +<pre> + <path id="gluegen.classpath"> + <pathelement location="${gluegen.jar}" /> + <pathelement location="${antlr.jar}" /> + </path> +</pre> + +where the <code>gluegen.jar</code> and <code>antlr.jar</code> +properties point to the respective jar files. A taskdef defining the +GlueGen task should then be specified as follows: + +<pre> + <taskdef name="gluegen" + classname="com.sun.gluegen.ant.GlueGenTask" + classpathref="gluegen.classpath" /> +</pre> + +At this point GlueGen may be invoked as follows: + +<pre> + <gluegen src="[header to parse]" + config="[configuration file]" + includeRefid="[dirset for include path]" + emitter="com.sun.gluegen.JavaEmitter"> + <classpath refid="gluegen.classpath" /> + </gluegen> +</pre> + +Please see the <a href="http://jogl.dev.java.net/">JOGL</a> and <a +href="http://joal.dev.java.net/">JOAL</a> build.xml files for +concrete, though non-trivial, examples of how to invoke GlueGen via +Ant. + <H3><a name="SecPCPP">PCPP</a></H3> <P> diff --git a/make/Manifest b/make/Manifest new file mode 100755 index 0000000..1677feb --- /dev/null +++ b/make/Manifest @@ -0,0 +1,2 @@ +Main-Class: com.sun.gluegen.GlueGen +Class-Path: antlr.jar diff --git a/make/build.xml b/make/build.xml index 440d194..2557fac 100755 --- a/make/build.xml +++ b/make/build.xml @@ -139,7 +139,7 @@ </javac> <!-- Build gluegen.jar. --> - <jar destfile="${build}/gluegen.jar"> + <jar destfile="${build}/gluegen.jar" manifest="Manifest"> <fileset dir="${classes}"> <include name="**/*.class" /> </fileset> @@ -151,6 +151,12 @@ <include name="com/sun/gluegen/runtime/*.class" /> </fileset> </jar> + + <!-- Copy antlr.jar into build directory for convenience so + gluegen.jar can be run via "java -jar". antlr.jar is + referenced via a Class-Path entry in the Manifest of + gluegen.jar. --> + <copy file="${antlr.jar}" todir="${build}" /> </target> <target name="all" depends="gluegen.build" /> diff --git a/www/index.html b/www/index.html index fb6e76b..fcbae7b 100644 --- a/www/index.html +++ b/www/index.html @@ -25,18 +25,14 @@ interface to the OpenAL audio library. </P> -<h4> Documentation and Source Code </h4> +<h4> Documentation </h4> <P> -The source code for GlueGen can be obtained via CVS: -<pre> - cvs -d :pserver:[email protected]:/cvs co gluegen -</pre> - The preliminary <a href="https://gluegen.dev.java.net/unbranded-source/browse/*checkout*/gluegen/doc/manual/index.html?rev=HEAD&content-type=text/html">GlueGen -manual</a> is also on-line. +manual</a> is on-line, which describes how to acquire, build and use +GlueGen. </P> |