Hastlayer-SDK

using Hast.Common.Configuration;
using Hast.Transformer.Models;
using Hast.Transformer.Vhdl.ArchitectureComponents;
using Hast.Transformer.Vhdl.Models;
using Hast.Transformer.Vhdl.SubTransformers.ExpressionTransformers;
using Hast.VhdlBuilder.Extensions;
using Hast.VhdlBuilder.Representation;
using Hast.VhdlBuilder.Representation.Declaration;
using Hast.VhdlBuilder.Representation.Expression;
using ICSharpCode.Decompiler.CSharp.Syntax;
using Lombiq.HelpfulLibraries.Common.Utilities;
using System;
using System.Collections.Generic;
using System.Linq;

namespace Hast.Transformer.Vhdl.SubTransformers;

public class StateMachineInvocationBuilder : IStateMachineInvocationBuilder
{
    private readonly ITypeConversionTransformer _typeConversionTransformer;
    private readonly IDeclarableTypeCreator _declarableTypeCreator;

    public StateMachineInvocationBuilder(
        ITypeConversionTransformer typeConversionTransformer,
        IDeclarableTypeCreator declarableTypeCreator)
    {
        _typeConversionTransformer = typeConversionTransformer;
        _declarableTypeCreator = declarableTypeCreator;
    }

    public IBuildInvocationResult BuildInvocation(
        MethodDeclaration targetDeclaration,
        IEnumerable<TransformedInvocationParameter> transformedParameters,
        int instanceCount,
        SubTransformerContext context)
    {
        var stateMachine = context.Scope.StateMachine;
        var currentBlock = context.Scope.CurrentBlock;
        var targetMethodName = targetDeclaration.GetFullName();

        void AddInvocationStartComment() =>
            currentBlock
            .Add(new LineComment("Starting state machine invocation for the following method: " + targetMethodName));

        var maxDegreeOfParallelism = context.TransformationContext.GetTransformerConfiguration()
            .GetMaxInvocationInstanceCountConfigurationForMember(targetDeclaration).MaxDegreeOfParallelism;

        if (instanceCount > maxDegreeOfParallelism)
        {
            throw new InvalidOperationException(
                StringHelper.Concatenate(
                    $"This parallelized call from {context.Scope.Method} to {targetMethodName} would do ",
                    $"{instanceCount} calls in parallel but the maximal degree of parallelism for this member ",
                    $"was set up as {maxDegreeOfParallelism}."));
        }

        if (!stateMachine.OtherMemberMaxInvocationInstanceCounts.TryGetValue(targetDeclaration, out var previousMaxInvocationInstanceCount) ||
            previousMaxInvocationInstanceCount < instanceCount)
        {
            stateMachine.OtherMemberMaxInvocationInstanceCounts[targetDeclaration] = instanceCount;
        }

        if (instanceCount == 1)
        {
            var buildInvocationBlockResult = BuildInvocationBlock(
                targetDeclaration,
                targetMethodName,
                transformedParameters,
                context,
                0);

            AddInvocationStartComment();
            currentBlock.Add(buildInvocationBlockResult.InvocationBlock);

            return buildInvocationBlockResult;
        }

        var outParameterBackAssignments = new List<Assignment>();
        var invocationIndexVariableName = stateMachine.CreateInvocationIndexVariableName(targetMethodName);
        var invocationIndexVariableType = new RangedDataType(KnownDataTypes.UnrangedInt)
        {
            RangeMax = instanceCount - 1,
        };
        var invocationIndexVariableReference = invocationIndexVariableName.ToVhdlVariableReference();
        stateMachine.LocalVariables.AddIfNew(new Variable
        {
            DataType = invocationIndexVariableType,
            InitialValue = KnownDataTypes.UnrangedInt.DefaultValue,
            Name = invocationIndexVariableName,
        });

        var proxyCase = new Case
        {
            Expression = invocationIndexVariableReference,
        };

        for (int i = 0; i < instanceCount; i++)
        {
            var buildInvocationBlockResult = BuildInvocationBlock(
                targetDeclaration,
                targetMethodName,
                transformedParameters,
                context,
                i);

            outParameterBackAssignments.AddRange(buildInvocationBlockResult.OutParameterBackAssignments);

            proxyCase.Whens.Add(new CaseWhen(
                expression: i.ToVhdlValue(invocationIndexVariableType),
                body: new List<IVhdlElement>
                {
                    {
                        buildInvocationBlockResult.InvocationBlock
                    },
                }));
        }

        AddInvocationStartComment();
        currentBlock.Add(proxyCase);
        currentBlock.Add(new Assignment
        {
            AssignTo = invocationIndexVariableReference,
            Expression = new Binary
            {
                Left = invocationIndexVariableReference,
                Operator = BinaryOperator.Add,
                Right = 1.ToVhdlValue(invocationIndexVariableType),
            },
        });

        return new BuildInvocationResult { OutParameterBackAssignments = outParameterBackAssignments };
    }

