File	Date	Author	Commit
META-INF	2013-04-08	Martin Lacina	[a48a5a] Bugfix: Fixed order of Jar files loaded for inv...
icons	2013-02-24	Martin Lacina	[529b36] Modified evaluation results main page to show s...
lib	2013-01-15	Jaroslav Kotrc	[cba34d] Merge remote-tracking branch 'origin/master'
src	2013-04-08	Martin Lacina	[a48a5a] Bugfix: Fixed order of Jar files loaded for inv...
src-xtext	2013-04-04	Martin Lacina	[9ed6dc] Bugfix: Fixed content assist for methods.
.classpath	2013-01-15	Jaroslav Kotrc	[cba34d] Merge remote-tracking branch 'origin/master'
.gitignore	2013-03-13	Martin Lacina	[7c6625] Added Javadoc, removed some commented code.
.project	2012-08-27	Martin Lacina	[aae4cf] Merge branch 'XtextEditors'
build.properties	2012-11-14	Martin Lacina	[a8b4a1] Released as version 0.1.5.b20121114_01.
licence.txt	2012-08-27	Martin Lacina	[aae4cf] Merge branch 'XtextEditors'
overview.html	2013-03-20	Martin Lacina	[7e5ab4] Added overview page for JavaDoc.
plugin.xml	2013-01-19	Martin Lacina	[4fefc6] Added New SPL Tools XML/INI configuration file ...
readme.txt	2013-03-20	Martin Lacina	[7e5ab4] Added overview page for JavaDoc.

Read Me

Last modification: 2013-01-21
Author: Martin Lacina

Plug-in contains:
 SPL Annotations Overview 
  - Gets all SPL annotations (cz.cuni.mff.spl.SPL)
    from source file opened in active Java editor in Eclipse and shows them.
  - Dialogs for adding generator/method aliases and formulas.
  - Editor of selected annotation.

 SPL Results Overview
  - Allows to explore SPL results.
  - Supports dynamic graphs for comparisons and measurements (density graphs 
    require Rscript). When measurement data are not available, than it tries
    to load generated PNG images (defined in resutls source file) from 
    location where results source file (spl-result.xml) is located.
  
 SPL Configuration Editor
  - Allows to edit implicit project configuration (file spl-config.xml).
  - Is bound with '.spl-xml' files for now (create them using new file wizard).

 SPL INI Editor
  - Allows to edit SPL INI configuration files:
    - set repository access information
	- add remote execution machine
	- set parameters for build, execution and evalutaion 

 SPL Execution View
  - allows to run SPL Tools Framework directly from Eclipse
  - execution can be cancelled
  - finished execution results can be viewed with one click
 
Running plug-in:

Make sure that you have SPL.jar placed in folder "/lib/". It won't work otherwise.

Make sure that you have JRE 1.7 configured as JVM for Eclipse (that will run plugin).
It won't work otherwise.

Make sure you have Xtext 2.3.0 plug-in in your eclipse (update site 'Xtext All In One'
with URI 'http://download.eclipse.org/modeling/tmf/xtext/updates/composite/releases/').
Run src/cz/cuni/mff/spl/eclipseplugin/xtext/GenerateSPL_xtext.mwe2 as MWE2 Workflow 
to generate xtext related files.

Use Run As -> Eclipse Application on project in Package Explorer to test plugin.
See "Issue 7" when experiencing PermGen errors. 

View for Eclipse can be added by selecting Menu Window -> Show View -> Other,
then type "SPL" to filter and select "SPL Annotations Overview". It should
appear in bottom of Java perspective automatically when new Java perspective is
opened.

Note than changes in Java editor show in SPL Annotations Overview with delay 
(cca 5 seconds) after no change has been made. You can force refresh using 
"Refresh SPL Annotations" button.

You need to have annotated java source file opened in order to see list 
of annotations.

Use Project -> Generate Javadoc.. in Eclipse to generate JavaDoc and use overview.html
in the wizard.

Issues that can show in some revisions:
 1. Eclipse can't process "import org.eclipse.*"
  Add "<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>"
  to file ".classpath".

 2. Class not found exception on Code repository classes
  Make sure that you have SPL.jar placed in folder /lib/.
  
 3. SPL Annotations Overview view is not in list of views but plug-in is installed
  Make sure that eclipse is running on top of JRE 1.7, when run with JRE 1.6, than
  plug-in is ignored by eclipse.

 4. Unable to resolve import org.eclipse.xtext.ui.editor.embedded.EmbeddedEditor
  Get xtext 2.2 or newer, xtext 2.3.0 is recommended.
  
 5. MWE2: Couldn't find module cz.cuni.mff.spl.eclipseplugin.xtext.GenerateSPL_xtext
  Make sure that your project name in 
  src/cz/cuni/mff/spl/eclipseplugin/xtext/GenerateSPL_xtext.mwe2 matches name of
  your project folder (otherwise some 
  files may be generated to bad directory) and that folders 'src-xtext/src' and 
  'src-xtext/src-gen' already exist in project.
  
 6. MWE2: java.io.IOException: The path '/eclipseplugin/.../...java' is unmapped
  Make sure that node 'name' in file '.project' matches name of your project
  folder, otherwise URI maping in MWE2 does not work.
  Default name of project folder is 'eclipseplugin' (character case matters
  even on Windows machines due to URI mapping).

 7. Runtime: java.lang.OutOfMemoryError: PermGen space
  Explanation: Permanent Generation memory of JVM was too small to hold all 
  loaded classes and static fields. It is possible, that started Debug/Run
  Eclipse instance has default JVM value for MaxPermGen constant (it seems to
  be about 80 MB, but default eclipse value is 256 MB). 
  Solution: Add JVM parameter "-XX:MaxPermSize=256M" to your run configuration
  Arguments tab under "VM arguments".
  
 8. If MWE2 complains about class path issues, then add src folder to run 
  configuration manually.