This tutorial will teach you the basics of writing plugins that run inside the Eclipse framework. You will learn about editors, views, and extension points by creating one of each yourself. Once you're done with this tutorial, you will have an application that will look something like this:

Image Added

You may want to download the slides of the presentation explaining the basic concepts you will explore in this tutorial.

Preliminaries

...

1. Create a class TapeViewPart in a new package de.cau.cs.rtprak.login.simple.views that extends the ViewPart class. (make sure that in the New Java Class wizard, the option Inherited abstract methods is checked.)
2. Add a private field tableViewer of type TableViewer.

3. Your TableViewPart contains a still empty method createPartControl. This method will be responsible for creating the user interface components of your view. Add the following code to create the table we want to display:

   Code Block
   language java title createPartControl(...)
   Table table = new Table(parent, SWT.BORDER); table.setHeaderVisible(true); TableColumn column = new TableColumn(table, SWT.NONE); column.setWidth(80); tableViewercolumn.setText("Tape Data"); tableViewer = new TableViewer(table);

4. The setFocus method controls what happens when your part gets the focus. Make sure the focus will then automatically be set to the table by adding the following code:

   setFocus(...)

   Code Block
   title
   tableViewer.getControl().setFocus();

...

1. Create a class TuringTape in a new package de.cau.cs.rtprak.login.simple.model with the following fields:

   Code Block
   title language java Fields
   private int headPosition = 1; private StringBuffer text = new StringBuffer();

   Also add corresponding getter and setter methods. (You can simply right-click somewhere in the class and choose Source -> Generate Getters and Setters.)

2. Add two constants to the class:

   Code Block
   title language java Constants
   public static final char START_CHAR = '\u25b7'; public static final char BLANK_CHAR = '\u25fb';

3. Add a method getCharacter(int pos) that calculates the tape character at position pos as follows:
   
   • For pos == 0, return the character START_CHAR.
   • For pos > text.length(), return the character BLANK_CHAR.
   • Otherwise, return the text character at index pos - 1.
4. Add a private field tape of type TuringTape to TapeViewPart and initialize it with a new instance.
5. Create a class TapeData in de.cau.cs.rtprak.login.simple.model with two fields int index and char character, and add a constructor for initialization as well as corresponding getter methods.
6. Create a class TapeContentProvider in the de.cau.cs.rtprak.login.simple.views package that implements IStructuredContentProvider.
   
   • The methods dispose() and inputChanged() may remain empty.
   • The method getElements() must return an array of objects, where each object must contain all necessary data to be displayed in a single row of the table. The number of returned objects corresponds to the number of rows.
   • Suppose the input element is an instance of TuringTape. The result of getElements() shall be an array of TapeData elements. The size of the array shall be one more than the maximum of the tape head position and the length of the tape text. The index and character of each tape data element shall be filled with i and the result of turingTape.getCharacter(i), respectively, where i is the array index of the element.
7. Create a class TapeLabelProvider in the de.cau.cs.rtprak.login.simple.views package that extends BaseLabelProvider and implements ITableLabelProvider.
   
   • Add a private field tape of type TuringTape that is initialized from the constructor.
   • Add fields presentImage and absentImage of type Image.

   • Initialize each image using the following code, where path_to_image is icons/head_present.gif and icons/head_absent.gif, respectively:

     Code Block
     language java
     image = Activator.imageDescriptorFromPlugin(Activator.PLUGIN_ID, "path_to_image").createImage();

   • Override the implementation of dispose() in TapeLabelProvider to dispose both images after calling super.dispose(). (Right-click in the source-code and click Source -> Override/Implement Methods.)
   • In getColumnImage() and getColumnText(), first check whether the element is an instance of TapeData and the column index is 0, and return null otherwise. If the check passes, return the following:
     
     • getColumnImage(): presentImage if the index given by the tape data element equals the current value of tape.getHeadPosition(), absentImage otherwise.
     • getColumnText(): a String containing the character of the tape data element.

8. Add the following lines to createPartControl() in TapeViewPart:

   Code Block
   tableViewer.setContentProvider(new TapeContentProvider()); tableViewer.setLabelProvider(new TapeLabelProvider(tape)); tableViewer.setInput(tape);

Creating an Extension Point

WRITE THIS SECTION

...

Use Simple Text Editor as Tape View Input

We will now add code to make the Tape view display the content of a currently active Simple Text Editor.

