Package org.variantsync.diffdetective.variation.tree

Class VariationTree<L extends Label>

java.lang.Object

org.variantsync.diffdetective.variation.tree.VariationTree<L>

Type Parameters:

L - The type of label stored in this tree.

All Implemented Interfaces:

Source

public class VariationTree<L extends Label>
extends Object
implements Source

Representation of a concrete variation tree with source information.

Author:

Benjamin Moosherr

See Also:

• VariationTreeNode

Field Summary

Fields

Modifier and Type	Field	Description
private final VariationTreeNode<L>	root
private Source	source

Fields inherited from interface org.variantsync.diffdetective.util.Source

Unknown

Constructor Summary

Constructors

Constructor	Description
VariationTree(VariationTreeNode<L> root)	Creates a VariationTree with the given root and an unknown source.
VariationTree(VariationTreeNode<L> root, Source source)	Creates a VariationTree with the given root and source.

Method Summary

Modifier and Type	Method	Description
boolean	anyMatch(Predicate<VariationTreeNode<L>> condition)	Checks whether any node in this tree satisfies the given condition.
void	assertConsistency()	Checks whether this VariationTree is consistent.
int	computeSize()	Returns the number of nodes in this Variation Tree.
boolean	contains(VariationTreeNode<L> node)	Returns true iff this tree contains the given node.
VariationTree<L>	deepCopy()
VariationTree<L>	deepCopy(Map<VariationTreeNode<L>,VariationTreeNode<L>> oldToNew)	Creates a deep copy of this variation tree.
VariationTree<L>	forAllPostorder(Consumer<VariationTreeNode<L>> action)	Invokes the given callback for each node in this Variation Tree in post-order.
VariationTree<L>	forAllPreorder(Consumer<VariationTreeNode<L>> action)	Invokes the given callback for each node in this Variation Tree in pre-order.
static VariationTree<DiffLinesLabel>	fromFile(BufferedReader input, Source source, VariationDiffParseOptions parseOptions)	Parses a VariationTree from source code with C preprocessor annotations.
static VariationTree<DiffLinesLabel>	fromFile(Path path)	Same as fromFile(Path, VariationDiffParseOptions) but with VariationDiffParseOptions.Default parse options.
static VariationTree<DiffLinesLabel>	fromFile(Path path, VariationDiffParseOptions parseOptions)	Same as fromFile(BufferedReader, Source, VariationDiffParseOptions) but registers path as source.
static <L extends Label> VariationTree<L>	fromProjection(Projection<L> projection, Source source)
static VariationTree<DiffLinesLabel>	fromText(String input, Source source, VariationDiffParseOptions parseOptions)	Parses a VariationTree from source code with C preprocessor annotations.
static <T extends VariationNode<T, L>, L extends Label> VariationTree<L>	fromVariationNode(VariationNode<T,L> node, Source source)
VariationTreeNode<L>	getRoot()
Source	getSource()	Returns the source of this VariationTree (i.e., the data this VariationTree was created from).
String	getSourceExplanation()	Returns a short, one line explanation or identifier of this source.
List<Source>	getSources()	Returns a list of sources that influenced this source.
void	setSource(Source source)	Sets the source of this VariationTree.
VariationDiff<L>	toCompletelyUnchangedVariationDiff()
String	toString()
VariationDiff<L>	toVariationDiff(Function<VariationTreeNode<L>,DiffNode<L>> nodeConverter)
String	unparse()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.variantsync.diffdetective.util.Source

fullExplanation, functionExplanation, getRootSource, getSourceArguments, shallowExplanation

Field Details

root

private final VariationTreeNode<L extends Label> root

source

private Source source

Constructor Details

VariationTree

public VariationTree(VariationTreeNode<L> root)

Creates a VariationTree with the given root and an unknown source.

VariationTree

public VariationTree(VariationTreeNode<L> root,
 Source source)

Creates a VariationTree with the given root and source.

Method Details

fromFile

public static VariationTree<DiffLinesLabel> fromFile(Path path)
                                              throws IOException,
DiffParseException

Same as fromFile(Path, VariationDiffParseOptions) but with VariationDiffParseOptions.Default parse options.

Throws:

IOException

DiffParseException

fromFile

public static VariationTree<DiffLinesLabel> fromFile(Path path,
 VariationDiffParseOptions parseOptions)
                                              throws IOException,
DiffParseException

Same as fromFile(BufferedReader, Source, VariationDiffParseOptions) but registers path as source.

Throws:

IOException

