Note: these instructions were written using OS X Lion and Eclipse as the test configuration.

Size: px

Start display at page:

Download "Note: these instructions were written using OS X Lion and Eclipse as the test configuration."

Maximillian Berry
6 years ago
Views:

1 Setting Up Eclipse Note: these instructions were written using OS X Lion and Eclipse as the test configuration. Setting Up Eclipse Prerequisites Eclipse Installations for Sireum Development Setting Up Eclipse for Sireum Development Retrieving Sireum v2 Codebase Retrieving Sireum v1 Codebase Post Eclipse Setup for Sireum (v1 or v2) Development Additional Post Eclipse Setup for Sireum v2 Development Additional Post Eclipse Setup for Sireum v1 Development Prerequisites Some Sireum projects require some packages to be installed and runnable from your default path environment: 1. C/C++ Compiler and Make Tools (in Mac use Macports) a. If you are using Mac OS X, install X11 and XCode. If you don't have it in your system, you can install it from Apple s App Store b. Download and install Macports: c. In a command line terminal, type ($is command line prompt): $ sudo port selfupdate 2. Graphviz: (Needed for Kiasan) Mac OS: they suggest using Mac Ports sudo port install graphviz sudo port install graphviz gui # command line version, which is all Kiasan needs # for a GUI version or download the installer. 3. Yices: (Needed for Topi, Kondisi, and Kiasan) 4. Z3: us/um/redmond/projects/z3/ (Needed for Topi, Kondisi, and Kiasan); note that Z3 are now available for OS X, Linux, and Windows. a. Note: in order for Z3 to work inside Eclipse for Sireum v2 s Kiasan tests, you need to set up an environment variable called Z3to point to Z3 s executable file.

2 In OS X, this is a bit convoluted because GUI apps do not use the environment variables defined in.profile or.bashrc. Instead you can use RCEnvironment. 5. Latex: project.org/ a. If you are using Mac OS X, use MacTeX: and a handy tool to create latex PDF snippets called LaTeXiT (included in MacTeX): 6. Aspell and Aspell dictionary a. If you are using Mac OS X, you can install aspell using Macports as follows: sudo port install aspell aspell dict en Eclipse Installations for Sireum Development 1. Download Eclipse Classic X.Y.Z from Eclipse.org Downloads for your specific OS/Architecture Use Mac/Cocoa/x86_64 if you have a recent Mac. You can also use this page to download 3.x versions. eclipse plugins X.Y.Z.zip, and eclipse plugins scala X.Y.Z.zipfrom santoslab.org s Google Docs (under the /Software/Eclipse collection). If you plan to access Sireum v1 codebase, you need the Jazz plugins as well (only works for Eclipse 3.7.1): eclipse plugins jazz X.Y.Z.zip. 2. Unzip the zip files in a directory, for example, ECLIPSE_DIR. This should create ECLIPSE_DIR/eclipse X.Y.Z, ECLIPSE_DIR/eclipse plugins X.Y.Zand ECLIPSE_DIR/eclipse plugins scala X.Y.Z(and ECLIPSE_DIR/eclipse plugins jazz X.Y.Zif you unzip the Jazz zip file). 3. Change your Eclipse's eclipse.ini file as follows (... means elided): launcher.xxmaxpermsize 512m vmargs Xms128m Xmx2048m

3 Note that you can increase the max memory heap to go beyond 2048m above (2048m is the recommended minimum when using Scala IDE). 4. Change directory to ECLIPSE_DIR/eclipse plugins X.Y.Z. Run the Install class as follows (note that the paths has to be absolute paths): $ java Install ECLIPSE_DIR/eclipse X.Y.Z ECLIPSE_DIR/eclipse plugins X.Y.Z 5. Change directory to ECLIPSE_DIR/eclipse plugins scala X.Y.Z. Run the Installclass as follows (note that the paths has to be absolute paths): $ java Install ECLIPSE_DIR/eclipse X.Y.Z ECLIPSE_DIR/eclipse plugins scala X.Y.Z 6. If you are planning to use Jazz, change directory to ECLIPSE_DIR/eclipse plugins jazz X.Y.Z. Run the Installclass as follows (note that the paths has to be absolute paths): $ java Install ECLIPSE_DIR/eclipse X.Y.Z ECLIPSE_DIR/eclipse plugins jazz X.Y.Z 7. Eclipse is now ready for you to run: ECLIPSE_DIR/eclipse X.Y.Z/eclipse When you run Eclipse, it may ask for a directory for its workspace, for example, WORKSPACE_HOME. Check the Usethisasthedefaultanddonotaskagain checkbox in order to avoid Eclipse to ask you again the next time. Note: If you installed eclipse plugins scala X.Y.Z, when it first starts Eclipse will ask whether you want to enable JDT Weaving, you need to enable JDT Weaving for the Scala plugin to work. If you accidentally didn t enable it, take a look on how to enable JDT Weaving manually here. Note from Eclipse Documentation: On Mac OS X 10.4 and later, you may notice a slow down when working with significant numbers of resources if you allow Spotlight to index your workspace. To prevent this, start System Preferences, select the Spotlight icon, then the Privacy tab, then click the Add button ("+") and find your workspace directory in the dialog that appears.

