search JMRI:

Development tools

• Getting the code via SVN
• SVN FAQs
• Building with Ant
• Building with NetBeans
• Building with XCode
• Building with Eclipse
• Building with JBuilder

Structure

• Introduction
• Application Structure
• Names and Naming
• Code Structure Patterns
• Swing Structure
• External Connection Structure
• Threads
• Use of XML
• Web Site
• JavaDocs
  • Name Index
  • Packages
  • Class heirarchy

Techniques and Standards

• Recommended Practices
• Continuous Integration
• Internationalization
• Logging & Error Handling
• Unit testing with JUnit
• Documentation with JavaDoc and UML
• Run the FindBugs static analysis tool
• Providing help with JavaHelp
• Portable Filename Method
• XML Persistance

How To

• Extend with Plugins
• Add a New Type
• Add a New System

Functional Info

• Turnout Feedback
• Network Connections
• How the startup scripts work

Background Info

• Technology Roadmap
• Survey of JVM Capabilities
• Usage Poll, Spring 2007

JMRI: Building with XCode

Introduction

Recent versions of MacOS X come with Xcode, a software development system developed for the Macintosh by Apple Computer. Xcode can be used to work with JMRI.

The instructions below assume a fresh checkout of JMRI, along with a recent version of Xcode.

Procedure to setup JMRI on Xcode

1. Start Xcode, dismiss any window that appears, and uncheck return to this window, etc.

2. Select Window>Organizer. ( Note: Xcode now uses the Organizer window for Java, instead of the main Xcode window used in early versions of Xcode.)

3. At the bottom left of the organizer window, in the "+" popup select "Add Existing Folder..."

4. Navigate to the "java" folder in your checkout of JMRI, and click Open.

5. Select "java" in the Organizer window. Click the Clean icon at the top of the Organizer window. When that completes, hold down the Build icon, and select ant 'compile'. This will compile all the JMRI source.

6. Selecting Build>ant 'jar' will build a jmri.jar file. The jar file is placed in your checkout folder.

7. To view or edit an existing source module, open the java folder at the top left in Organizer window (click the triangle on the left), then open the src folder, then the apps or jmri folder, etc. to find the file you're interested in.

8. To create an ant 'panelpro' entry in the Build list:

   1. Select "Edit Actions..." in the Build list.

   2. Select ant 'compile' in the list at the left, and copy the command that shows in the box on the right.

   3. In the + popup at the lower left, select "New Shell Script".

   4. Change "Shell Script" to "ant 'panelpro' " in the list on the left.

   5. Paste the text you copied in b into the right box, and change "compile" to "panelpro".

   6. Click OK.

   Note: Selecting ant 'panelpro' in the Build list, will compile, build, and run PanelPro, with error and warning messages displayed in an Xcode window.

9. You can follow 8 to set up to easily run any of the ant commands JMRI uses.

CAUTION: This procedure requires JMRI 2.9.2 or later. It has been tested using MacOS X 10.6.2, using Xcode 3.2.1. Earlier versions of JMRI (without the latest RXTX), may not find serial ports when JMRI is run from Xcode.

---