org.eclipse.xtext.formatting.impl

Class FormattingConfigBasedStream

java.lang.Object

org.eclipse.xtext.formatting.impl.AbstractTokenStream

org.eclipse.xtext.formatting.impl.BaseTokenStream

org.eclipse.xtext.formatting.impl.FormattingConfigBasedStream

All Implemented Interfaces:

ITokenStream, ITokenStreamExtension

public class FormattingConfigBasedStream
extends BaseTokenStream

Author:

Moritz Eysholdt - Initial contribution and API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FormattingConfigBasedStream.Line
protected class	FormattingConfigBasedStream.LineEntry

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<AbstractFormattingConfig.ElementLocator>	activeRangeLocators
protected FormattingConfig	cfg
protected FormattingConfigBasedStream.Line	currentLine
protected IHiddenTokenHelper	hiddenTokenHelper
protected int	indentationLevel
protected String	indentationPrefix
protected org.eclipse.emf.ecore.EObject	last
protected IElementMatcherProvider.IElementMatcher<AbstractFormattingConfig.ElementPattern>	matcher
protected String	preservedWS
protected boolean	preserveSpaces

Fields inherited from class org.eclipse.xtext.formatting.impl.BaseTokenStream

out

Constructor Summary

Constructors

Constructor and Description
FormattingConfigBasedStream(ITokenStream out, String initialIndentation, FormattingConfig cfg, IElementMatcherProvider.IElementMatcher<AbstractFormattingConfig.ElementPattern> matcher, IHiddenTokenHelper hiddenTokenHelper, boolean preserveSpaces)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addLineEntry(org.eclipse.emf.ecore.EObject grammarElement, String value, boolean isHidden)
protected Set<AbstractFormattingConfig.ElementLocator>	collectLocators(org.eclipse.emf.ecore.EObject ele)
protected Set<AbstractFormattingConfig.ElementLocator>	collectLocatorsForComments(Collection<AbstractFormattingConfig.ElementLocator> semanticLocators, org.eclipse.emf.ecore.EObject left, org.eclipse.emf.ecore.EObject right)
protected FormattingConfigBasedStream.Line	createLine()
protected FormattingConfigBasedStream.Line	createLine(int leftover)
protected FormattingConfigBasedStream.Line	createLine(List<FormattingConfigBasedStream.LineEntry> entries)
protected FormattingConfigBasedStream.Line	createLine(List<FormattingConfigBasedStream.LineEntry> initialEntries, int leftover)
FormattingConfigBasedStream.LineEntry	createLineEntry(org.eclipse.emf.ecore.EObject grammarElement, String value, boolean isHidden, Set<AbstractFormattingConfig.ElementLocator> beforeLocators, String leadingWS, int indent, ParserRule hiddenTokenDefition)
protected Pair<Integer,RuleCall>	findTopmostHiddenTokenDef()
void	flush()
protected String	getLineSeparator()
void	init(ParserRule startRule)
void	writeHidden(org.eclipse.emf.ecore.EObject grammarElement, String value)
void	writeSemantic(org.eclipse.emf.ecore.EObject grammarElement, String value)

Methods inherited from class java.lang.Object

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

Field Detail

activeRangeLocators

protected Set<AbstractFormattingConfig.ElementLocator> activeRangeLocators

cfg

protected FormattingConfig cfg

currentLine

protected FormattingConfigBasedStream.Line currentLine

hiddenTokenHelper

protected IHiddenTokenHelper hiddenTokenHelper

indentationLevel

protected int indentationLevel

indentationPrefix

protected String indentationPrefix

last

protected org.eclipse.emf.ecore.EObject last

matcher

protected IElementMatcherProvider.IElementMatcher<AbstractFormattingConfig.ElementPattern> matcher

preservedWS

protected String preservedWS

preserveSpaces

protected boolean preserveSpaces

Constructor Detail

FormattingConfigBasedStream

public FormattingConfigBasedStream(ITokenStream out,
                           String initialIndentation,
                           FormattingConfig cfg,
                           IElementMatcherProvider.IElementMatcher<AbstractFormattingConfig.ElementPattern> matcher,
                           IHiddenTokenHelper hiddenTokenHelper,
                           boolean preserveSpaces)

Method Detail

getLineSeparator

protected String getLineSeparator()

Since:

2.3

addLineEntry

protected void addLineEntry(org.eclipse.emf.ecore.EObject grammarElement,
                String value,
                boolean isHidden)
                     throws IOException

Throws:

IOException

collectLocators

protected Set<AbstractFormattingConfig.ElementLocator> collectLocators(org.eclipse.emf.ecore.EObject ele)

collectLocatorsForComments

protected Set<AbstractFormattingConfig.ElementLocator> collectLocatorsForComments(Collection<AbstractFormattingConfig.ElementLocator> semanticLocators,
                                                                      org.eclipse.emf.ecore.EObject left,
                                                                      org.eclipse.emf.ecore.EObject right)

createLine

protected FormattingConfigBasedStream.Line createLine()

createLine

protected FormattingConfigBasedStream.Line createLine(int leftover)

createLine

protected FormattingConfigBasedStream.Line createLine(List<FormattingConfigBasedStream.LineEntry> entries)

createLine

protected FormattingConfigBasedStream.Line createLine(List<FormattingConfigBasedStream.LineEntry> initialEntries,
                                          int leftover)

createLineEntry

public FormattingConfigBasedStream.LineEntry createLineEntry(org.eclipse.emf.ecore.EObject grammarElement,
                                                    String value,
                                                    boolean isHidden,
                                                    Set<AbstractFormattingConfig.ElementLocator> beforeLocators,
                                                    String leadingWS,
                                                    int indent,
                                                    ParserRule hiddenTokenDefition)

findTopmostHiddenTokenDef

protected Pair<Integer,RuleCall> findTopmostHiddenTokenDef()

flush

public void flush()
           throws IOException

Specified by:

flush in interface ITokenStream

Overrides:

flush in class BaseTokenStream

Throws:

IOException

init

public void init(ParserRule startRule)

Specified by:

init in interface ITokenStreamExtension

Overrides:

init in class BaseTokenStream

writeHidden

public void writeHidden(org.eclipse.emf.ecore.EObject grammarElement,
               String value)
                 throws IOException

Specified by:

writeHidden in interface ITokenStream

Overrides:

writeHidden in class AbstractTokenStream

Throws:

IOException

writeSemantic

public void writeSemantic(org.eclipse.emf.ecore.EObject grammarElement,
                 String value)
                   throws IOException

Specified by:

writeSemantic in interface ITokenStream

Overrides:

writeSemantic in class AbstractTokenStream

Throws:

IOException