org.eclipse.xtext.xbase.formatting2

Class XbaseFormatter

java.lang.Object

org.eclipse.xtext.formatting2.AbstractFormatter2

org.eclipse.xtext.xbase.formatting2.XtypeFormatter

org.eclipse.xtext.xbase.formatting2.XbaseFormatter

All Implemented Interfaces:

IFormatter2

Direct Known Subclasses:

XbaseWithAnnotationsFormatter

public class XbaseFormatter
extends XtypeFormatter

Author:

Moritz Eysholdt - Initial implementation and API, Lorenzo Bettini - https://bugs.eclipse.org/bugs/show_bug.cgi?id=471239

Field Summary

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

textRegionExtensions

Constructor Summary

Constructors

Constructor and Description
XbaseFormatter()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	_format(JvmFormalParameter expr, IFormattableDocument format)
protected void	_format(JvmGenericArrayTypeReference array, IFormattableDocument document)
protected void	_format(JvmTypeConstraint constraint, IFormattableDocument document)
protected void	_format(XAssignment expr, IFormattableDocument format)
protected void	_format(XBasicForLoopExpression expr, IFormattableDocument format)
protected void	_format(XBinaryOperation expr, IFormattableDocument format)
protected void	_format(XBlockExpression expr, IFormattableDocument format)
protected void	_format(XCastedExpression expr, IFormattableDocument doc)
protected void	_format(XClosure expr, IFormattableDocument format)
protected void	_format(XCollectionLiteral literal, IFormattableDocument document)
protected void	_format(XConstructorCall expr, IFormattableDocument format)
protected void	_format(XDoWhileExpression expr, IFormattableDocument format)
protected void	_format(XExpression expr, IFormattableDocument format)
protected void	_format(XFeatureCall expr, IFormattableDocument format)
protected void	_format(XForLoopExpression expr, IFormattableDocument format)
protected void	_format(XIfExpression expr, IFormattableDocument format)
protected void	_format(XInstanceOfExpression expr, IFormattableDocument doc)
protected void	_format(XMemberFeatureCall expr, IFormattableDocument format)
protected void	_format(XPostfixOperation expr, IFormattableDocument doc)
protected void	_format(XReturnExpression expr, IFormattableDocument format)
protected void	_format(XSwitchExpression expr, IFormattableDocument format)
protected void	_format(XSynchronizedExpression expr, IFormattableDocument format)
protected void	_format(XThrowExpression expr, IFormattableDocument format)
protected void	_format(XTryCatchFinallyExpression expr, IFormattableDocument format)
protected void	_format(XTypeLiteral expr, IFormattableDocument format)
protected void	_format(XVariableDeclaration expr, IFormattableDocument format)
protected void	_format(XWhileExpression expr, IFormattableDocument format)
protected AbstractRule	binaryOperationPrecedence(org.eclipse.emf.ecore.EObject op)
protected XClosure	builder(java.util.List<XExpression> params)
protected java.lang.Iterable<XExpression>	explicitParams(java.util.List<XExpression> params)
void	format(java.lang.Object expr, IFormattableDocument format) Implement this method to create a language-specific formatter.
protected void	formatBody(XExpression expr, boolean forceMultiline, IFormattableDocument doc)
protected void	formatBodyInline(XExpression expr, boolean forceMultiline, IFormattableDocument doc)
protected void	formatBodyParagraph(XExpression expr, IFormattableDocument doc)
protected void	formatBuilderWithLeadingGap(XClosure closure, IFormattableDocument format)
protected ISemanticRegion	formatClosureParams(XClosure expr, ISemanticRegion open, IFormattableDocument format, Procedures.Procedure1<? super IHiddenRegionFormatter> init)
protected void	formatCommaSeparatedList(java.util.Collection<? extends org.eclipse.emf.ecore.EObject> elements, ISemanticRegion open, ISemanticRegion close, IFormattableDocument format)
protected void	formatExpressionsMultiline(java.util.Collection<? extends XExpression> expressions, ISemanticRegion open, ISemanticRegion close, IFormattableDocument format)
protected void	formatExpressionsSingleline(java.util.Collection<? extends XExpression> expressions, ISemanticRegion open, ISemanticRegion close, IFormattableDocument format)
protected void	formatFeatureCallParams(java.util.List<XExpression> params, ISemanticRegion open, ISemanticRegion close, IFormattableDocument format)
protected void	formatFeatureCallTypeParameters(XAbstractFeatureCall expr, IFormattableDocument format)
XbaseGrammarAccess	getGrammar()
protected boolean	isMultilineOrInNewLine(org.eclipse.emf.ecore.EObject obj)
protected boolean	isSingleLineBlock(XBlockExpression expr)
protected boolean	prependNewLineIfMultiline(org.eclipse.emf.ecore.EObject obj)

Methods inherited from class org.eclipse.xtext.xbase.formatting2.XtypeFormatter

_format, _format, _format, _format, _format, _format

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, initalize, isInRequestedRange, postProcess, reset, shouldFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

XbaseFormatter

public XbaseFormatter()

Method Detail

_format

protected void _format(XCollectionLiteral literal,
           @Extension
           IFormattableDocument document)

formatCommaSeparatedList

