org.eclipse.xtext.formatting2

Class AbstractJavaFormatter

java.lang.Object

org.eclipse.xtext.formatting2.AbstractFormatter2

org.eclipse.xtext.formatting2.AbstractJavaFormatter

All Implemented Interfaces:

IFormatter2

Direct Known Subclasses:

XtextFormatterJava

@Beta
public abstract class AbstractJavaFormatter
extends AbstractFormatter2

This is an abstract base class for language-specific formatters, intended to be extended with a java class.

It is working very much like AbstractFormatter2 but does support additional methods to simplify java formatter code.

the "_format" methods are called by reflection. The name is important as well as there are exactly two arguments whereas the first one is of the element type you like to format and the second one of type IFormattableDocument. The methods should be protected.

Example code for a java formatter:

 import static org.xtext.example.mydsl.myDsl.MyDslPackage.Literals.*;
 
 public class MyDslFormatter2 extends AbstractJavaFormatter {
        protected void _format(Model model, IFormattableDocument doc) {
                for (Parent parent : model.getParents())
                        doc.format(parent);
        }
 
        protected void _format(Parent parent, IFormattableDocument doc) {
                doc.prepend(regionFor(parent).keyword("parent"), this::noSpace);
                doc.append(regionFor(parent).keyword("parent"), this::oneSpace);
                doc.append(regionFor(parent).feature(PARENT__NAME), this::oneSpace);
                doc.prepend(regionFor(parent).keyword("{"), this::oneSpace);
                doc.append(regionFor(parent).keyword("{"), this::newLine);
                doc.interior(regionFor(parent).keyword("{"), regionFor(parent).keyword("}"), this::indent);
                doc.append(regionFor(parent).keyword("}"), it -> it.setNewLines(1, 1, 2));
                for (Child child : parent.getChildren())
                        doc.format(child);
        }
 
        protected void _format(Child child, IFormattableDocument doc) {
                doc.append(regionFor(child).keyword("child"), this::oneSpace);
                doc.append(regionFor(child).feature(CHILD__NAME), this::newLine);
        }
 }
 

This is suitable for the following grammar:

 grammar org.xtext.example.mydsl.MyDsl with org.eclipse.xtext.common.Terminals
 
 generate myDsl "http://www.xtext.org/example/mydsl/MyDsl"
 
 Model: parents+=Parent*;
 Parent: 'parent' name=ID '!' ('{' children+=Child* '}')?;
 Child: 'child' name=ID;
 

Since:

2.24

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractJavaFormatter.EObjectErrorHandler

Field Summary

Fields inherited from class org.eclipse.xtext.formatting2.AbstractFormatter2

textRegionExtensions

Constructor Summary

Constructors

Constructor and Description
AbstractJavaFormatter()

Method Summary

Modifier and Type	Method and Description
protected ISemanticRegionsFinder	allRegionsFor(org.eclipse.emf.ecore.EObject semanticElement)
protected java.lang.Iterable<ISemanticRegion>	allSemanticRegions(org.eclipse.emf.ecore.EObject semanticElement)
protected void	autowrap(IHiddenRegionFormatter hrf) Configure autowrap.
protected org.eclipse.xtext.util.PolymorphicDispatcher<java.lang.Void>	createPolymorhicDispatcher() Override if you like to specify formatting methods in different way then default (using annotations or similar).
void	format(java.lang.Object child, IFormattableDocument document) Implement this method to create a language-specific formatter.
protected org.eclipse.emf.ecore.EObject	grammarElement(org.eclipse.emf.ecore.EObject semanticElement)
protected void	highPriority(IHiddenRegionFormatter hrf) When merging, treat this configuration with a high priority.
protected ISemanticRegionFinder	immediatelyFollowing(org.eclipse.emf.ecore.EObject semanticElement)
protected ISemanticRegionFinder	immediatelyPreceding(org.eclipse.emf.ecore.EObject semanticElement)
protected void	indent(IHiddenRegionFormatter hrf)
protected boolean	isMultiline(org.eclipse.emf.ecore.EObject semanticElement)
protected void	lowPriority(IHiddenRegionFormatter hrf) When merging, treat this configuration with a low priority.
protected void	newLine(IHiddenRegionFormatter hrf) Forces a line break in this hidden region.
protected IHiddenRegion	nextHiddenRegion(org.eclipse.emf.ecore.EObject semanticElement)
protected void	noAutowrap(IHiddenRegionFormatter hrf) Suppresses auto wrap in this hidden region.
protected void	noIndentation(IHiddenRegionFormatter hrf) Resets the indentation level to zero.
protected void	noSpace(IHiddenRegionFormatter hrf) Format this hidden region with using no space (zero characters).
protected void	oneSpace(IHiddenRegionFormatter hrf) One space is added at this hidden region.
protected IHiddenRegion	previousHiddenRegion(org.eclipse.emf.ecore.EObject semanticElement)
protected ISemanticRegionsFinder	regionFor(org.eclipse.emf.ecore.EObject semanticElement)
protected IEObjectRegion	regionForEObject(org.eclipse.emf.ecore.EObject semanticElement)
protected java.lang.Iterable<ISemanticRegion>	semanticRegions(org.eclipse.emf.ecore.EObject semanticElement)

