SDK_Build_Environment_for_J2SE_Platform

SDK Build Environment for J2SE Platform

This page discusses how to build the Magic Lantern SDK for Java Standard Edition platforms using Eclipse and Ant.

• SDK Build Environment for J2SE Platform
  • Dependencies
  • Assumptions
  • Environment Variables
    • MLE_HOME Environment Variable
      • Windows Host
      • Linux Host
    • MLE_ROOT Environment Variable
      • Windows Host
      • Linux Host
    • MLE_WORKPRINTS Environment Variable
      • Windows Host
      • Linux Host
  • Details
    • Eclipse Build Environment
    • Construct Jar Packages
      • Windows Host
      • Linux Host
    • Ant Build Environment

Dependencies

This section identifies dependencies for building the Magic Lantern SDK.

1. Eclipse for RCP/Plug-in Developers, version 3.5.2
2. Apache Ant, version 1.8.0
3. Oracle Java Development Kit (JDK), version 1.6.0_16

Assumptions

These instructions assume the following

• The dependencies above are installed under a Windows drive labeled "M" (e.g. M:).
• The Magic Lantern software has been downloaded into the "M:\projects\MagicLantern" directory and the MLE_HOME environment variable is set to "M:\projects\MagicLantern".
• You already know how to use the Eclipse IDE
• You already know how to create and use Ant build scripts

Environment Variables

MLE_HOME Environment Variable

Windows Host

Set the variable MLE_HOME to reference the home of the Magic Lantern source. This document assumes that it is set to "M:\projects\MagicLantern".

Linux Host

Set the variable MLE_HOME to reference the home of the Magic Lantern source. This document assumes that it is set to "$HOME/projects/MagicLantern".

MLE_ROOT Environment Variable

Windows Host

Set the variable MLE_ROOT to reference the root directory where the Magic Lantern components will be installed. This document assumes that it is set to "M:/projects/MagicLantern".

Note that this variable uses the UNIX-style path delimiter ('/').

Linux Host

Set the variable MLE_ROOT to reference the root directory where the Magic Lantern components will be installed. This document assumes that it is set to "/opt/MagicLantern".

MLE_WORKPRINTS Environment Variable

Windows Host

Set the variable MLE_WORKPRINTS to the root directory where Magic Lantern Digital Workprints can be located. This document assumes that it is set to //M/projects/MagicLantern.

The Magic Lantern Studio assumes that the Digital Workprints will be located under the $MLE_WORKPRINTS/workprints directory.

