org.eclipse.xtext.formatting2.internal

Class FormattableDocument

java.lang.Object

org.eclipse.xtext.formatting2.internal.FormattableDocument

All Implemented Interfaces:

IFormattableDocument

Direct Known Subclasses:

RootDocument, SubDocument

public abstract class FormattableDocument
extends Object
implements IFormattableDocument

Author:

Moritz Eysholdt - Initial contribution and API

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FormattableDocument()

Method Summary

Methods

Modifier and Type	Method and Description
void	addReplacer(ITextReplacer replacer) Add a new replacer to the document.
ISemanticRegion	append(ISemanticRegion token, Procedures.Procedure1<? super IHiddenRegionFormatter> after) Create a new IHiddenRegionFormatting, initialize it, and add it behind the given semanticRegion.
<T extends org.eclipse.emf.ecore.EObject> T	append(T owner, Procedures.Procedure1<? super IHiddenRegionFormatter> after) Create a new IHiddenRegionFormatting, initialize it, and add it behind the given semantic object.
protected String	applyTextReplacements(Iterable<ITextReplacement> replacements)
protected ITextReplacerContext	createReplacements(ITextReplacerContext previous)
protected TextSegmentSet<ITextReplacer>	createTextReplacerSet()
<T> T	format(T obj)
void	formatConditionally(org.eclipse.emf.ecore.EObject owner, ISubFormatter... formatters) Apply the formatting of the first sub formatter that can successfully format the given owner's region.
void	formatConditionally(int offset, int length, ISubFormatter... formatters) Apply the formatting of the first sub formatter that can successfully format the given region.
ITypedPreferenceValues	getPreferences()
ITextRegionAccess	getTextRegionAccess()
<T1 extends ISemanticRegion,T2 extends ISemanticRegion> Pair<T1,T2>	interior(Pair<T1,T2> pair, Procedures.Procedure1<? super IHiddenRegionFormatter> init)
<T1 extends ISemanticRegion,T2 extends ISemanticRegion> Pair<T1,T2>	interior(T1 first, T2 second, Procedures.Procedure1<? super IHiddenRegionFormatter> init)
<T extends org.eclipse.emf.ecore.EObject> T	interior(T object, Procedures.Procedure1<? super IHiddenRegionFormatter> init)
protected boolean	needsAutowrap(ITextReplacerContext wrappable, ITextReplacerContext context, int maxLineWidth)
ISemanticRegion	prepend(ISemanticRegion token, Procedures.Procedure1<? super IHiddenRegionFormatter> before) Create a new IHiddenRegionFormatting, initialize it, and add it before the given semanticRegion.
<T extends org.eclipse.emf.ecore.EObject> T	prepend(T owner, Procedures.Procedure1<? super IHiddenRegionFormatter> before) Create a new IHiddenRegionFormatting, initialize it, and add it before the given semantic object.
List<ITextReplacement>	renderToTextReplacements() Render the document.
Pair<IHiddenRegion,IHiddenRegion>	set(IHiddenRegion first, IHiddenRegion second, Procedures.Procedure1<? super IHiddenRegionFormatter> init)
IHiddenRegion	set(IHiddenRegion hiddenRegion, Procedures.Procedure1<? super IHiddenRegionFormatter> init) Create a new IHiddenRegionFormatting, initialize it, and add it for the given hidden region.
ISemanticRegion	surround(ISemanticRegion token, Procedures.Procedure1<? super IHiddenRegionFormatter> beforeAndAfter) Create a new IHiddenRegionFormatting, initialize it, and add it before and after the given semantic region.
<T extends org.eclipse.emf.ecore.EObject> T	surround(T owner, Procedures.Procedure1<? super IHiddenRegionFormatter> beforeAndAfter) Create a new IHiddenRegionFormatting, initialize it, and add it before and after the given semantic object.
String	toString()
IFormattableSubDocument	withReplacerFilter(com.google.common.base.Predicate<? super ITextReplacer> filter) Creates a new formattable document to which only replacers can be added for which the provided predicate yields true.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.xtext.formatting2.IFormattableDocument

getFormatter, getRegion, getRequest

Constructor Detail

FormattableDocument

protected FormattableDocument()

Method Detail

addReplacer

public void addReplacer(ITextReplacer replacer)

Description copied from interface: IFormattableDocument

Add a new replacer to the document.

Specified by:

addReplacer in interface IFormattableDocument

append

public ISemanticRegion append(ISemanticRegion token,
                     Procedures.Procedure1<? super IHiddenRegionFormatter> after)

Description copied from interface: IFormattableDocument

Create a new IHiddenRegionFormatting, initialize it, and add it behind the given semanticRegion. Returns the given semantic region.

Specified by:

append in interface IFormattableDocument

append

public <T extends org.eclipse.emf.ecore.EObject> T append(T owner,
                                                 Procedures.Procedure1<? super IHiddenRegionFormatter> after)

Description copied from interface: IFormattableDocument

Create a new IHiddenRegionFormatting, initialize it, and add it behind the given semantic object. Returns the given semantic object.

Specified by:

append in interface IFormattableDocument

applyTextReplacements

protected String applyTextReplacements(Iterable<ITextReplacement> replacements)

createReplacements

protected ITextReplacerContext createReplacements(ITextReplacerContext previous)

createTextReplacerSet

protected TextSegmentSet<ITextReplacer> createTextReplacerSet()

format

public <T> T format(T obj)

Specified by:

format in interface IFormattableDocument

formatConditionally

public void formatConditionally(org.eclipse.emf.ecore.EObject owner,
                       ISubFormatter... formatters)

Description copied from interface: IFormattableDocument

Apply the formatting of the first sub formatter that can successfully format the given owner's region. A sub formatters execution is considered successful if it didn't throw an FormattingNotApplicableException.

Specified by:

formatConditionally in interface IFormattableDocument

formatConditionally

public void formatConditionally(int offset,
                       int length,
                       ISubFormatter... formatters)
                         throws FormattingNotApplicableException

Description copied from interface: IFormattableDocument

Apply the formatting of the first sub formatter that can successfully format the given region. A sub formatters execution is considered successful if it didn't throw an FormattingNotApplicableException.

Specified by:

formatConditionally in interface IFormattableDocument

Throws:

FormattingNotApplicableException

getPreferences

public ITypedPreferenceValues getPreferences()

getTextRegionAccess

public ITextRegionAccess getTextRegionAccess()

interior

public <T1 extends ISemanticRegion,T2 extends ISemanticRegion> Pair<T1,T2> interior(Pair<T1,T2> pair,
                                                                           Procedures.Procedure1<? super IHiddenRegionFormatter> init)

Specified by:

interior in interface IFormattableDocument

interior

public <T extends org.eclipse.emf.ecore.EObject> T interior(T object,
                                                   Procedures.Procedure1<? super IHiddenRegionFormatter> init)

Specified by:

interior in interface IFormattableDocument

interior

public <T1 extends ISemanticRegion,T2 extends ISemanticRegion> Pair<T1,T2> interior(T1 first,
                                                                           T2 second,
                                                                           Procedures.Procedure1<? super IHiddenRegionFormatter> init)

Specified by:

interior in interface IFormattableDocument

needsAutowrap

protected boolean needsAutowrap(ITextReplacerContext wrappable,
                    ITextReplacerContext context,
                    int maxLineWidth)

prepend

public ISemanticRegion prepend(ISemanticRegion token,
                      Procedures.Procedure1<? super IHiddenRegionFormatter> before)

Description copied from interface: IFormattableDocument

Create a new IHiddenRegionFormatting, initialize it, and add it before the given semanticRegion. Returns the given semantic region.

Specified by:

prepend in interface IFormattableDocument

prepend

public <T extends org.eclipse.emf.ecore.EObject> T prepend(T owner,
                                                  Procedures.Procedure1<? super IHiddenRegionFormatter> before)

Description copied from interface: IFormattableDocument

Create a new IHiddenRegionFormatting, initialize it, and add it before the given semantic object. Returns the given semantic object.

Specified by:

prepend in interface IFormattableDocument

renderToTextReplacements

public List<ITextReplacement> renderToTextReplacements()

Description copied from interface: IFormattableDocument

Render the document. This executes all contained replacers and returns the text replacements created by them.

Specified by:

renderToTextReplacements in interface IFormattableDocument

set

public Pair<IHiddenRegion,IHiddenRegion> set(IHiddenRegion first,
                                    IHiddenRegion second,
                                    Procedures.Procedure1<? super IHiddenRegionFormatter> init)

Specified by:

set in interface IFormattableDocument

set

public IHiddenRegion set(IHiddenRegion hiddenRegion,
                Procedures.Procedure1<? super IHiddenRegionFormatter> init)

Description copied from interface: IFormattableDocument

Create a new IHiddenRegionFormatting, initialize it, and add it for the given hidden region. Returns the given hidden region.

Specified by:

set in interface IFormattableDocument

surround

public ISemanticRegion surround(ISemanticRegion token,
                       Procedures.Procedure1<? super IHiddenRegionFormatter> beforeAndAfter)

Description copied from interface: IFormattableDocument

Create a new IHiddenRegionFormatting, initialize it, and add it before and after the given semantic region. Returns the given semantic region.

Specified by:

surround in interface IFormattableDocument

surround

public <T extends org.eclipse.emf.ecore.EObject> T surround(T owner,
                                                   Procedures.Procedure1<? super IHiddenRegionFormatter> beforeAndAfter)

Description copied from interface: IFormattableDocument

Create a new IHiddenRegionFormatting, initialize it, and add it before and after the given semantic object. Returns the given semantic object.

Specified by:

surround in interface IFormattableDocument

toString

public String toString()

Overrides:

toString in class Object

withReplacerFilter

public IFormattableSubDocument withReplacerFilter(com.google.common.base.Predicate<? super ITextReplacer> filter)

Description copied from interface: IFormattableDocument

Creates a new formattable document to which only replacers can be added for which the provided predicate yields true.

Specified by:

withReplacerFilter in interface IFormattableDocument