org.eclipse.xtext.generator.trace

Interface ITrace

public interface ITrace

The trace provides a way to work with tracing information of a code generator.

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ITrace.Internal

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<ILocationInResource>	getAllAssociatedLocations() Returns all known associated locations.
Iterable<ILocationInResource>	getAllAssociatedLocations(org.eclipse.core.resources.IStorage associatedStorage) Returns all known locations that were produced from the associated resource in the given targetResource.
Iterable<ILocationInResource>	getAllAssociatedLocations(ITextRegion localRegion) Returns all associated locations that match the given region.
Iterable<ILocationInResource>	getAllAssociatedLocations(ITextRegion localRegion, org.eclipse.core.resources.IStorage associatedStorage) Returns all individual locations that match the given sourceRegion for the expected targetResource.
ILocationInResource	getBestAssociatedLocation(ITextRegion localRegion) Returns the best associated location that matches the given region.
ILocationInResource	getBestAssociatedLocation(ITextRegion localRegion, org.eclipse.core.resources.IStorage associatedStorage) Returns the best location that matches the given sourceRegion in the targetResource.
LanguageInfo	getLanguage() Returns the language that is associated with the source resource.
org.eclipse.core.resources.IProject	getLocalProject() Returns the source project.
org.eclipse.emf.common.util.URI	getLocalURI() Returns the URI of the source resource.

Method Detail

getBestAssociatedLocation

ILocationInResource getBestAssociatedLocation(ITextRegion localRegion)

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.

Parameters:

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

Returns:

the best associated location or null if none.

getAllAssociatedLocations

Iterable<ILocationInResource> getAllAssociatedLocations(ITextRegion localRegion)

Returns all associated locations that match the given region.

Parameters:

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

Returns:

all associated locations. Never null.

getAllAssociatedLocations

Iterable<ILocationInResource> getAllAssociatedLocations()

Returns all known associated locations.

Returns:

all associated locations. Never null.

getLocalProject

org.eclipse.core.resources.IProject getLocalProject()

Returns the source project. Never null.

Returns:

the source project. Never null.

getLocalURI

org.eclipse.emf.common.util.URI getLocalURI()

Returns the URI of the source resource. Never null.

Returns:

the URI of the source resource. Never null.

getLanguage

LanguageInfo getLanguage()

Returns the language that is associated with the source resource. Never null.

Returns:

the language that is associated with the source resource. Never null.

getBestAssociatedLocation

ILocationInResource getBestAssociatedLocation(ITextRegion localRegion,
                                            org.eclipse.core.resources.IStorage associatedStorage)

Returns the best location that matches the given sourceRegion in the targetResource. 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 sourceRegion does not yield a location in targetResource, returns null.

Parameters:

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

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

Returns:

the best associated location or null if none.

getAllAssociatedLocations

Iterable<ILocationInResource> getAllAssociatedLocations(ITextRegion localRegion,
                                                      org.eclipse.core.resources.IStorage associatedStorage)

Returns all individual locations that match the given sourceRegion for the expected targetResource.

Parameters:

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

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

Returns:

all associated locations. Never null.

getAllAssociatedLocations

Iterable<ILocationInResource> getAllAssociatedLocations(org.eclipse.core.resources.IStorage associatedStorage)

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

Parameters:

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

Returns:

all locations. Never null.