    public IEnumerable<IVhdlElement> BuildMultiInvocationWait(
        MethodDeclaration targetDeclaration,
        int instanceCount,
        bool waitForAll,
        SubTransformerContext context) =>
        BuildInvocationWait(targetDeclaration, instanceCount, -1, waitForAll, context);

    public IVhdlElement BuildSingleInvocationWait(
        MethodDeclaration targetDeclaration,
        int targetIndex,
        SubTransformerContext context) =>
        BuildInvocationWait(targetDeclaration, 1, targetIndex, waitForAll: true, context).Single();

    /// <summary>
    /// Be aware that the method can change the current block.
    /// </summary>
    private BuildInvocationBlockResult BuildInvocationBlock(
        MethodDeclaration targetDeclaration,
        string targetMethodName,
        IEnumerable<TransformedInvocationParameter> transformedParameters,
        SubTransformerContext context,
        int index)
    {
        var scope = context.Scope;
        var stateMachine = scope.StateMachine;

        var indexedStateMachineName = ArchitectureComponentNameHelper.CreateIndexedComponentName(targetMethodName, index);

        // Due to the time needed for the invocation proxy to register that the invoked state machine is not started any
        // more the same state machine can be restarted in the second state counted from the await state at earliest.
        // Thus adding a new state and also a wait state if necessary.
        var finishedInvokedComponentsForStates = scope.FinishedInvokedStateMachinesForStates;

        // Would the invocation be restarted in the same state? We need to add a state just to wait, then a new state
        // for the new invocation start.
        if (finishedInvokedComponentsForStates
            .TryGetValue(scope.CurrentBlock.StateMachineStateIndex, out var finishedComponents) &&
            finishedComponents.Contains(indexedStateMachineName))
        {
            scope.CurrentBlock.Add(new LineComment(
                "The last invocation for the target state machine just finished, so need to start the next one in a later state."));

            stateMachine.AddNewStateAndChangeCurrentBlock(
                scope,
                new InlineBlock(new LineComment(
                    "This state was just added to leave time for the invocation proxy to register that the previous invocation finished.")));

            stateMachine.AddNewStateAndChangeCurrentBlock(scope);
        }

        // Are we one state later from the await for some other reason already? Still another state needs to be added
        // got leave time for the invocation proxy.
        else if (finishedInvokedComponentsForStates
            .TryGetValue(scope.CurrentBlock.StateMachineStateIndex - 1, out finishedComponents) &&
            finishedComponents.Contains(indexedStateMachineName))
        {
            scope.CurrentBlock.Add(new LineComment(
                "The last invocation for the target state machine finished in the previous state, so need to " +
                "start the next one in the next state."));
            stateMachine.AddNewStateAndChangeCurrentBlock(scope);
        }

        var invocationBlock = new InlineBlock();
        var outParameterBackAssignments = new List<Assignment>();

        using var methodParametersEnumerator = targetDeclaration
            .GetNonSimpleMemoryParameters()
            .GetEnumerator();
        methodParametersEnumerator.MoveNext();

        foreach (var parameter in transformedParameters)
        {
            // Managing signals for parameter passing.
            var targetParameter = methodParametersEnumerator.Current;
            var parameterSignalType = _declarableTypeCreator
                .CreateDeclarableType(targetParameter, targetParameter.Type, context.TransformationContext);

            invocationBlock.Add(CreateParameterAssignment(
                ParameterFlowDirection.Out,
                parameter,
                parameterSignalType,
                targetMethodName,
                targetParameter,
                context,
                index));
            if (targetParameter.IsOutFlowing())
            {
                var assignment = CreateParameterAssignment(
                    ParameterFlowDirection.In,
                    parameter,
                    parameterSignalType,
                    targetMethodName,
                    targetParameter,
                    context,
                    index);
                if (assignment != null) outParameterBackAssignments.Add(assignment);
            }

            methodParametersEnumerator.MoveNext();
        }

        invocationBlock.Add(InvocationHelper.CreateInvocationStart(stateMachine, targetMethodName, index));

        return new BuildInvocationBlockResult
        {
            InvocationBlock = invocationBlock,
            OutParameterBackAssignments = outParameterBackAssignments,
        };
    }