1. Add the following methods to SimpleEditorPart:

   Code Block
   language java
   /** * Returns the text that is currently displayed in the editor. * @return the currently displayed text */ public String getText() { return getDocumentProvider().getDocument(getEditorInput()).get(); } /** The listener that is currently registered for this editor. */ private IDocumentListener registeredListener; /** * Registers the given runnable as listener for changes to the text * of this editor. * @param runnable a runnable to register as text listener */ public void registerTextListener(final Runnable runnable) { registeredListener = new IDocumentListener() { public void documentAboutToBeChanged(DocumentEvent event) {} public void documentChanged(DocumentEvent event) { runnable.run(); } }; getDocumentProvider().getDocument(getEditorInput()) .addDocumentListener(registeredListener); } /** * Removes the last registered text listener. */ public void disposeTextListener() { if (registeredListener != null) { if (getDocumentProvider() != null) { getDocumentProvider().getDocument(getEditorInput()) .removeDocumentListener(registeredListener); } registeredListener = null; } }

2. Add the following code to TapeViewPart:

   Code Block
   language java
   /** The editor part that is currently set as input for the viewer. */ private SimpleEditorPart currentInput; /** * Sets the displayed text of the given editor part as input of the * viewer, if the editor part is a SimpleEditorPart. * @param part workbench part to set as input */ private void setInput(final IWorkbenchPart part) { if (part instanceof SimpleEditorPart && part != currentInput) { if (currentInput != null) { currentInput.disposeTextListener(); } currentInput = (SimpleEditorPart) part; Runnable runnable = new Runnable() { public void run() { tape.setText(new StringBuffer(currentInput.getText())); tableViewer.refresh(); } }; runnable.run(); currentInput.registerTextListener(runnable); } }

3. Add the following code to createPartControl():

   Code Block
   language java
   IWorkbenchWindow workbenchWindow = getSite().getWorkbenchWindow(); IWorkbenchPage activePage = workbenchWindow.getActivePage(); if (activePage != null) { setInput(activePage.getActivePart()); } workbenchWindow.getPartService().addPartListener(new IPartListener() { public void partActivated(final IWorkbenchPart part) { setInput(part); } public void partDeactivated(final IWorkbenchPart part) {} public void partBroughtToTop(final IWorkbenchPart part) {} public void partClosed(final IWorkbenchPart part) {} public void partOpened(final IWorkbenchPart part) {} });

Create Actions to Move the Tape Head

If we want to add buttons to the view's tool bar, we will have to ask its IToolbarManager to do that for us:

1. Get the tool bar manager using the following code:

   Code Block
   language java
   IToolBarManager toolBarManager = getViewSite().getActionBars().getToolBarManager();

2. Add two actions to the toolbar manager by extending the class Action and implementing the run()method.
   • It is convenient to add actions as anonymous nested classes.
   • The first action shall have the text "L". When it is run, it shall move the head to the left (to the top in the table viewer), if the head is not already at position 0.
   • The second action shall have the text "R". When it is run, it shall move the head to the right.
   • You should call tableViewer.refresh() after any change to the tape.headPosition variable.

Test the View

If you open an instance of the simple text editor and open the Tape view, the view should correctly display the editor's text on a tape, and the L and R buttons should move the tape head.

Creating an Extension Point

For the final part of the tutorial, we will now use the extension point mechanism of Eclipse to add some behavior to our Turing Machines. An extension point is basically a well-defined point where other plug-ins can register to add functionality. The extension point is basically defined by an XML Schema file that defines an interface; other plug-ins may access this interface using XML code in their plugin.xml file, so-called extensions. Our extension point will provide an interface for classes that define behavior of a Turing Machine, and we will call them head controllers (programs that control the tape head).

Defining a Command Class

We will start by defining a class representing a command that will be passed to a selected head controller.

1. Add a class HeadCommand to the package de.cau.cs.rtprak.login.simple.controller.
2. Add a nested public static enumeration Action with values WRITE, ERASE, and NULL.
3. Add a nested public static enumeration Direction with values LEFT, RIGHT, and NONE.

4. Add the following private fields:

   Code Block
   language java
   private Action action; private Direction direction; private char newChar;

5. Add a constructor to initialize the fields.
6. Add getter methods to access the fields.

Defining the Controller Interface

We will now define an interface that all head controllers will have to implement:

1. Add an interface IHeadController in the package de.cau.cs.rtprak.login.simple.controller.

2. Add the following methods to the interface:

   Code Block
   language java
   /** * Calculate the next command depending on the currently seen character. * @param character the currently seen character * @return the next command specifying which character to write and * which direction to move the head */ HeadCommand nextCommand(char character); /** * Reset the internal state of the head controller. */ void reset();

Defining the Extension Point

We will now define the extension point that head controllers will be registered at.

1. Open the plugin.xml file in the Plugin Manifest Editor and switch to the Extension Points tab.
2. Click the Add button and enter de.cau.cs.rtprak.login.simple.headControllers as the extension point's ID, and Head Controllers as its name. Shorten the schema file's file name to schema/headControllers.exsd. Make sure that Edit extension point schema when done is checked and click Finish.
3. Eclipse will now have opened the new schema file in the Extension Point Schema Editor, a graphical editor similar to the Plugin Manifest Editor that provides a way to define things that might be easier than directly editing the text files.
4. In the new editor, open the Definition tab.
5. Add a new element named controller.
6. Add three new attributes to the controller element:
   
   • First attribute: name id, use required, type string, translatable false.
   • Second attribute: name name, use required, type string, translatable true.
   • Third attribute: name class, use required, type java, implements de.cau.cs.rtprak.login.simple.controller.IHeadController. This is the attribute that will tell us which Java class actually implements the controller that is to be registered at our extension point. To make sure that we know how to speak to the class, we require it to implement the interface we defined for head controllers.
7. Add a sequence to the extension element. Right-click the sequence and click New -> controller. Set the Min Occurrences of the sequence to 0, and set Max Occurrences to be Unbounded.
8. Save the editor and switch back to the Plugin Manifest Editor.
9. On the Runtime tab, add de.cau.cs.rtprak.login.simple.controller to the list of packages exported by the plug-in. This is necessary because plug-ins that want to provide extensions for the extension point must provide a class that implements IHeadController. For this to work, those plug-ins must have access to that interface; thus, we have to export the package containing it.

Accessing the Extension Point

We will now add a class that will be in charge of loading all extensions registered at our new extension point.

1. Add a class HeadControllers to the package de.cau.cs.rtprak.login.simple.controller. Add the following code, replacing login with your login name in EXTENSION_POINT_ID as usual:

   Code Block
   language java
   /** * Class that gathers extension data from the 'headControllers' extension point * and publishes this data using the singleton pattern. * @author msp */ public class HeadControllers { /** Identifier of the extension point */ public final static String EXTENSION_POINT_ID = "de.cau.cs.rtprak.login.simple.headControllers"; /** The singleton instance of the {@code HeadControllers} class */ public final static HeadControllers INSTANCE = new HeadControllers(); /** list of head controller ids with associated names. */ private List<String[]> controllerNames = new LinkedList<String[]>(); /** map of controller ids to their runtime instances. */ private Map<String, IHeadController> controllerMap = new HashMap<String, IHeadController>(); /** * Creates an instance of this class and gathers extension data. */ HeadControllers() { IConfigurationElement[] elements = Platform.getExtensionRegistry() .getConfigurationElementsFor(EXTENSION_POINT_ID); for (IConfigurationElement element : elements) { if ("controller".equals(element.getName())) { String id = element.getAttribute("id"); String name = element.getAttribute("name"); if (id != null && name != null) { try { IHeadController controller = (IHeadController)element .createExecutableExtension("class"); controllerNames.add(new String[] {id, name}); controllerMap.put(id, controller); } catch (CoreException exception) { StatusManager.getManager().handle(exception, Activator.PLUGIN_ID); } } } } } /** * Returns a list of controller ids and names. The arrays in the list are * all of size 2: the first element is an id, and the second element is the * associated name. The controller name is a user-friendly string to be * displayed in the UI. * @return a list of controller ids and names */ public List<String[]> getControllerNames() { return controllerNames; } /** * Returns the head controller instance for the given id. * @param id identifier of a head controller * @return the associated controller */ public IHeadController getController(final String id) { return controllerMap.get(id); } }

Adding Support for Head Controllers to the View

We will now have to add support for head controllers to our view.

1. Open the TapeViewPart class and add the private fields checkedControllerAction of type IAction and currentController of type IHeadController.