4 Setting Up Eclipse for Sireum Development First, we will set Eclipse preferences. A faster way to do this is to download eclipse preferences X.Y.Z.zipin santoslab.org s Google Docs and unzip it inside your new workspace directory; this effectively preconfigures your workspace s.metadata/.plugins/org.eclipse.core.runtime/.settingsas if you are following the instructions in this section and you can proceed to the next section. Open Eclipse's Preferencespage. In Mac OS X, open the Eclipsemenu and select Preferences...(notation: Eclipse >Preferences...; hotkey: Command,). For the following instructions, press the Applybutton whenever available in the preference pages. 1. Under Generalpreferences: a. Check the Alwaysruninbackgroundcheckbox. b. Check the Showheapstatuscheckbox. c. Under Appearance >ColorandFonts, set Basic >TextFontto whatever font and size that you are comfortable when editing code (e.g., Monaco size 16). d. Under Appearance >Compare/Patch, check the Showstructurecomparein Outlineviewwhenpossibleand Ignorewhitespacecheckboxes. e. Under Editors >TextEditors, check the following checkboxes: Insert spacesfortabs, Showprintmargin, and Showlinenumbers. Set 2 for Displayedtabwidth. f. Under Keys, set Cleanup(When: InWindows), BuildClean(When: In DialogsandWindows), ContentAssist(When: InDialogsandWindows), and RunJUnitTest(When: InWindows) hot keys, e.g., Shift Command N, Shift Command B, Shift Command T, and Shift Command Space, respectively. g. Under StartupandShutdown, check the Refreshworkspaceonstartup checkbox. h. Under WebBrowser, check the Useexternalwebbrowsercheckbox and select your favorite browser. i. Under Workspace,check the Buildautomatically, Refreshusingnative hooksorpolling, and Refreshonaccesscheckboxes. 2. Under Antpreferences: a. Under Editor >Formatter, uncheck the Usetabcharacterinsteadof spacesand Wraplongelementtagscheckboxes.

5 3. Under Javapreferences: a. Under Compiler, make sure that the Compilercompliancelevel:is 1.6. b. Under Debug, check UseStepFilters, and check all items under Defined stepfilters. c. Under InstalledJREs, select JVM version or above. d. Under JUnit, check the Add' ea'tovmargumentswhencreatinganew JUnitlaunchconfigurationcheckbox. 4. Under Run/Debugpreferences: a. Under Console, set Consolebuffersize(characters):to , and Displayedtabwidth:to Under Teampreferences: a. Under IgnoredResources, uncheck the following patterns: *.a, *.dll, *.dylib, *.so. b. Under SVN, for the SVN Interface select the SVNKit(PureJava)SVNKit vx.y.z.bclient. c. Under Git, check the Ignorewhitespacechangescheckbox. Retrieving Sireum v2 Codebase 1. Open File >Import >Git >ProjectsfromGit, and click Next. Select URIand Next. In the URIfield, enter (replace usernamewith your projects.cis.ksu.edu username): internal Click Next. 2. Select master, and click Next. Enter the base directory for your projects (has to be outside of your Eclipse workspace) such as ~/Documents/git repo/sireum internal, and click Next. 3. Select Importexistingprojectsfrom WorkingDirectory, and click Next. 4. Select all the projects (including sireum core; those will be imported into your workspace), and click Finish. 5. If you have compile errors, try Build Clean all the projects.

6 Retrieving New Projects Subsequently Added to v2 Codebase 1. Open GitRepositoryExploringperspective (Windows >Open Perspective >Other... >GitRepositoryExploring). 2. In the GitRepositoryview (Window >ShowView >GitRepositories), right click on sireum internal >WorkingDirectoryand choose ImportProjects Select Importexistingprojectsfrom WorkingDirectory, and click Next. 4. Select the new projects to import and click Next. Retrieving Sireum v1 Codebase If you need to access Sireum v1 codebase, follow the instructions below. Otherwise, skip to the next section. 1. Open TeamArtifactsview (Window >ShowView >TeamArtifacts, or Window >ShowView >Others >Team >TeamArtifacts). 2. Click on the CreateaRepositoryConnectionlink in the view, and enter the following information: URI: Name: sireum User ID: your Sireum Jazz user id (e.g., robby) Password: your Sireum Jazz password Once successful, you will see a repository connection under RepositoryConnection in the TeamArtifactsview (e.g., robby@sireum). 3. Right click on the repository connection (e.g., robby@sireum) and select Manage ConnectedProjectAreas..., and select all project areas that you are interested in. 4. Recall that Eclipse/Jazz has three workspace levels: the Eclipse workspace in your local hard disk, one remote workspace per stream and per Eclipse installation that is owned by you in the server, and the team stream. a. If you have never created a repository workspace for your Eclipse installation in your machine, create a new workspace per stream. Note that if you have a different Eclipse workspace, you need to create a different repository workspace.

