Framesoc development environment setup

Summary

This page describes how to configure a working Eclipse Plugin Development Environment for Framesoc. The procedure described has been tested under Eclipse Kepler and Luna. For other versions of Eclipse, some changes could be necessary.

Requirements

• Java JDK 7 or 8
  • You can download it from: http://www.oracle.com/technetwork/java/javase/downloads/index.html
• [optional] MySQL server (optional, since Framesoc uses by default SQLite, which is an embedded DBMS)

System setup

After cloning the git repository, follow these steps:

• Install the latest version of 'Eclipse for RCP and RAP Developers' (version Luna 4.4.2 recommended)

  • Download the package suitable for your architecture at http://www.eclipse.org/downloads/
  • Extract it
  • Go in the eclipse folder and launch the executable
    • The first time you launch Eclipse, a Welcome page is displayed. You can simply close it as any other view or click on Workbench (top right).

• Install the Tycho m2e connector

  • Window -> Preferences -> Maven -> Discovery
  • Press the Open Catalog button
  • Activate the Tycho Configurator
  • Click on Finish and follow the installation instructions

  If the Tycho Configurator is not present in the Catalog, you can still install it using the update site:

  • From the Eclipse main menu: Help > Install New Software...
  • Type the following address in the text field Work with:
    • http://repo1.maven.org/maven2/.m2e/connectors/m2eclipse-tycho/0.8.0/N/LATEST/
  • Select the Tycho Configurator
  • Press Next and follow the wizard (accept the license and finish the installation).
  • At the end of the installation, Eclipse will ask for restart.

• Import in the Eclipse workspace all the plugins contained in the repository src directory

  • Launching Eclipse for the first time you will be asked to set a workspace:
    • Choose a folder which is outside the repository
  • Import the Framesoc plugins
    • File -> Import -> General -> Existing Projects into Workspace
    • Set the repository src as root directory
    • Be sure that all projects folders are checked
    • Do not check Copy projects into workspace
    • Press Finish

• Also import in the Eclipse workspace the plugins available in the framesoc.importers repository

  • clone this repository
  • do the same as before to import the plugins in the Eclipse workspace
    • note that the framesoc.importers plugins are directly in the repository root directory: there is no intermediate src directory.

• Build all the plugins

  • Project -> Clean... (be sure that Build Automatically is checked)
  • Choose Clean all projects
  • Press Ok

• Launch the Framesoc Eclipse Application

  • Right click on the fr.inria.soctrace.framesoc.core plugin
  • Run As -> Eclipse Application

Java Heap Issue

In order to be able to use Framesoc, you might need to increase the maximum amount of memory available for the JVM, setting it to at least 4096 MB for best performance. To do this, you need to:

• Go to Run -> Run Configurations...
• Select the entry on the left corresponding to the Eclipse Application launch configuration you created when launching Framesoc for the first time.
• Select the Arguments tab.
• Add (or modify) the -Xmx argument in the VM arguments text box, with the following: -Xmx4096m

Using Eclipse working sets

Having to work with several plugins from different repositories (framesoc, framesoc.importers) it could be useful to use the working sets in the Project Explorer. A convenient configuration could be to create one working set for each repository.

Start Developing

The wiki of the Framesoc tutorials repository offers several tutorials and examples explaining how to develop a tool plugin for Framesoc.