VVMFunction.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#if WITH_VERSE_VM || defined(__INTELLISENSE__)
 
#include "VVMClass.h"
#include "VVMFalse.h"
#include "VVMGlobalTrivialEmergentTypePtr.h"
#include "VVMScope.h"
#include "VVMVerse.h"
 
namespace Verse
{
enum class EValueStringFormat;
struct VProcedure;
struct VUniqueString;
 
struct VFunction : VHeapValue
{
    DECLARE_DERIVED_VCPPCLASSINFO(COREUOBJECT_API, VHeapValue);
    COREUOBJECT_API static TGlobalTrivialEmergentTypePtr<&StaticCppClassInfo> GlobalTrivialEmergentType;
 
    using Args = TArray<VValue, TInlineAllocator<8>>;
 
    TWriteBarrier<VProcedure> Procedure;
 
    TWriteBarrier<VValue> Self;
 
    TWriteBarrier<VScope> ParentScope;
 
    V_FORCEINLINE FOpResult Invoke(FRunningContext Context, VValue Argument, TWriteBarrier<VUniqueString>* NamedArg = nullptr)
    {
        return InvokeWithSelf(Context, Self.Get(), Argument, NamedArg);
    }
    V_FORCEINLINE FOpResult Invoke(FRunningContext Context, Args&& Arguments, TArray<TWriteBarrier<VUniqueString>>* NamedArgs = nullptr, Args* NamedArgVals = nullptr)
    {
        return InvokeWithSelf(Context, Self.Get(), MoveTemp(Arguments), NamedArgs, NamedArgVals);
    }
    COREUOBJECT_API FOpResult InvokeWithSelf(FRunningContext Context, VValue Self, VValue Argument, TWriteBarrier<VUniqueString>* NamedArg = nullptr);
    COREUOBJECT_API FOpResult InvokeWithSelf(FRunningContext Context, VValue Self, Args&& Arguments, TArray<TWriteBarrier<VUniqueString>>* NamedArgs = nullptr, Args* NamedArgVals = nullptr, bool bRequireConcreteEffectToken = true);
    COREUOBJECT_API static FOpResult Spawn(FRunningContext Context, VValue Callee, Args&& Arguments, TArray<TWriteBarrier<VUniqueString>>* NamedArgs = nullptr, Args* NamedArgVals = nullptr);
 
    static VFunction& New(FAllocationContext Context, VProcedure& Procedure, VValue Self, VScope* ParentScope = nullptr)
    {
        return *new (Context.AllocateFastCell(sizeof(VFunction))) VFunction(Context, &Procedure, Self, ParentScope);
    }
 
    static VFunction& NewUnbound(FAllocationContext Context, VProcedure& Procedure, VScope& InScope)
    {
        return *new (Context.AllocateFastCell(sizeof(VFunction))) VFunction(Context, &Procedure, VValue(), &InScope);
    }
 
    VFunction& Bind(FAllocationContext Context, VValue InSelf)
    {
        checkf(!HasSelf(), TEXT("Attempting to bind `Self` to a `VFunction` that already has it set; this is probably a mistake in the code generation."));
        checkf(ParentScope, TEXT("The function should already have had its scope set; this is probably a mistake in the code generation."));
        return *new (Context.AllocateFastCell(sizeof(VFunction))) VFunction(Context, Procedure.Get(), InSelf, ParentScope.Get());
    }
 
    VProcedure& GetProcedure() { return *Procedure.Get(); }
 
    COREUOBJECT_API bool HasSelf() const;
 
    COREUOBJECT_API void AppendToStringImpl(FAllocationContext Context, FUtf8StringBuilderBase& Builder, EValueStringFormat Format, TSet<const void*>& VisitedObjects, uint32 RecursionDepth);
 
    static void SerializeLayout(FAllocationContext Context, VFunction*& This, FStructuredArchiveVisitor& Visitor);
    void SerializeImpl(FAllocationContext Context, FStructuredArchiveVisitor& Visitor);
 
private:
    VFunction(FAllocationContext Context, VProcedure* InFunction, VValue InSelf, VScope* InParentScope)
        : VHeapValue(Context, &GlobalTrivialEmergentType.Get(Context))
        , Procedure(Context, InFunction)
        , Self(Context, InSelf)
        , ParentScope(Context, InParentScope)
    {
    }
};
} // namespace Verse
#endif // WITH_VERSE_VM