7 To create a repository workspace, right click on MyRepositoryWorkspaces and then New... >RepositoryWorkspace... b. Select Flowwithastream, and select the stream that you want to create a repository workspace for, e.g., Sireum >Active:SireumStream(sireum), and then click Next. c. Name you new repository workspace, e.g., Active:SireumStream Workspace(OSX,base), and click Finish. It's a good convention to add some descriptive name for your Eclipse workspace (e.g., (OSX,base) in the above example. d. You will be asked whether you want to load the repository workspace to your local Eclipse workspace. Select FindandloadEclipseprojects, and click Finish. Post Eclipse Setup for Sireum (v1 or v2) Development 1. In the Problemview, click on the down triangle menu and select Configure Contents..., and then check the Errors/WarningsonProject, click Ok. 2. In the PackageExplorerview, click on the down triangle menu and select Filters... Uncheck.*resources. 3. We need to setup some more Eclipse preferences (open it up): a. Under Workspace >LinkedResources, check the Enablelinkedresources checkbox, and add the following path variable: Name: WORKSPACE Location: put the folder path of your workspace home, e.g., WORKSPACE_HOME b. Under Teampreferences: i. Under Git, change the Defaultrepositoryfolder. c. Under Texlipsepreferences: i. Under BuilderSettings, set the BindirectoryofTeX ii. distribution:to your LaTeX binary folder (use which pdflatexto get your tex binary folder). Under SpellChecker, set the Directoryformaindictionaries:to ECLIPSE_DIR/eclipse plugins X.Y.Z/texlipse/. 1. Note: a project s language property must be set in order to enable spell checking. Open the project s properties and set Latex ProjectProperties >...languagecodeto en 2. Note: use quick fix (Command+1) to add/ignore words.

8 iii. To activate forward and inverse search between the TeX source and the generated PDF, first install the Skim PDF reader app.sourceforge.net. Once configured, you can perform a forward search (Eclipse to Skim) by placing the cursor within the TeX source and pressing Command+4. For an inverse search (Skim to Eclipse), press Command+Shiftand then left click on the text in Skim. Note: you may want to disable OS X s Minimizewindowsinto applicationiconoption if the animation is slow. 1. In Eclipse, goto Texlipse >ViewerSettings, add a new Viewer configurationin top priority, with the following viewer configuration a. Viewer name: skim b. Viewer command: /Applications/Skim.app/Contents/SharedSupport/displayl ine c. Viewer arguments: r %line "%file" "%texfile" Note: add bto indicate the line using the reader bar in Skim d. Viewer input file format: pdf e. Inverse search support: Viewerrunsexternalcommand f. Viewer supports forward search: selected 2. Ensure that the syntex=1 is an argument to the PdfLatex program in Texlipse >BuilderSettings >PdfLatex program >Edit In Skim, add the following configuration to Preferences >Sync/PDF Texsyncsupport a. Preset: Custom b. Command: java c. Arguments: classpath ECLIPSE_DIR/eclipse plugins X.Y.Z /texlipse/eclipse/plugins/net.sourceforge.texlipse_1.5.0/texlipse.jar net.sourceforge.texlipse.viewer.util.filelocationclien t f %file l %line Additional Post Eclipse Setup for Sireum v2 Development After retrieving the Sireum codebase, you should have sireum core. Follow the instructions below only If you didn t use the packaged preferences above.

9 1. We need to setup some more Eclipse preferences (open it up): a. Copy the content of sireum core/codestyle/header.txt to the clipboard, and then paste it under Java >CodeStyle >CodeTemplates >Comments >Files (replace <name> with your name). b. Under Java >CodeStyle >CleanUp, import sireum core/codestyle/clean up.xml c. Under Java >CodeStyle >Formatter, import sireum core/codestyle/formatter.xml d. Under C/C++ >CodeStyle, import sireum core/codestyle/c formatter.xml Additional Post Eclipse Setup for Sireum v1 Development After retrieving the Sireum codebase, you should have sireum util, sireum topi, and sireum kiasan jvm report. 2. We need to setup some more Eclipse preferences (open it up): a. Under Java >BuildPath >UserLibraries, import the following user library files (for Active: Sireum Stream, not Sireum v2): i. sireum util/lib/sireum.userlibraries ii. sireum topi/lib/topi.userlibraries iii. sireum kiasan jvm report/lib/kiasan jvm report.userlibraries b. If you didn t use the packaged preferences above. i. Copy the content of sireum util/codestyle/header.txt to the clipboard, and then paste it under Java >CodeStyle >Code Templates >Comments >Files(replace <name> with your name). ii. Under Java >CodeStyle >CleanUp, import sireum util/codestyle/clean up.xml iii. Under Java >CodeStyle >Formatter, import sireum util/codestyle/formatter.xml iv. Under C/C++ >CodeStyle, import sireum util/codestyle/c formatter.xml

Code::Blocks Student Manual

Code::Blocks Student Manual Lawrence Goetz, Network Administrator Yedidyah Langsam, Professor and Theodore Raphan, Distinguished Professor Dept. of Computer and Information Science Brooklyn College of