org.eclipse.xtext.generator.trace.internal

Class AbstractTrace

java.lang.Object

org.eclipse.xtext.generator.trace.internal.AbstractTrace

All Implemented Interfaces:

ITrace

public abstract class AbstractTrace
extends Object
implements ITrace

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractTrace.TraceAccess
protected class	AbstractTrace.TraceRegionsByURI

Constructor Summary

Constructors

Constructor and Description
AbstractTrace()

Method Summary

Methods

Modifier and Type	Method and Description
protected ILocationInResource	createLocationInResource(ITextRegionWithLineInformation region, SourceRelativeURI srcRelativePath)
protected ILocationInResource	createLocationInResourceFor(ILocationData location, AbstractTraceRegion traceRegion) Creates a new location for a target resource that matches the given location.
protected AbstractTraceRegion	doGetRootTraceRegion()
boolean	encloses(AbstractTraceRegion region, int offset, boolean includeRegionEnd) Calculate whether the given region encloses the offset.
boolean	encloses(int regionOffset, int regionLength, int offset, boolean includeRegionEnd) Calculate whether the given region encloses the offset.
protected LanguageInfo	findLanguage(AbstractURIWrapper uri)
protected AbstractTraceRegion	findParentByURI(AbstractTraceRegion region, AbsoluteURI uri, IProjectConfig project)
protected AbstractTraceRegion	findTraceRegionAt(int offset, boolean includeRegionEnd)
AbstractTraceRegion	findTraceRegionAtLeftOffset(int offset)
AbstractTraceRegion	findTraceRegionAtRightOffset(int offset)
Iterable<? extends ILocationInResource>	getAllAssociatedLocations() Returns all known associated locations.
Iterable<? extends ILocationInResource>	getAllAssociatedLocations(AbsoluteURI uri) Returns all known locations that were produced from the associated resource in the given absoluteTargetResource.
Iterable<? extends ILocationInResource>	getAllAssociatedLocations(ITextRegion localRegion) Returns all associated locations that match the given region.
Iterable<? extends ILocationInResource>	getAllAssociatedLocations(ITextRegion localRegion, AbsoluteURI uri) Returns all individual locations that match the given localRegion for the expected absoluteTargetResource.
protected Iterable<AbstractTraceRegion>	getAllTraceRegions()
protected Iterable<AbstractTraceRegion>	getAllTraceRegions(ITextRegion localRegion)
ILocationInResource	getBestAssociatedLocation(ITextRegion region) Returns the best associated location that matches the given region.
ILocationInResource	getBestAssociatedLocation(ITextRegion localRegion, AbsoluteURI uri) Returns the best location that matches the given localRegion in the absoluteTargetResource.
protected abstract InputStream	getContents(SourceRelativeURI uri)
protected abstract Reader	getContentsAsText(SourceRelativeURI uri)
protected abstract Reader	getLocalContentsAsText()
LanguageInfo	getLocalLanguage() Returns the language that is associated with the local resource.
abstract IProjectConfig	getLocalProjectConfig() Returns the local project.
abstract AbsoluteURI	getLocalURI() Returns the absolute URI of the local resource.
protected ILocationInResource	getMergedLocationInResource(AbstractTraceRegion region)
AbstractTraceRegion	getRootTraceRegion() Returns the root trace region where AbstractStatefulTraceRegion.getMyOffset() and AbstractStatefulTraceRegion.getMyLength() return the information for the resource that this ITrace is associated with.
protected <T> T	getService(AbstractURIWrapper uri, Class<T> type)
SourceRelativeURI	getSrcRelativeLocalURI() Returns the relative URI of the local resource.
protected ITraceRegionProvider	getTraceRegionProvider()
boolean	hasTraceData() Returns true if the trace is not empty and can provide at leat one location.
protected boolean	isAssociatedWith(AbstractTraceRegion region, AbsoluteURI uri, IProjectConfig project)
boolean	isTraceToSource()
boolean	isTraceToTarget()
protected ILocationInResource	mergeRegions(AbstractTraceRegion left, AbstractTraceRegion right)
protected AbsoluteURI	resolvePath(SourceRelativeURI path)
void	setTraceRegionProvider(ITraceRegionProvider traceRegionProvider)
void	setTraceToSource(boolean isTraceToSource)
protected Iterable<? extends ILocationInResource>	toLocations(Iterable<AbstractTraceRegion> allTraceRegions)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTrace

public AbstractTrace()

Method Detail

getRootTraceRegion

public final AbstractTraceRegion getRootTraceRegion()

Returns the root trace region where AbstractStatefulTraceRegion.getMyOffset() and AbstractStatefulTraceRegion.getMyLength() return the information for the resource that this ITrace is associated with.

Returns:

the root trace region. May be null if no trace data is available.

hasTraceData

public boolean hasTraceData()

Description copied from interface: ITrace

Returns true if the trace is not empty and can provide at leat one location.

Specified by:

hasTraceData in interface ITrace

setTraceToSource

public void setTraceToSource(boolean isTraceToSource)

isTraceToSource

public boolean isTraceToSource()

isTraceToTarget

public boolean isTraceToTarget()

doGetRootTraceRegion

protected AbstractTraceRegion doGetRootTraceRegion()

setTraceRegionProvider

public void setTraceRegionProvider(ITraceRegionProvider traceRegionProvider)

getTraceRegionProvider

protected ITraceRegionProvider getTraceRegionProvider()

getBestAssociatedLocation

public ILocationInResource getBestAssociatedLocation(ITextRegion region)

Description copied from interface: ITrace

Returns the best associated location that matches the given region. If the region does not match a single location, the following strategy applies:

• If the region spans multiple locations where the first and the last location belong to the same resource, the merged location is returned.
• If the region spans multiple locations that belong to different resources, the longest prefix location for a single resource is returned.
• If the region spans multiple overlapping locations that belong to different resources, null is returned.

If no location data is available, returns null.

Specified by:

getBestAssociatedLocation in interface ITrace

Parameters:

region - the region in the current resource. May not be null.

Returns:

the best associated location or null if none.

mergeRegions

protected ILocationInResource mergeRegions(AbstractTraceRegion left,
                               AbstractTraceRegion right)

createLocationInResource

protected ILocationInResource createLocationInResource(ITextRegionWithLineInformation region,
                                           SourceRelativeURI srcRelativePath)

getMergedLocationInResource

protected ILocationInResource getMergedLocationInResource(AbstractTraceRegion region)

createLocationInResourceFor

protected ILocationInResource createLocationInResourceFor(ILocationData location,
                                              AbstractTraceRegion traceRegion)

Creates a new location for a target resource that matches the given location.

Parameters:

location - the location

Returns:

the location in resource, null detecting a path fails.

resolvePath

protected AbsoluteURI resolvePath(SourceRelativeURI path)

findTraceRegionAtRightOffset

public AbstractTraceRegion findTraceRegionAtRightOffset(int offset)

findTraceRegionAt

protected AbstractTraceRegion findTraceRegionAt(int offset,
                                    boolean includeRegionEnd)

findTraceRegionAtLeftOffset

public AbstractTraceRegion findTraceRegionAtLeftOffset(int offset)

encloses

public boolean encloses(AbstractTraceRegion region,
               int offset,
               boolean includeRegionEnd)

Calculate whether the given region encloses the offset.

Parameters:

region - the region to be checked. May not be null.

offset - the offset that should be enclosed by the region.

includeRegionEnd - whether a region is enclosing the offset if it ends at that location.

Returns:

true if the given region encloses the offset.

encloses

public boolean encloses(int regionOffset,
               int regionLength,
               int offset,
               boolean includeRegionEnd)

Calculate whether the given region encloses the offset.

Parameters:

regionOffset - the start of the region that should be checked.

regionLength - the length of the region that should be checked.

offset - the offset that should be enclosed by the region.

includeRegionEnd - whether a region is enclosing the offset if it ends at that location.

Returns:

true if the given region encloses the offset.

getAllAssociatedLocations

public Iterable<? extends ILocationInResource> getAllAssociatedLocations(ITextRegion localRegion)

Description copied from interface: ITrace

Returns all associated locations that match the given region.

Specified by:

getAllAssociatedLocations in interface ITrace

Parameters:

localRegion - the region in the current resource. May not be null.

Returns:

all associated locations. Never null.

getBestAssociatedLocation

public ILocationInResource getBestAssociatedLocation(ITextRegion localRegion,
                                            AbsoluteURI uri)