    private Assignment CreateParameterAssignment(
        ParameterFlowDirection flowDirection,
        TransformedInvocationParameter parameter,
        DataType parameterSignalType,
        string targetMethodName,
        ParameterDeclaration targetParameter,
        SubTransformerContext context,
        int index)
    {
        var parameterReference = parameter.Reference;
        var stateMachine = context.Scope.StateMachine;

        var parameterSignalName = stateMachine
            .CreatePrefixedSegmentedObjectName(
                ArchitectureComponentNameHelper
                    .CreateParameterSignalName(targetMethodName, targetParameter.Name, flowDirection)
                    .TrimExtendedVhdlIdDelimiters(),
                index.ToTechnicalString());
        var parameterSignalReference = parameterSignalName.ToVhdlSignalReference();

        var signals = flowDirection == ParameterFlowDirection.Out ?
            stateMachine.InternallyDrivenSignals :
            stateMachine.ExternallyDrivenSignals;
        signals.AddIfNew(new ParameterSignal(
            targetMethodName,
            targetParameter.Name,
            index,
            isOwn: false)
        {
            DataType = parameterSignalType,
            Name = parameterSignalName,
        });

        // Assign local variables to/from the intermediary parameter signal. If the parameter is of direction In then
        // the parameter element should contain an IDataObject.
        var assignTo = flowDirection == ParameterFlowDirection.Out ? parameterSignalReference : (IDataObject)parameterReference;
        var assignmentExpression = flowDirection == ParameterFlowDirection.Out ? parameterReference : parameterSignalReference;

        // We need to do type conversion if there is a type mismatch. This can also occur with Values (i.e. transformed
        // PrimitiveExpressions) since in .NET there can be an implicit downcast not visible in the AST.
        if (parameter.DataType != parameterSignalType)
        {
            IAssignmentTypeConversionResult conversionResult;
            conversionResult = flowDirection == ParameterFlowDirection.Out
                ? _typeConversionTransformer
                    .ImplementTypeConversionForAssignment(parameter.DataType, parameterSignalType, parameterReference, assignTo)
                : _typeConversionTransformer
                    .ImplementTypeConversionForAssignment(parameterSignalType, parameter.DataType, parameterSignalReference, assignTo);

            assignTo = conversionResult.ConvertedToDataObject;
            assignmentExpression = conversionResult.ConvertedFromExpression;
        }

        // In this case the parameter is e.g. a primitive value, no need to assign to it.
        if (flowDirection == ParameterFlowDirection.In && parameterReference is not IDataObject)
        {
            return null;
        }

        return new Assignment
        {
            AssignTo = assignTo,
            Expression = assignmentExpression,
        };
    }

