Compiling X-Smiles

General

X-Smiles can be compiled with any jdk 1.1 - 1.3 compatible java compiler (*). The development team has succesfully used javac 1.1-1.3 from Sun and jikes 1.2 from IBM.

You can either pull down the developement tree from the CVS or download and unpack both the bin and src packages to the same directory. Go to the src directory and execute either build.bat or build.sh depending on your platform. Build.sh can also be used in Windows with the CYGWIN package.

We use the 'ant' build system from the Apache's Jakarta project.

The following ant build targets are supported:

      X-Smiles Build instructions
      -------------------------------------------------------------

       available targets are:

         compile  --> compiles the source code
         compile-debug  --> compiles the source code with debug
         compile-jdk11  --> compiles the source code for jdk11
         docbook      --> generates the docbook documentation.  
         run      --> run x-smiles
         jar      --> generates the jar file
         jar-ipaq --> generates jar file optimized for iPaq
         jar-smil --> generates the SMIL jar file
         jar-teletext --> generates the Teletext browser jar file
         jar-jxta --> generates the Jaxta MLFC + libs jar file
         javadoc  --> generates the API documentation (needs Java 1.2 or higher)
         pack-demo --> generates the demo distributions (zip)
         pack-src --> generates the source/doc distributions (zip)
         pack-bin --> generates the binary distributions (zip)
         pack-installer --> generates the installer exe on windows
         pack-all       --> generates the binary, demo and source distributions
         clean    --> cleans up all generated files and directories
         run-tests    --> compiles and runs all the tests
         run-tests-html    --> compiles and runs all the tests and generates html summary
         usage    --> provides help on using the build tool (default)

       See comments inside the build.xml file for more details.
      -------------------------------------------------------------

(*) The SVG MLFC cannot be compiled with java 1.1.

Eclipse SDK

Download and install JDK 5.0 from http://java.sun.com/
Download and install JMF from http://java.sun.com/products/java-media/jmf/
Download latest Eclipse milestone (e.g. 3.1M4) from http://www.eclipse.org.
Install Eclipse.
Start Eclipse. Create the Workspace directory to your home dir and not to eclipse installation dir. Go to workbench.
Set up cvs.tml.hut.fi CVS .
- Window -> Perspective -> CVS repository
- Add CVS repository
- Host: cvs.tml.hut.fi
- Repository path: /cvs
- User: anonymous or your CVS user
- Passwd: anonymous or your CVS passwd
- Connection type: ext or extssh
  - The "ext" connection method can be configured on the Team/CVS/EXT Connection Method preference page<>
Pull X-Smiles project from CVS:
- Open HEAD, go to "xsmiles"
- Right-click and select: Check out as...
- select "Check out as a new project configured using the new project wizard"
- select "HEAD"
- select "JAva project"
- Project name: xsmiles
- select "Create separate source and output folders"
- Click "Finish", the project will be pulled from the CVS
Configure/compile project
- After x-smiles has been downloaded from the CVS, open the java perspective
- right click xsmiles, and select "Properties"
- Source tab - add the xsmiles/src/xsmiles dir as a source dir
- Source tab - select output folder to be xsmiles/build
- Libraries - add all jar's from xsmiles/bin/lib and xsmiles/bin/lib/endorsed
- Order tab: set xerces.jar, xml-apis.jar and xalan.jar on top, before the JDK classes
- Click "ok" and eclipse will start building x-smiles
- If you get errors about javax.media., open Properties again and add jmf.jar from your jmf installation to "Libraries" tab
Run X-Smiles
- Create a new run profile
- Select fi.hut.tml.xsmiles.gui.gui2.swing.KickStartSwing as the main class
- select xsmiles/bin as the working directory
- set VM option: "-Djava.endorsed.dirs=lib/endorsed "
- Run X-SMiles

(Eclipse Instructions written by Mikko Honkala)

Forte 3.0 - Sun One Forte 4.0

It is possible to build X-Smiles using Forte. Follow these steps:

Open project manager and create a project called X-Smiles
Open filesystems tab and add:
- X-Smiles src dir
- X-Smiles build dir
- Every Jar file from bin/lib
Open Project Settings
- Set target to xsmiles build directory for all compiler types
Select all files that you dont want to compile (mlfc/signature, mlfc/comm, mlfc/x3d, messaging/JMSMessaging) and open properties page (right mouse) and set compilation to 'Do not compile'

Windows

TBD: There is a script 'build.bat' in the bin directory of the X-Smiles installation. You must have the environment variable JAVA_HOME set to point to your jdk home directory.

Use 'build.bat usage' to view the possible build targets.

For example 'build jar' will compile the whole source code and build the xsmiles.jar file.

Any Java IDE could also be used to compile X-Smiles.

Linux

As with windows, with the exception that the ant start script is called 'build.sh'.

Sending patches

You are encouraged to send patches to the developers list. See this document for information on how to create patches.

Problems ?

Please see the FAQ for common problems and solutions.