FAQ Language integration phase 3: How do I edit programs?
After creating a compiler, a builder, and a DOM, writing an editor is a snap. To write an editor for a particular programming language, a few steps can be distinguished, all relying heavily on the existence of a DOM.
- Implement a language-specific editor.
The JDT places the bar high for any subsequent language implementers. No matter how fast the compiler is and how well the build process is integrated, if your language has to be edited in the default text editor, you fail to even get close to being worthy of comparison to JDT. Writing an editor is not difficult. Many examples exist. The platform wizard has one for an XML editor. The examples shipped with Eclipse show a simplified Java editor. This book has a sample that shows how to write an HTML editor. For more details, see FAQ How do I write an editor for my own language?
- Add Content Assist. (see FAQ How do I add Content Assist to my language editor?)
The DOM, developed in phase 2, allows us to navigate the source code, analyze it, present it in multiple modes, and manipulate its structure, a process also known as refactoring. Content Assist uses the DOM to figure out all the possible context-sensitive continuations for a given input. Quick Fixes know how to solve a given compilation error. Refactoring relies on the DOM to find all call sites for a given method before we can change its name. An Outline view uses the DOM to show the structure of the code in a hierarchical summary format.
- Add Quick Fixes (see FAQ How do I implement Quick Fixes for my own language?
After compilation errors have been detected, suggest how to fix the problem. How would you reason about code without an underlying model?
- Add refactoring (see FAQ How do I support refactoring for my own language?)
Implement operations on source code to restructure program constructs, following the semantics of your language. Again, without a model of the underlying language, this is a daunting, error-prone task.
- Add an Outline view (see FAQ How do I create an Outline view for my own language editor?)
The Outline view presents a summary of the structure of a particular program. Using the same compiler and/or DOM saves a lot of time developing your language IDE.
After completing your editor, you are ready to enter the Holy Grail of language IDEs; see FAQ Language integration phase 4: What are the finishing touches?
This FAQ was originally published in Official Eclipse 3.0 FAQs. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the Eclipse Public License v1.0.