Description copied from interface: ITrace

Returns the best location that matches the given localRegion in the absoluteTargetResource. If the region does not match a single location in the target, the following strategy applies:

• The merged region of all matching locations in the targetResource is returned.

If no location data is available or the localRegion does not yield a location in absoluteTargetResource, returns null.

Specified by:

getBestAssociatedLocation in interface ITrace

Parameters:

localRegion - the region in the current resource. May not be null.

uri - the expected target resource. May not be null.

Returns:

the best associated location or null if none.

isAssociatedWith

protected boolean isAssociatedWith(AbstractTraceRegion region,
                       AbsoluteURI uri,
                       IProjectConfig project)

findParentByURI

protected AbstractTraceRegion findParentByURI(AbstractTraceRegion region,
                                  AbsoluteURI uri,
                                  IProjectConfig project)

getAllAssociatedLocations

public Iterable<? extends ILocationInResource> getAllAssociatedLocations(ITextRegion localRegion,
                                                                AbsoluteURI uri)

Description copied from interface: ITrace

Returns all individual locations that match the given localRegion for the expected absoluteTargetResource.

Specified by:

getAllAssociatedLocations in interface ITrace

Parameters:

localRegion - the region in the current resource. May not be null.

uri - the expected target resource. May not be null.

Returns:

all associated locations. Never null.

getAllAssociatedLocations

public Iterable<? extends ILocationInResource> getAllAssociatedLocations(AbsoluteURI uri)

Description copied from interface: ITrace

Returns all known locations that were produced from the associated resource in the given absoluteTargetResource.

Specified by:

getAllAssociatedLocations in interface ITrace

Parameters:

uri - the expected target resource. May not be null.

Returns:

all locations. Never null.

getLocalLanguage

public LanguageInfo getLocalLanguage()

Description copied from interface: ITrace

Returns the language that is associated with the local resource. May be null if the artifact does not have an associated Xtext language, e.g. for html or java files.

Specified by:

getLocalLanguage in interface ITrace

Returns:

the language that is associated with the local resource. May be null.

getLocalURI

public abstract AbsoluteURI getLocalURI()

Description copied from interface: ITrace

Returns the absolute URI of the local resource. Never null.

Specified by:

getLocalURI in interface ITrace

Returns:

the absolute URI of the local resource. Never null.

getSrcRelativeLocalURI

public SourceRelativeURI getSrcRelativeLocalURI()

Description copied from interface: ITrace

Returns the relative URI of the local resource. Never null. In other words: returns the URI as it would be relative to the class path after the resource was packaged. If the resource resides in a source folder of a java project, it'll return the URI relative to the source folder itself. Otherwise relative to the project root.

Specified by:

getSrcRelativeLocalURI in interface ITrace

Returns:

the relative URI of the local resource. Never null.

getLocalProjectConfig

public abstract IProjectConfig getLocalProjectConfig()

Description copied from interface: ITrace

Returns the local project. Never null.

Specified by:

getLocalProjectConfig in interface ITrace

Returns:

the local project. Never null.

toLocations

protected Iterable<? extends ILocationInResource> toLocations(Iterable<AbstractTraceRegion> allTraceRegions)

getAllTraceRegions

protected Iterable<AbstractTraceRegion> getAllTraceRegions(ITextRegion localRegion)

getAllAssociatedLocations

public Iterable<? extends ILocationInResource> getAllAssociatedLocations()

Description copied from interface: ITrace

Returns all known associated locations.

Specified by:

getAllAssociatedLocations in interface ITrace

Returns:

all associated locations. Never null.

getAllTraceRegions

protected Iterable<AbstractTraceRegion> getAllTraceRegions()

getContents

protected abstract InputStream getContents(SourceRelativeURI uri)
                                    throws IOException

Throws:

IOException

getContentsAsText

protected abstract Reader getContentsAsText(SourceRelativeURI uri)
                                     throws IOException

Throws:

IOException

getLocalContentsAsText

protected abstract Reader getLocalContentsAsText()
                                          throws IOException

Throws:

IOException

findLanguage

protected LanguageInfo findLanguage(AbstractURIWrapper uri)

getService

protected <T> T getService(AbstractURIWrapper uri,
               Class<T> type)

toString

public String toString()

Overrides:

toString in class Object