Note that this variable uses a canonical path style for the drive (i.e. //M/).

Linux Host

Set the variable MLE_WORKPRINTS to the root directory where Magic Lantern Digital Workprints can be located. This document assumes that it is set to $HOME/projects/MagicLantern.

Details

This section discusses how to build the Magic Lantern SDK components targeting the Java Standard Edition (J2SE) platform. The Magic Lantern SDK is comprised of the following components:

Component	Description	Location
com.wizzer.mle.runtime	The Magic Lantern Runtime Engine	$(MLE_HOME)\Core\mlert\java\com.wizzer.mle.runtime
com.wizzer.mle.math	The Magic Lantern Math Library	$(MLE_HOME)\Core\math\java\com.wizzer.mle.math
com.wizzer.mle.parts	The Magic Lantern Core Parts Library	$(MLE_HOME)\Parts\base\java\com.wizzer.mle.parts
com.wizzer.mle.parts.actors	The Magic Lantern Core Actor Library	$(MLE_HOME)\Parts\actors\java\com.wizzer.mle.parts.actors
com.wizzer.mle.parts.props	The Magic Lantern Core Property Library	$(MLE_HOME)\Parts\props\java\com.wizzer.mle.parts.props
com.wizzer.mle.parts.roles	The Magic Lantern Core Role Library	$(MLE_HOME)\Parts\roles\java\com.wizzer.mle.parts.j2d
com.wizzer.mle.parts.mrefs	The Magic Lantern Core Media Reference Library	$(MLE_HOME)\Parts\mediaref\java\com.wizzer.mle.parts.mrefs
com.wizzer.mle.parts.sets	The Magic Lantern Core Set Library	$(MLE_HOME)\Parts\sets\java\com.wizzer.mle.parts.sets
com.wizzer.mle.parts.stages	The Magic Lantern Core Stage Library	$(MLE_HOME)\Parts\stages\java\com.wizzer.mle.parts.stages

Eclipse Build Environment

This section describes how to use Eclipse to build the Magic Lantern SDK for the J2SE Platform.

Each component provides an Eclipse project to facilitate building the component in Eclipse. To build a component, use the following instructions:

1. From the main Eclipse toolbar, select the "File->Import..." menu entry. This will display the Import dialog.
2. Select the "Existing Projects into Workspace" entry found under the General category.
3. Select the "Next>" button in the Import dialog. The dialog should now be displaying the "Import Projects" page.
4. Select a directory to search for existing Eclipse projects. Use the the "Browse..." button.
5. The "Projects:" widget should now be showing you list of existing projects that are rooted in the directory specified in the above step. Select the project(s) of interest.
6. To wrap-up the import, select Finish. The project will now be added to your Eclipse Workspace.

By default, Eclipse will build the component when the project is imported.

Construct Jar Packages

Windows Host

The .jar files can be constructed by using the Eclispe Jar descriptors provided with the above Eclipse projects.

Component	Jar Descriptor	Location
com.wizzer.mle.runtime	mlert.jardesc	M:/projects/MagicLantern/lib/runtime/mlert.jar
com.wizzer.mle.math	mlmath.jardesc	M:/projects/MagicLantern/lib/runtime/mlert.jar
com.wizzer.mle.parts	parts.jardesc	M:/projects/MagicLantern/lib/runtime/parts.jar
com.wizzer.mle.parts.actors	actors.jardesc	M:/projects/MagicLantern/lib/runtime/actors.jar
com.wizzer.mle.parts.props	parts.desc	M:/projects/MagicLantern/lib/runtime/parts.jar
com.wizzer.mle.parts.roles	roles.desc	M:/projects/MagicLantern/lib/runtime/roles.jar
com.wizzer.mle.parts.mrefs	mrefs.desc	M:/projects/MagicLantern/lib/runtime/mrefs.jar
com.wizzer.mle.parts.sets	sets.desc	M:/projects/MagicLantern/lib/runtime/sets.jar
com.wizzer.mle.parts.stages	stages.desc	M:/projects/MagicLantern/lib/runtime/stages.jar

Linux Host

The .jar files can be constructed by using the Eclispe Jar descriptors provided with the above Eclipse projects.

Component	Jar Descriptor	Location
com.wizzer.mle.runtime	mlert-linux.jardesc	$HOME/projects/MagicLantern/lib/java/mlert.jar
com.wizzer.mle.math	mlmatht-linux.jardesc	$HOME/projects/MagicLantern/lib/java/mlert.jar
com.wizzer.mle.parts	partst-linux.jardesc	$HOME/projects/MagicLantern/lib/java/parts.jar
com.wizzer.mle.parts.actors	actorst-linux.jardesc	$HOME/projects/MagicLantern/lib/java/actors.jar
com.wizzer.mle.parts.props	partst-linux.desc	$HOME/projects/MagicLantern/lib/java/parts.jar
com.wizzer.mle.parts.roles	rolest-linux.desc	$HOME/projects/MagicLantern/lib/java/roles.jar
com.wizzer.mle.parts.mrefs	mrefst-linux.desc	$HOME/projects/MagicLantern/lib/java/mrefs.jar
com.wizzer.mle.parts.sets	setst-linux.desc	$HOME/projects/MagicLantern/lib/java/sets.jar
com.wizzer.mle.parts.stages	stagest-linux.desc	$HOME/projects/MagicLantern/lib/java/stages.jar

Ant Build Environment

This section will describe how to use the Ant build scripts to build the Magic Lantern SDK for the J2SE Platform.