protected void formatCommaSeparatedList(java.util.Collection<? extends org.eclipse.emf.ecore.EObject> elements,
                            ISemanticRegion open,
                            ISemanticRegion close,
                            @Extension
                            IFormattableDocument format)

_format

protected void _format(JvmGenericArrayTypeReference array,
           @Extension
           IFormattableDocument document)

_format

protected void _format(JvmTypeConstraint constraint,
           @Extension
           IFormattableDocument document)

_format

protected void _format(XVariableDeclaration expr,
           @Extension
           IFormattableDocument format)

_format

protected void _format(XAssignment expr,
           @Extension
           IFormattableDocument format)

formatFeatureCallParams

protected void formatFeatureCallParams(java.util.List<XExpression> params,
                           ISemanticRegion open,
                           ISemanticRegion close,
                           @Extension
                           IFormattableDocument format)

formatBuilderWithLeadingGap

protected void formatBuilderWithLeadingGap(XClosure closure,
                               @Extension
                               IFormattableDocument format)

builder

protected XClosure builder(java.util.List<XExpression> params)

explicitParams

protected java.lang.Iterable<XExpression> explicitParams(java.util.List<XExpression> params)

_format

protected void _format(XConstructorCall expr,
           @Extension
           IFormattableDocument format)

formatFeatureCallTypeParameters

protected void formatFeatureCallTypeParameters(XAbstractFeatureCall expr,
                                   @Extension
                                   IFormattableDocument format)

_format

protected void _format(XFeatureCall expr,
           @Extension
           IFormattableDocument format)

_format

protected void _format(XMemberFeatureCall expr,
           @Extension
           IFormattableDocument format)

binaryOperationPrecedence

protected AbstractRule binaryOperationPrecedence(org.eclipse.emf.ecore.EObject op)

_format

protected void _format(XBinaryOperation expr,
           @Extension
           IFormattableDocument format)

prependNewLineIfMultiline

protected boolean prependNewLineIfMultiline(org.eclipse.emf.ecore.EObject obj)

_format

protected void _format(XSynchronizedExpression expr,
           @Extension
           IFormattableDocument format)

_format

protected void _format(XIfExpression expr,
           @Extension
           IFormattableDocument format)

_format

protected void _format(XForLoopExpression expr,
           @Extension
           IFormattableDocument format)

_format

protected void _format(XBasicForLoopExpression expr,
           @Extension
           IFormattableDocument format)

_format

protected void _format(XWhileExpression expr,
           @Extension
           IFormattableDocument format)

_format

protected void _format(XDoWhileExpression expr,
           @Extension
           IFormattableDocument format)

_format

protected void _format(XBlockExpression expr,
           @Extension
           IFormattableDocument format)

isSingleLineBlock

protected boolean isSingleLineBlock(XBlockExpression expr)

_format

protected void _format(XTypeLiteral expr,
           @Extension
           IFormattableDocument format)

_format

protected void _format(XThrowExpression expr,
           @Extension
           IFormattableDocument format)

_format

protected void _format(XReturnExpression expr,
           @Extension
           IFormattableDocument format)

_format

protected void _format(XTryCatchFinallyExpression expr,
           @Extension
           IFormattableDocument format)

_format

protected void _format(JvmFormalParameter expr,
           @Extension
           IFormattableDocument format)

_format

protected void _format(XExpression expr,
           @Extension
           IFormattableDocument format)

_format

protected void _format(XSwitchExpression expr,
           @Extension
           IFormattableDocument format)

formatClosureParams

protected ISemanticRegion formatClosureParams(XClosure expr,
                                  ISemanticRegion open,
                                  @Extension
                                  IFormattableDocument format,
                                  Procedures.Procedure1<? super IHiddenRegionFormatter> init)

_format

protected void _format(XClosure expr,
           @Extension
           IFormattableDocument format)

formatBody

protected void formatBody(XExpression expr,
              boolean forceMultiline,
              @Extension
              IFormattableDocument doc)

formatBodyInline

protected void formatBodyInline(XExpression expr,
                    boolean forceMultiline,
                    @Extension
                    IFormattableDocument doc)

formatBodyParagraph

protected void formatBodyParagraph(XExpression expr,
                       @Extension
                       IFormattableDocument doc)

_format

protected void _format(XInstanceOfExpression expr,
           @Extension
           IFormattableDocument doc)

_format

protected void _format(XCastedExpression expr,
           @Extension
           IFormattableDocument doc)

_format

protected void _format(XPostfixOperation expr,
           @Extension
           IFormattableDocument doc)

formatExpressionsMultiline

protected void formatExpressionsMultiline(java.util.Collection<? extends XExpression> expressions,
                              ISemanticRegion open,
                              ISemanticRegion close,
                              @Extension
                              IFormattableDocument format)

formatExpressionsSingleline

protected void formatExpressionsSingleline(java.util.Collection<? extends XExpression> expressions,
                               ISemanticRegion open,
                               ISemanticRegion close,
                               @Extension
                               IFormattableDocument format)

isMultilineOrInNewLine

protected boolean isMultilineOrInNewLine(org.eclipse.emf.ecore.EObject obj)

format

public void format(java.lang.Object expr,
          IFormattableDocument format)

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.

Overrides:

format in class XtypeFormatter

Parameters:

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

format - The document to collect and execute ITextReplacers.

getGrammar

@Pure
public XbaseGrammarAccess getGrammar()