plugins/org.eclipse.qvtd.compiler/src/org/eclipse/qvtd/compiler/internal/qvtp2qvts/Node.java - mmt/org.eclipse.qvtd - Git at Google

 /*******************************************************************************
  * Copyright (c) 2015, 2016 Willink Transformations and others.
  * All rights reserved.   This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *   E.D.Willink - Initial API and implementation
  *******************************************************************************/
 package org.eclipse.qvtd.compiler.internal.qvtp2qvts;

 import java.util.List;
 import java.util.Set;

 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.Nullable;
 import org.eclipse.ocl.pivot.CompleteClass;
 import org.eclipse.ocl.pivot.Property;
 import org.eclipse.ocl.pivot.TypedElement;
 import org.eclipse.ocl.pivot.utilities.Nameable;
 import org.eclipse.qvtd.pivot.qvtimperative.utilities.GraphStringBuilder;

 /**
  * Node provides the analysis and status of a node in the pattern match or construction of a Mapping
  * or Composite Region.
  */
 public interface Node extends ConnectionEnd, GraphStringBuilder.GraphNode, Nameable, Visitable
 {
 	void addIncomingConnection(@NonNull NodeConnection connection);
 	void addIncomingEdge(@NonNull Edge edge);
 	void addOutgoingConnection(@NonNull NodeConnection connection);
 	void addOutgoingEdge(@NonNull Edge edge);
 	void addTypedElement(@NonNull TypedElement typedElement);
 	void destroy();

 	/**
 	 * Accumulate this node and all passed binding sources in the call-tree ancestry of this node.
 	 * On completion there is exactly one entry per region from each possible call path.
 	 */
 	void getAllAncestors(@NonNull Set<@NonNull Node> ancestors);
 	@NonNull Iterable<@NonNull Edge> getArgumentEdges();
 	@Nullable Edge getAssignmentEdge(@NonNull Property source2targetProperty);
 	@NonNull Iterable<@NonNull NavigationEdge> getAssignmentEdges();
 	@NonNull Iterable<@NonNull NavigationEdge> getCastEdges();
 	@NonNull ClassDatumAnalysis getClassDatumAnalysis();
 	@NonNull CompleteClass getCompleteClass();
 	@NonNull Iterable<@NonNull Edge> getComputationEdges();
 	@Nullable NodeConnection getIncomingConnection();
 	@NonNull List<@NonNull Edge> getIncomingEdges();
 	@Nullable NodeConnection getIncomingPassedConnection();
 	@Nullable NodeConnection getIncomingUsedConnection();
 	@NonNull String getLabel();
 	@Override
 	@NonNull String getName();
 	@Nullable NavigationEdge getNavigationEdge(@NonNull Property source2targetProperty);
 	@NonNull Iterable<@NonNull NavigationEdge> getNavigationEdges();
 	@Nullable Node getNavigationTarget(@NonNull Property source2targetProperty);
 	@NonNull Iterable<@NonNull Node> getNavigationTargets();
 	@NonNull NodeRole getNodeRole();
 	@NonNull List<@NonNull NodeConnection> getOutgoingConnections();
 	@NonNull List<@NonNull Edge> getOutgoingEdges();
 	//	@Nullable InterRegionEdge getPassedBindingEdge();
 	@NonNull Iterable<@NonNull NodeConnection> getOutgoingPassedConnections();
 	@NonNull Iterable<@NonNull NodeConnection> getOutgoingUsedBindingEdges();

 	/**
 	 * Get all sources that pass a value to this target.
 	 */
 	@NonNull Iterable<@NonNull Node> getPassedBindingSources();

 	/**
 	 * Get all targets that are passed a value from this source.
 	 */
 	@NonNull Iterable<@NonNull Node> getPassedBindingTargets();
 	@Nullable Edge getPredicateEdge(@NonNull Property source2targetProperty);
 	@NonNull Iterable<@NonNull NavigationEdge> getPredicateEdges();
 	@NonNull Iterable<@NonNull Edge> getRecursionEdges();

 	/**
 	 * Get all 'targets' that pass a value to this target recursively.
 	 */
 	@NonNull Iterable<@NonNull Node> getRecursionSources();

 	/**
 	 * Get all 'sources' that pass a value to this target recursively.
 	 */
 	@NonNull Iterable<@NonNull Node> getRecursionTargets();
 	@NonNull Iterable<@NonNull ? extends Edge> getResultEdges();
 	@NonNull SchedulerConstants getSchedulerConstants();
 	@NonNull Iterable<@NonNull TypedElement> getTypedElements();
 	@NonNull Iterable<@NonNull Node> getUsedBindingSources();

 	/**
 	 * Return true if this node is a Class object.
 	 */
 	boolean isClass();

 	boolean isComposed();

 	/**
 	 * Return true if this node is a constant that can be computed at compile time.
 	 *
 	 * isConstant() is exclusive to isLoaded()/isSpeculation()/isSpeculated()/isPredicated()/isRealized()
 	 */
 	boolean isConstant();

 	/**
 	 * Return true if this node is a DataType value.
 	 */
 	boolean isDataType();

 	/**
 	 * Return true if this node is an OCL expression.
 	 */
 	boolean isExpression();

 	/**
 	 * Return true if this node is a guard variable or composing head.
 	 */
 	boolean isGuard();

 	/**
 	 * Return true if this node is part of a head group from which many other nodes are navigable.
 	 */
 	boolean isHead();

 	/**
 	 * Return true if this node is an input port of a nested region.
 	 */
 	//	boolean isInput();

 	/**
 	 * Return true if this node's dependencies can be resolved within the containing region.
 	 * This occurs for 1:N navigations such as an iteration result that computes multiple
 	 * results dependent on multiple internally navigable inputs. No need for extra inputs to
 	 * be passed; just a need for the navigable inputs to exist.
 	 */
 	boolean isInternal();

 	/**
 	 * Return true if this node is a LoopExp iterator.
 	 */
 	boolean isIterator();

 	/**
 	 * Return true if this node has a known value, because it is inherently constant, or
 	 * is available once sufficient input models have been loaded.
 	 */
 	boolean isKnown();

 	/**
 	 * Return true if this node is part of the checkable input domain and so may be loaded at will to satisfy
 	 * the requirements of mapping execution.
 	 *
 	 * isLoaded() is exclusive to isConstant()/isPredicated()/isSpeculation()/isSpeculated()/isRealized()
 	 */
 	boolean isLoaded();

 	/**
 	 * Return true if this node is part of the to-one navigation path that is matched as part of a mapping's predicate.
 	 *
 	 * Regions with conflicting isMatchable() nodes cannot be merged.
 	 *
 	 * ?? isConstant() || isLoaded() || isPredicated()
 	 */
 	boolean isMatchable();

 	/**
 	 * Return true if this node is part of the to-one navigation path that is navigated to determine the navigation heads.
 	 */
 	boolean isNavigable();

 	/**
 	 * Return true if this node is a null value.
 	 */
 	boolean isNull();

 	boolean isOperation();

 	/**
 	 * Return true if this node is an output port of a nested region.
 	 */
 	//	boolean isOutput();

 	/**
 	 * Return true if this node is a pattern variable (class/datatype/null/true).
 	 */
 	boolean isPattern();

 	/**
 	 * Return true if the value of this node is part of the navigation path that must be validated
 	 * by predicate matching prior to execution of a mapping.
 	 *
 	 * isPredicated() is exclusive to isConstant()/isLoaded()/isSpeculation()/isSpeculated()/isRealized()
 	 */
 	boolean isPredicated();

 	/**
 	 * Return true if the value of this node is determined by execution of a mapping.
 	 *
 	 * isRealized() is exclusive to isConstant()/isLoaded()/isSpeculation()/isSpeculated()/isPredicated()
 	 */
 	boolean isRealized();

 	/**
 	 * Return true if this node is a speculated middle trace element that may havew benn created in anticipation
 	 * of other dependencies.
 	 *
 	 * isSpeculated() is exclusive to isConstant()/isLoaded()/isSpeculation()/isPredicated()/isRealized()
 	 */
 	boolean isSpeculated();

 	/**
 	 * Return true if this node is a/the speculation of the realized middle trace element that is created in anticipation
 	 * of other dependencies.
 	 *
 	 * isSpeculation() is exclusive to isConstant()/isLoaded()/isPredicated()/isSpeculated()/isPredicated()/isRealized()
 	 */
 	boolean isSpeculation();

 	/**
 	 * Return true if this is a TrueNode that terminates a complex predicate expression.
 	 */
 	boolean isTrue();

 	void mergeRole(@NonNull NodeRole nodeRole);
 	boolean refineClassDatumAnalysis(@NonNull ClassDatumAnalysis newClassDatumAnalysis);
 	void removeIncomingConnection(@NonNull NodeConnection connection);
 	void removeIncomingEdge(@NonNull Edge edge);
 	void removeOutgoingConnection(@NonNull NodeConnection connection);
 	void removeOutgoingEdge(@NonNull Edge edge);

 	/**
 	 * Redesignate a head node as not-a-head, typically following a multi-headed split.
 	 */
 	void resetHead();

 	/**
 	 * Redesignate a guard node as a head.
 	 */
 	void setHead();

 	void toGraph(@NonNull GraphStringBuilder s);
 	@Override
 	@NonNull String toString();
 }
	/*******************************************************************************
	* Copyright (c) 2015, 2016 Willink Transformations and others.
	* All rights reserved. This program and the accompanying materials
	* are made available under the terms of the Eclipse Public License v1.0
	* which accompanies this distribution, and is available at
	* http://www.eclipse.org/legal/epl-v10.html
	*
	* Contributors:
	* E.D.Willink - Initial API and implementation
	*******************************************************************************/
	package org.eclipse.qvtd.compiler.internal.qvtp2qvts;

	import java.util.List;
	import java.util.Set;

	import org.eclipse.jdt.annotation.NonNull;
	import org.eclipse.jdt.annotation.Nullable;
	import org.eclipse.ocl.pivot.CompleteClass;
	import org.eclipse.ocl.pivot.Property;
	import org.eclipse.ocl.pivot.TypedElement;
	import org.eclipse.ocl.pivot.utilities.Nameable;
	import org.eclipse.qvtd.pivot.qvtimperative.utilities.GraphStringBuilder;

	/**
	* Node provides the analysis and status of a node in the pattern match or construction of a Mapping
	* or Composite Region.
	*/
	public interface Node extends ConnectionEnd, GraphStringBuilder.GraphNode, Nameable, Visitable
	{
	void addIncomingConnection(@NonNull NodeConnection connection);
	void addIncomingEdge(@NonNull Edge edge);
	void addOutgoingConnection(@NonNull NodeConnection connection);
	void addOutgoingEdge(@NonNull Edge edge);
	void addTypedElement(@NonNull TypedElement typedElement);
	void destroy();

	/**
	* Accumulate this node and all passed binding sources in the call-tree ancestry of this node.
	* On completion there is exactly one entry per region from each possible call path.
	*/
	void getAllAncestors(@NonNull Set<@NonNull Node> ancestors);
	@NonNull Iterable<@NonNull Edge> getArgumentEdges();
	@Nullable Edge getAssignmentEdge(@NonNull Property source2targetProperty);
	@NonNull Iterable<@NonNull NavigationEdge> getAssignmentEdges();
	@NonNull Iterable<@NonNull NavigationEdge> getCastEdges();
	@NonNull ClassDatumAnalysis getClassDatumAnalysis();
	@NonNull CompleteClass getCompleteClass();
	@NonNull Iterable<@NonNull Edge> getComputationEdges();
	@Nullable NodeConnection getIncomingConnection();
	@NonNull List<@NonNull Edge> getIncomingEdges();
	@Nullable NodeConnection getIncomingPassedConnection();
	@Nullable NodeConnection getIncomingUsedConnection();
	@NonNull String getLabel();
	@Override
	@NonNull String getName();
	@Nullable NavigationEdge getNavigationEdge(@NonNull Property source2targetProperty);
	@NonNull Iterable<@NonNull NavigationEdge> getNavigationEdges();
	@Nullable Node getNavigationTarget(@NonNull Property source2targetProperty);
	@NonNull Iterable<@NonNull Node> getNavigationTargets();
	@NonNull NodeRole getNodeRole();
	@NonNull List<@NonNull NodeConnection> getOutgoingConnections();
	@NonNull List<@NonNull Edge> getOutgoingEdges();
	// @Nullable InterRegionEdge getPassedBindingEdge();
	@NonNull Iterable<@NonNull NodeConnection> getOutgoingPassedConnections();
	@NonNull Iterable<@NonNull NodeConnection> getOutgoingUsedBindingEdges();

	/**
	* Get all sources that pass a value to this target.
	*/
	@NonNull Iterable<@NonNull Node> getPassedBindingSources();

	/**
	* Get all targets that are passed a value from this source.
	*/
	@NonNull Iterable<@NonNull Node> getPassedBindingTargets();
	@Nullable Edge getPredicateEdge(@NonNull Property source2targetProperty);
	@NonNull Iterable<@NonNull NavigationEdge> getPredicateEdges();
	@NonNull Iterable<@NonNull Edge> getRecursionEdges();

	/**
	* Get all 'targets' that pass a value to this target recursively.
	*/
	@NonNull Iterable<@NonNull Node> getRecursionSources();

	/**
	* Get all 'sources' that pass a value to this target recursively.
	*/
	@NonNull Iterable<@NonNull Node> getRecursionTargets();
	@NonNull Iterable<@NonNull ? extends Edge> getResultEdges();
	@NonNull SchedulerConstants getSchedulerConstants();
	@NonNull Iterable<@NonNull TypedElement> getTypedElements();
	@NonNull Iterable<@NonNull Node> getUsedBindingSources();

	/**
	* Return true if this node is a Class object.
	*/
	boolean isClass();

	boolean isComposed();

	/**
	* Return true if this node is a constant that can be computed at compile time.
	*
	* isConstant() is exclusive to isLoaded()/isSpeculation()/isSpeculated()/isPredicated()/isRealized()
	*/
	boolean isConstant();

	/**
	* Return true if this node is a DataType value.
	*/
	boolean isDataType();

	/**
	* Return true if this node is an OCL expression.
	*/
	boolean isExpression();

	/**
	* Return true if this node is a guard variable or composing head.
	*/
	boolean isGuard();

	/**
	* Return true if this node is part of a head group from which many other nodes are navigable.
	*/
	boolean isHead();

	/**
	* Return true if this node is an input port of a nested region.
	*/
	// boolean isInput();

	/**
	* Return true if this node's dependencies can be resolved within the containing region.
	* This occurs for 1:N navigations such as an iteration result that computes multiple
	* results dependent on multiple internally navigable inputs. No need for extra inputs to
	* be passed; just a need for the navigable inputs to exist.
	*/
	boolean isInternal();

	/**
	* Return true if this node is a LoopExp iterator.
	*/
	boolean isIterator();

	/**
	* Return true if this node has a known value, because it is inherently constant, or
	* is available once sufficient input models have been loaded.
	*/
	boolean isKnown();

	/**
	* Return true if this node is part of the checkable input domain and so may be loaded at will to satisfy
	* the requirements of mapping execution.
	*
	* isLoaded() is exclusive to isConstant()/isPredicated()/isSpeculation()/isSpeculated()/isRealized()
	*/
	boolean isLoaded();

	/**
	* Return true if this node is part of the to-one navigation path that is matched as part of a mapping's predicate.
	*
	* Regions with conflicting isMatchable() nodes cannot be merged.
	*
	* ?? isConstant() \|\| isLoaded() \|\| isPredicated()
	*/
	boolean isMatchable();

	/**
	* Return true if this node is part of the to-one navigation path that is navigated to determine the navigation heads.
	*/
	boolean isNavigable();

	/**
	* Return true if this node is a null value.
	*/
	boolean isNull();

	boolean isOperation();

	/**
	* Return true if this node is an output port of a nested region.
	*/
	// boolean isOutput();

	/**
	* Return true if this node is a pattern variable (class/datatype/null/true).
	*/
	boolean isPattern();

	/**
	* Return true if the value of this node is part of the navigation path that must be validated
	* by predicate matching prior to execution of a mapping.
	*
	* isPredicated() is exclusive to isConstant()/isLoaded()/isSpeculation()/isSpeculated()/isRealized()
	*/
	boolean isPredicated();

	/**
	* Return true if the value of this node is determined by execution of a mapping.
	*
	* isRealized() is exclusive to isConstant()/isLoaded()/isSpeculation()/isSpeculated()/isPredicated()
	*/
	boolean isRealized();

	/**
	* Return true if this node is a speculated middle trace element that may havew benn created in anticipation
	* of other dependencies.
	*
	* isSpeculated() is exclusive to isConstant()/isLoaded()/isSpeculation()/isPredicated()/isRealized()
	*/
	boolean isSpeculated();

	/**
	* Return true if this node is a/the speculation of the realized middle trace element that is created in anticipation
	* of other dependencies.
	*
	* isSpeculation() is exclusive to isConstant()/isLoaded()/isPredicated()/isSpeculated()/isPredicated()/isRealized()
	*/
	boolean isSpeculation();

	/**
	* Return true if this is a TrueNode that terminates a complex predicate expression.
	*/
	boolean isTrue();

	void mergeRole(@NonNull NodeRole nodeRole);
	boolean refineClassDatumAnalysis(@NonNull ClassDatumAnalysis newClassDatumAnalysis);
	void removeIncomingConnection(@NonNull NodeConnection connection);
	void removeIncomingEdge(@NonNull Edge edge);
	void removeOutgoingConnection(@NonNull NodeConnection connection);
	void removeOutgoingEdge(@NonNull Edge edge);

	/**
	* Redesignate a head node as not-a-head, typically following a multi-headed split.
	*/
	void resetHead();

	/**
	* Redesignate a guard node as a head.
	*/
	void setHead();

	void toGraph(@NonNull GraphStringBuilder s);
	@Override
	@NonNull String toString();
	}