DiffParseException

fromFile

public static VariationTree<DiffLinesLabel> fromFile(BufferedReader input,
 Source source,
 VariationDiffParseOptions parseOptions)
                                              throws IOException,
DiffParseException

Parses a VariationTree from source code with C preprocessor annotations.

Parameters:

input - the source code to be parsed

source - from where the variation tree was obtained

parseOptions - PatchDiffParseOptions for the parsing process.

Returns:

a new VariationTree representing input

Throws:

IOException - if input throws IOException

DiffParseException - if some preprocessor annotations can't be parsed

fromText

public static VariationTree<DiffLinesLabel> fromText(String input,
 Source source,
 VariationDiffParseOptions parseOptions)
                                              throws DiffParseException

Parses a VariationTree from source code with C preprocessor annotations.

Parameters:

input - the source code to be parsed

source - from where the variation tree was obtained

parseOptions - PatchDiffParseOptions for the parsing process.

Returns:

a new VariationTree representing input

Throws:

DiffParseException - if some preprocessor annotations can't be parsed

fromProjection

public static <L extends Label> VariationTree<L> fromProjection(Projection<L> projection,
 Source source)

fromVariationNode

public static <T extends VariationNode<T,
L>,
L extends Label>
VariationTree<L> fromVariationNode(VariationNode<T,L> node,
 Source source)

toVariationDiff

public VariationDiff<L> toVariationDiff(Function<VariationTreeNode<L>,DiffNode<L>> nodeConverter)

toCompletelyUnchangedVariationDiff

public VariationDiff<L> toCompletelyUnchangedVariationDiff()

forAllPreorder

public VariationTree<L> forAllPreorder(Consumer<VariationTreeNode<L>> action)

Invokes the given callback for each node in this Variation Tree in pre-order.

Parameters:

action - callback

Returns:

this

forAllPostorder

public VariationTree<L> forAllPostorder(Consumer<VariationTreeNode<L>> action)

Invokes the given callback for each node in this Variation Tree in post-order.

Parameters:

action - callback

Returns:

this

anyMatch

public boolean anyMatch(Predicate<VariationTreeNode<L>> condition)

Checks whether any node in this tree satisfies the given condition. The condition might not be invoked on every node in case a node is found.

Parameters:

condition - A condition to check on each node.

Returns:

True iff the given condition returns true for at least one node in this tree.

contains

public boolean contains(VariationTreeNode<L> node)

Returns true iff this tree contains the given node. Containment check is done on referential and not on textual equality (i.e., nodes are compared using ==).

Parameters:

node - The node to check for containment.

computeSize

public int computeSize()

Returns the number of nodes in this Variation Tree.

deepCopy

public VariationTree<L> deepCopy()

deepCopy

public VariationTree<L> deepCopy(Map<VariationTreeNode<L>,VariationTreeNode<L>> oldToNew)

Creates a deep copy of this variation tree.

The map oldToNew should be empty as it will be filled by this method. After the method call, the map keys will contain all nodes in this tree. The corresponding values will be the nodes in the returned tree, where each pair (k, v) denotes that v was cloned from k.

Parameters:

oldToNew - A map that memorizes the translation of individual nodes.

Returns:

A deep copy of this tree.

unparse

public String unparse()

assertConsistency

public void assertConsistency()

Checks whether this VariationTree is consistent. Throws an error if this VariationTree is inconsistent (e.g., if there are multiple NodeType.ELSE nodes). Has no side-effects otherwise.

See Also:

• VariationNode.assertConsistency()

getRoot

public VariationTreeNode<L> getRoot()

setSource

public void setSource(Source source)

Sets the source of this VariationTree.

See Also:

• Source

getSource

public Source getSource()

Returns the source of this VariationTree (i.e., the data this VariationTree was created from).

See Also:

• Source

getSources

public List<Source> getSources()

Description copied from interface: Source

Returns a list of sources that influenced this source. Noteworthy processing steps and incorporation of multiple sources are implemented as a tree of sources. This functions returns the children of this source.

By default, the first child source is treated specially in Source.getRootSource().

Specified by:

getSources in interface Source

Returns:

an empty list by default

getSourceExplanation

public String getSourceExplanation()

Description copied from interface: Source

Returns a short, one line explanation or identifier of this source. The result is used by Source.shallowExplanation() and is formatted together with Source.getSourceArguments() like "sourceExplanation(argument1, argument2)".

Specified by:

getSourceExplanation in interface Source

toString

public String toString()

Overrides:

toString in class Object