    private IEnumerable<IVhdlElement> BuildInvocationWait(
        MethodDeclaration targetDeclaration,
        int instanceCount,
        int index,
        bool waitForAll,
        SubTransformerContext context)
    {
        var stateMachine = context.Scope.StateMachine;
        var currentBlock = context.Scope.CurrentBlock;
        var targetMethodName = targetDeclaration.GetFullName();

        var waitForInvocationFinishedIfElse = InvocationHelper
            .CreateWaitForInvocationFinished(stateMachine, targetMethodName, instanceCount, waitForAll);

        var waitForInvokedStateMachinesToFinishState = new InlineBlock(
            new LineComment(
                "Waiting for the state machine invocation of the following method to finish: " + targetMethodName),
            waitForInvocationFinishedIfElse);

        var waitForInvokedStateMachineToFinishStateIndex = stateMachine.AddState(waitForInvokedStateMachinesToFinishState);
        currentBlock.Add(stateMachine.CreateStateChange(waitForInvokedStateMachineToFinishStateIndex));

        if (instanceCount > 1)
        {
            waitForInvocationFinishedIfElse.True.Add(new Assignment
            {
                AssignTo = stateMachine
                    .CreateInvocationIndexVariableName(targetMethodName)
                    .ToVhdlVariableReference(),
                Expression = 0.ToVhdlValue(KnownDataTypes.UnrangedInt),
            });
        }

        currentBlock.ChangeBlockToDifferentState(waitForInvocationFinishedIfElse.True, waitForInvokedStateMachineToFinishStateIndex);

        var returnType = _declarableTypeCreator
            .CreateDeclarableType(targetDeclaration, targetDeclaration.ReturnType, context.TransformationContext);

        var returnVariableReferences = new List<IDataObject>();

        void BuildInvocationWaitBlock(int targetIndex)
        {
            if (returnType != KnownDataTypes.Void)
            {
                // Creating the return signal if it doesn't exist.
                var returnSignalReference = stateMachine.CreateReturnSignalReferenceForTargetComponent(targetMethodName, targetIndex);

                stateMachine.ExternallyDrivenSignals.AddIfNew(new Signal
                {
                    DataType = returnType,
                    Name = returnSignalReference.Name,
                });

                // The return signal's value needs to be copied over to a local variable. Otherwise if we'd re-use the
                // signal with multiple invocations the last invocation's value would be present in all references.
                var returnVariableReference = stateMachine
                    .CreateVariableWithNextUnusedIndexedName(NameSuffixes.Return, returnType)
                    .ToReference();

                currentBlock.Add(new Assignment
                {
                    AssignTo = returnVariableReference,
                    Expression = returnSignalReference,
                });

                // Using the reference of the state machine's return value in place of the original method call.
                returnVariableReferences.Add(returnVariableReference);
            }

            // Noting that this component was finished in this state.
            var finishedInvokedComponentsForStates = context.Scope.FinishedInvokedStateMachinesForStates;
            if (!finishedInvokedComponentsForStates
                .TryGetValue(currentBlock.StateMachineStateIndex, out var finishedComponents))
            {
                finishedComponents = finishedInvokedComponentsForStates[currentBlock.StateMachineStateIndex] =
                    new HashSet<string>();
            }

            finishedComponents.Add(ArchitectureComponentNameHelper.CreateIndexedComponentName(targetMethodName, targetIndex));
        }

        if (index == -1)
        {
            for (int i = 0; i < instanceCount; i++)
            {
                BuildInvocationWaitBlock(i);
            }
        }
        else
        {
            BuildInvocationWaitBlock(index);
        }

        if (returnType == KnownDataTypes.Void)
        {
            return Enumerable.Repeat<IVhdlElement>(Empty.Instance, instanceCount);
        }

        return returnVariableReferences;
    }

    private class BuildInvocationResult : IBuildInvocationResult
    {
        public IEnumerable<Assignment> OutParameterBackAssignments { get; set; }
    }

    private sealed class BuildInvocationBlockResult : BuildInvocationResult
    {
        public IVhdlElement InvocationBlock { get; set; }
    }
}