Methods inherited from class org.eclipse.xtext.formatting2.AbstractFormatter2

_format, _format, _format, _format, createCommentReplacer, createFormattableRootDocument, createFormattableSubDocument, createHiddenRegionFormatter, createHiddenRegionFormatter, createHiddenRegionFormatting, createHiddenRegionFormattingMerger, createHiddenRegionReplacer, createTextReplacerContext, createTextReplacerMerger, createWhitespaceReplacer, format, getPreference, getPreferences, getRequest, getTextRegionAccess, handleTraceMissing, initalize, initialize, isInRequestedRange, postProcess, reset, shouldFormat

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractJavaFormatter

public AbstractJavaFormatter()

Method Detail

format

public void format(java.lang.Object child,
                   IFormattableDocument document)

Description copied from class: AbstractFormatter2

Implement this method to create a language-specific formatter. See the JavaDoc of this class for a more detailed description of what your code should do.

Specified by:

format in class AbstractFormatter2

Parameters:

child - An XtextResource or an object for from your semantic model.

document - The document to collect and execute ITextReplacers.

createPolymorhicDispatcher

protected org.eclipse.xtext.util.PolymorphicDispatcher<java.lang.Void> createPolymorhicDispatcher()

Override if you like to specify formatting methods in different way then default (using annotations or similar).

allRegionsFor

protected ISemanticRegionsFinder allRegionsFor(org.eclipse.emf.ecore.EObject semanticElement)

allSemanticRegions

protected java.lang.Iterable<ISemanticRegion> allSemanticRegions(org.eclipse.emf.ecore.EObject semanticElement)

grammarElement

protected org.eclipse.emf.ecore.EObject grammarElement(org.eclipse.emf.ecore.EObject semanticElement)

immediatelyFollowing

protected ISemanticRegionFinder immediatelyFollowing(org.eclipse.emf.ecore.EObject semanticElement)

immediatelyPreceding

protected ISemanticRegionFinder immediatelyPreceding(org.eclipse.emf.ecore.EObject semanticElement)

isMultiline

protected boolean isMultiline(org.eclipse.emf.ecore.EObject semanticElement)

nextHiddenRegion

protected IHiddenRegion nextHiddenRegion(org.eclipse.emf.ecore.EObject semanticElement)

previousHiddenRegion

protected IHiddenRegion previousHiddenRegion(org.eclipse.emf.ecore.EObject semanticElement)

regionFor

protected ISemanticRegionsFinder regionFor(org.eclipse.emf.ecore.EObject semanticElement)

regionForEObject

protected IEObjectRegion regionForEObject(org.eclipse.emf.ecore.EObject semanticElement)

semanticRegions

protected java.lang.Iterable<ISemanticRegion> semanticRegions(org.eclipse.emf.ecore.EObject semanticElement)

autowrap

protected void autowrap(IHiddenRegionFormatter hrf)

Configure autowrap.

Since:

2.25

noAutowrap

protected void noAutowrap(IHiddenRegionFormatter hrf)

Suppresses auto wrap in this hidden region.

Since:

2.25

highPriority

protected void highPriority(IHiddenRegionFormatter hrf)

When merging, treat this configuration with a high priority.

Since:

2.25

See Also:

lowPriority(IHiddenRegionFormatter)

lowPriority

protected void lowPriority(IHiddenRegionFormatter hrf)

When merging, treat this configuration with a low priority.

Since:

2.25

See Also:

highPriority(IHiddenRegionFormatter)

noIndentation

protected void noIndentation(IHiddenRegionFormatter hrf)

Resets the indentation level to zero.

Since:

2.25

indent

protected void indent(IHiddenRegionFormatter hrf)

Since:

2.25

newLine

protected void newLine(IHiddenRegionFormatter hrf)

Forces a line break in this hidden region.

Since:

2.25

noSpace

protected void noSpace(IHiddenRegionFormatter hrf)

Format this hidden region with using no space (zero characters).

Since:

2.25

oneSpace

protected void oneSpace(IHiddenRegionFormatter hrf)

One space is added at this hidden region.

Since:

2.25