magicislab / core

Sireum Core Components

Sireum Core

This repository stores some of the core components of the Sireum (v2) software analysis platform.

Setting up Development Environment

1. Download and install Sireum by following the instructions at: http://www.sireum.org/download.

2. Launch Sireum Development Environment (DE) (add -h for help):

   sireum launch sireumdev
   

   Pick a directory for your workspace when asked. Moreover, agree when asked to run Scala diagnostics; enable JDT Weaving for Scala IDE and then quit DE; relaunch Sireum DE.

3. Add SIREUM_HOME/apps/platform/java in Eclipe's Java Installed JREs preference page, and make it the default. In addition, set Eclipse's Java Compiler compliance level to 1.7. (If Eclipse shows you a dialog box indicating that "Subversive Native Library Not Available", it means that you do not have native SVN installed; click Ok to close the dialog box. You can correct this issue by setting SVN Interface Client to "SVNKit" in the Eclipse's Team->SVN preference page.)

4. Import all projects in:

   • Sireum Prelude Repo
     • https://github.com/sireum/prelude.git
     • [email protected]:sireum/prelude.git
   • Sireum Parser Repo
     • https://github.com/sireum/parser.git
     • [email protected]:sireum/parser.git
   • Sireum Core Repo
     • https://github.com/sireum/core.git
     • [email protected]:sireum/core.git

   This should import projects such as sireum-core-test.

5. Run all Sireum Core tests by right clicking the project sireum-core-test and selecting Run As and then Scala JUnit Test; all tests should pass.

6. If you plan to make changes to the codebase, import the following in the respective Eclipse preference pages:

   • In Java -> Code Style -> Clean Up preference page: sireum-util/codestyle/java-clean-up.xml
   • In Java -> Code Style -> Formatter preference page: sireum-util/codestyle/java-formatter.xml
   • In Scala -> Formatter preference page: sireum-util/codestyle/scala-formatterPreferences.properties

   Make sure to run Java source clean up before committing Java code. Similarly, make sure to run Scala formatter before committing Scala code.