2. Add a list of registered head controllers to the view's menu (which can be opened using the small white triangle) in the createPartControl() method:

   Code Block
   language java
   IMenuManager menuManager = getViewSite().getActionBars().getMenuManager(); for (String[] controllerName : HeadControllers.INSTANCE.getControllerNames()) { final String id = controllerName[0]; String name = controllerName[1]; Action action = new Action(name, IAction.AS_RADIO_BUTTON) { public void run() { if (checkedControllerAction != null) { checkedControllerAction.setChecked(false); } this.setChecked(true); checkedControllerAction = this; currentController = HeadControllers.INSTANCE.getController(id); } }; if (checkedControllerAction == null) { action.run(); } menuManager.add(action); }

3. Implement the following method in the TuringTape class:

   Code Block
   language java
   public void execute(final IHeadController controller)

   The method shall have the following properties:

   
   
   • Determine the character at the current head position using getCharacter(getHeadPosition()).
   • Call controller.nextCommand() with the current character as parameter.
   • Depending on the action in the returned head command, either write the returned new character to the current position in text (WRITE), or write the blank symbol (ERASE), or do nothing. If the current position exceeds the end of the text, append enough blank characters up to the current position, then append the new character.
   • Depending on the direction in the returned head command, either move the head to the left (but no further than position 0), or to the right, or do nothing.
4. Copy the files step.gif and reset.gif to the icons folder.
5. Add an action to the toolbar of the Tape view with text Step and icon step.png which does the following:
   
   • Check whether the current head controller is not null, than call tape.execute(currentController).
   • Refresh the table viewer with its refresh() method.

   • Note: actions don't need images, but only image descriptors. Thus, to set the action's icon to step.png, you can use something like the following:

     Code Block
     language java
     Activator.imageDescriptorFromPlugin(Activator.PLUGIN_ID, "path_to_icon");

6. Add another action with text Reset and icon reset.png which does the following:
   
   • Check whether the current head controller is not null, then call the reset() method on currentController.
   • Set the current head position to 1.
   • Refresh the table viewer with its refresh() method.

Adding a Test Head Controller

Before creating a proper head controller in another plug-in, we will add a test controller to check whether all this stuff works.

1. Add a new class NullController to the de.cau.cs.rtprak.login.simple.controllers package:

   Code Block
   language java
   /** * Head controller that does nothing, for testing. * @author msp */ public class NullController implements IHeadController { /** * {@inheritDoc} */ public HeadCommand nextCommand(final char character) { return new HeadCommand(Action.NULL, Direction.NONE, '_'); } /** * {@inheritDoc} */ public void reset() { } }

2. Open the Plugin Manifest Editor and switch to the Extensions tab. Add your de.cau.cs.rtprak.login.simple.headControllers extension point. Add a controller element with ID de.cau.cs.rtprak.login.simple.nullController, name Null Controller, and class de.cau.cs.rtprak.login.simple.controller.NullController.
3. Start the application and observe how your program behaves if you change the action and direction in the NullController class. You can actually change both while the application is running, but only if you have started it in the Debug mode. In that case, Eclipse will actually hot-swap your changes into the running application. Sorcery!

Implementing Your Own Head Controller

We will now create a new plug-in with a new head controller:

1. Create a new plug-in de.cau.cs.rtprak.login.simple.extension. (Remember to create the project in your Git repository.) In the Plugin Manifest Editor, add de.cau.cs.rtprak.login.simple to the dependencies of the new plug-in.
2. Create a new class that implements IHeadController:
   
   • Assuming that the initial head position is 1, the controller shall copy the input text infinitely often. So if the tape initially contains the word hello, the controller shall generate hellohellohellohe... .
   • Your class needs some private fields to store the internal state of the controller, and you may need some special character as marker. Imagine how a Turing Machine would do this.
   • It is not allowed to store data that can grow infinitely, since a Turing Machine may only have a finite number of states. This means that you may store single characters or numbers, but you must not store Strings, StringBuffers, arrays, lists, or sets.
3. Register the new controller class using an extension in the new plug-in.
4. Test your controller.

Congratulations!

Congratulations, you just made a big step towards understanding how Eclipse works. Plus, you've refreshed your knowledge on Turing Machines along the way. Eclipse is an industry standard technology, and having experience programming against it is a valuable skill for you.

If you have any comments and suggestions for improvement concerning this tutorial, please don't hesitate to tell us about them!