UnrealEngineUWP/Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundFrontendGraphLinter.h

// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include "Containers/Set.h"
#include "Misc/Guid.h"
#include "Templates/Function.h"

namespace Metasound
{
	namespace Frontend
	{
		// Forward declare.
		class IInputController;
		class IOutputController;
		class INodeController;

		class METASOUNDFRONTEND_API FGraphLinter
		{
		public:
			using FDepthFirstVisitFunction = TFunctionRef<TSet<FGuid> (const INodeController&)>;

			/** Returns true if connecting thing input and output controllers will cause
			 * a loop in the graph. Returns false otherwise. 
			 */
			static bool DoesConnectionCauseLoop(const IInputController& InInputController, const IOutputController& InOutputController);

			/** Returns true if the FromNode can reach the ToNode by traversing the graph 
			 * in the forward direction. */
			static bool IsReachableDownstream(const INodeController& InFromNode, const INodeController& InToNode);

			/** Returns true if the FromNode can reach the ToNode by traversing the graph backwards
			 * (aka by traversing the transpose graph).
			 */
			static bool IsReachableUpstream(const INodeController& InFromNode, const INodeController& InToNode);

			/** Visits nodes using depth first traversals. */
			static void DepthFirstTraversal(const INodeController& Node, FDepthFirstVisitFunction Visit);
		};
	}
}