How to build JOGL

How to build GlueGen
How to build GlueGen

## Platform and Component Requirements

Here is a list of platforms and components, we were able to build GlueGen on,
if not stated otherwise.

- Java
  A Java 1.6 compliant SDK.
- Ant 1.9.0 or later
- Git 1.6.0 or later
  - Use your Unix distribution's version, if available, or
  - Source Code for GNU/Linux, MacOSX, .., or
  - Git on Windows
    - cygwin
    - msysgit
  - git-osx-installer
- GNU Linux x86, 32- and 64-bit
  You may have to install a few developer packages ...
  - Debian 5.00 or later
    - openjdk-7-jre
    - openjdk-7-jdk
    - ant
    - git
    - p7zip-full
    - gcc
    One liner install command:

        apt-get install openjdk-7-jre openjdk-7-jdk ant git-all p7zip-full gcc

    Optional: Add kernel build utilities:

        apt-get install kernel-package build-essential

    Optional: Add multiarch i386 next to amd64
    - Debian 7.00

          dpkg --add-architecture i386
          apt-get update
          apt-get install ia32-libs ia32-libs-gtk gcc-multilib lib32gcc1 lib32gomp1 lib32itm1 lib32quadmath0 libc6-i386 ibc6-dev-i386 g++-multilib lib32stdc++6 openjdk-7-jre:i386 openjdk-7-jdk:i386

    - Debian 8.00

          dpkg --add-architecture i386
          apt-get update
          apt-get install lib32z1 lib32ncurses5 lib32bz2-1.0 gcc-multilib lib32gcc1 lib32gomp1 lib32itm1 lib32quadmath0 libc6-i386 libc6-dev-i386 g++-multilib lib32stdc++6 openjdk-7-jre:i386 openjdk-7-jdk:i386

  - OpenSuSE 10.2 or later
    - openjdk-7-jre
    - openjdk-7-jdk
    - ant
    - git
    - p7zip-full
    - gcc
  - CentOS / Red Hat Enterprise Linux 5.4 or later
    - openjdk-7-jre
    - openjdk-7-jdk
    - ant
    - git
    - p7zip-full
    - gcc
- OpenSolaris SPARC and x86, 32- and 64-bit
  - OpenSolaris 2009.06 or later
- MacOSX Intel
  - git, see above
  - Mac OS X 10.3 (note: will not work with earlier releases)
  - Xcode for gcc, etc (included in OSX)
- Windows/x86 (32 bit)
  - Windows XP or later
  - git, see above
  - MinGW64
    - Installer
      - mingw-build-install
      - version: 4.8.1
      - host: x32
      - threading: win32
      - exceptions: SJLJ
      - revision: 5
    - or manual via 7z archive file
- Windows/x86_64 (64-bit)
  - Windows XP or later
  - git, see above
  - MinGW64
    - Installer
      - mingw-build-install
      - version: 4.8.1
      - host: x64
      - threading: win32
      - exceptions: SJLJ
      - revision: 5
    - or manual via 7z archive file

Additional platforms such as FreeBSD and HP/UX are handled by the build system, but are not officially supported.

## Build Steps

Here are the steps that are required in order to build JOGL.

1. Optain the source code using git:
   - Gluegen Dev GIT Repo
   It is crucial that you checkout the source code under a common root directory:

           /home/dude/projects/jogamp> git clone --recurse-submodules git://jogamp.org/srv/scm/gluegen.git gluegen

   Now you should have following directory structure:

           /home/dude/projects/jogamp
           /home/dude/projects/jogamp/gluegen

   Note-1: The GlueGen source must be fetched using -recurse-submodules, which imports JCPP, now used as the default C preprocessor.

2. Unset your CLASSPATH environment variable:
   The Ant build requires that the JOGL jars not be visible on the classpath. On Unix, type `unsetenv CLASSPATH` into a csh or tcsh shell, or `unset CLASSPATH` into a Bourne shell. On Windows, type `set CLASSPATH=` into a command prompt.
3. Optional Copy and edit gluegen.properties:
   To specify different basic options for components and compilers,
   copy gluegen/make/gluegen.properties into your home directory (pointed to by the Java system property user.home).
4. Build the source tree:
   Open a command shell in the "gluegen/make" directory of the source tree and type `"ant"`.
5. Test your build:
   Stay in your command shell in the "gluegen/make" directory of the source tree and type `"ant junit.run"`.
6. Build Javadoc:
   Stay in your command shell in the "gluegen/make" directory of the source tree and type "`ant javadoc"`. This will produce the end-user documentation for JOGL along with some auxiliary utility packages.

Note that there might be a few warnings produced by ANTLR about the C grammar and our modifications to some of the signatures of the productions; the C grammar warnings have been documented by the author of the grammar as having been investigated completely and harmless, and the warnings about our modifications are also harmless.

## Common build problems

1. Your CLASSPATH environment variable appears to be set (some GlueGen classes are currently visible to the build.), and $CLASSPATH isn't set. An older version of GlueGen was installed into the extension directory of the JDK you're using to build the current GlueGen. On Windows and Linux, delete any ANTLR jars from jre/lib/ext, and on Mac OS X, delete them from /Library/Java/Extensions. It is generally not a good idea to drop GlueGen directly into the extensions directory, as this can interfere with upgrades via Java Web Start.
2. CharScanner; panic: ClassNotFoundException: com.sun.gluegen.cgram.CToken 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.

- Christopher Kline and Kenneth Russell, June 2003 (revised November 2006)
- Sven Gothel and Michael Bien, May 2010
- Sven Gothel, March 2010 (Extracted version from JOGL)