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
  - Build & Runtime: An OpenJDK 17 compliant SDK.
  - Runtime: An OpenJDK 8 compliant JRE.
  You may find an appropriate OpenJDK build @ Adoptium.
  Or you may try one of the following SDK's and/or Runtimes:
  - Azul's Zulu (active, +embedded)
  - Avian (inactive, not tested)
- Ant 1.10.5 or later
- Git 2.0.4 or later
  - Use your Unix distribution's version, if available, or
  - Source Code for GNU/Linux, MacOS, .., or
  - Git on Windows is provided by cygwin
  - Git ≥ 2.37 provided by Xcode ≥ 14
- FreeBSD x86, 32- and 64-bit, ...
  - FreeBSD 12 or later (todo: test)
    - openjdk17
    - ant
    - git
    - awk
    - p7zip-full ???
    - gcc
    - cmake
- GNU Linux x86_64 as well as Arm64, etc
  You may have to install a few developer packages ...
  - Debian 11 or later
    - openjdk-17-jre
    - openjdk-17-jdk
    - ant
    - git
    - gawk
    - p7zip-full
    - gcc
    - cmake
    One liner install command:
    - Debian 11 Bullseye

          apt-get install openjdk-17-jre openjdk-17-jdk ant git-all gawk p7zip-full gcc cmake

    Optional: Add kernel build utilities:

        apt-get install kernel-package build-essential

  - OpenSuSE 15.0 or later
    - java-17-openjdk
    - ant
    - git
    - gawk
    - p7zip-full
    - gcc
    - cmake
  - CentOS 7 / Red Hat Enterprise Linux 7.6 or later
    - java-17-openjdk
    - ant
    - git
    - gawk
    - p7zip-full
    - gcc
    - cmake
- Android/Linux Version 7.0 Nougat API Level 24 or later
  - any of the above GNU/Linux x86_64 hosts for crosscompilation
  - android ndk (todo: detail instructions)
  - android sdk (todo: detail instructions)
- OpenSolaris Derivatives SPARC and x86, 32- and 64-bit
  - OpenIndiana using illumus's OpenSolaris continuation (todo: test)
- MacOS and iOS x86_64 and aarch64
  - Build machine: Mac OS 12.6.5 (Monterey)
    - Lowest test machine: Mac OS 10.13.6 (High Sierra)
    - Minimum deployment target: Mac OS 10.7 (Lion)
  - Xcode 14.2 for clang, etc (included in MacOS)
  - MacOS SDK 11.3 from a previous XCode version or from this alternative site
    - export SDKROOT=macosx11.3
    - We use -mmacosx-version-min=10.7 (Lion 10.7) minimum deployment target.
  - git ≥ 2.37 provided by Xcode ≥ 14
  - awk is provided by MacOS
  - CMake 3.25.1, and install the command line tools
    - Install symlinks to /usr/local/bin, run: sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install
  - 7-Zip 21.07 x86_64 and arm64 version
  - See also MacOS Versions Related to JogAmp
  Prepare fat universal OpenJDK libraries
  - Open a terminal in your home folder, e.g. /Users/jogamp
  - The OpenJDK library folder of each target platform, x86_64 or aarch64, is /Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home/lib
  - Transfer the x86_64 OpenJDK library folder to temurin-17.jdk.amd64.lib
  - Transfer the aarch64 OpenJDK library folder to temurin-17.jdk.arm64.lib
  - Run the script gluegen/make/scripts/make.macosx.jdk_lipo_libs.sh
  - Fat universal OpenJDK libraries are produced into temurin-17.jdk.fat.lib
  Now we have to tell the gluegen build framework to use temurin-17.jdk.fat.lib, by adding an ant macro in $HOME/gluegen.properties

                                      java.lib.dir.platform=/Users/jogamp/temurin-17.jdk.fat.lib

  Replace jogamp with your user name.
- Windows/x86_64 (64-bit)
  - Windows 7 or later
  - git is provided by cygwin
  - gawk is provided by cygwin
  - MinGW64 (files on github)
    - x86_64-12.2.0-release-posix-seh-msvcrt-rt_v10-rev2.7z
      - version: 12.2.0
      - host: x64
      - threading: posix
      - exceptions: seh
      - c-runtime: msvcrt
      - revision: 2
    - x86_64-12.2.0-release-win32-seh-msvcrt-rt_v10-rev2.7z
      - version: 12.2.0
      - host: x64
      - threading: win32
      - exceptions: seh
      - c-runtime: msvcrt
      - revision: 2
  - CMake 3.25.1 64bit version
  - 7-Zip 22.01 64bit version

CMake has been added here for JOAL and JOGL.

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 GlueGen.

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 GlueGen 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 invoke `ant` with the given properties as follows

           cd /home/dude/projects/jogamp/gluegen/make/
           ant -Dtarget.sourcelevel=1.8 -Dtarget.targetlevel=1.8 -Dtarget.rt.jar=/your/openjdk8/lib/rt.jar

   Alternatively you can also use environment variables instead of properties

           export SOURCE_LEVEL=1.8
           export TARGET_LEVEL=1.8
           export TARGET_RT_JAR=/your/openjdk8/lib/rt.jar
           ant

   Optionally you can also set certain build features via properites or environment variables

           Feature                Property                          or Environment Variable
           developer-zip-archive: build.archiveon=true                 BUILD_ARCHIVE=true
           Native Debug Code:     c.compiler.debug=true
           Java Debug Code:       javacdebuglevel="source,lines,vars"

5. Test your build:
   Stay in your command shell in the "gluegen/make" directory of the source tree and invoke `ant` with above properties or environment variables and use the target `junit.run`.
6. Build Javadoc:
   Stay in your command shell in the "gluegen/make" directory of the source tree and invoke `ant` with above properties or environment variables and use the target `javadoc`. This will produce the end-user documentation for GlueGen 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.jogamp.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)