EM_Task/UnrealEd/Private/Cooker/CookRequests.cpp

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

#include "CookRequests.h"

#include "Algo/Find.h"
#include "CookPlatformManager.h"
#include "HAL/Event.h"
#include "Interfaces/ITargetPlatform.h"
#include "Misc/CoreMiscDefines.h"
#include "Misc/ScopeLock.h"
#include "PackageNameCache.h"
#include "Templates/UnrealTemplate.h"

namespace UE
{
namespace Cook
{

//////////////////////////////////////////////////////////////////////////
// FFilePlatformRequest

FFilePlatformRequest::FFilePlatformRequest(const FName& InFilename)
    : FFilePlatformRequest(InFilename, TArray<const ITargetPlatform*>(), FCompletionCallback())
{
}

FFilePlatformRequest::FFilePlatformRequest(const FName& InFilename, const ITargetPlatform* InPlatform, FCompletionCallback&& InCompletionCallback)
    : FFilePlatformRequest(InFilename, TArrayView<const ITargetPlatform* const>({InPlatform}), MoveTemp(InCompletionCallback))
{
}

FFilePlatformRequest::FFilePlatformRequest(const FName& InFilename, const TArrayView<const ITargetPlatform* const>& InPlatforms, FCompletionCallback&& InCompletionCallback)
    : FFilePlatformRequest(InFilename, TArray<const ITargetPlatform*>(InPlatforms.GetData(), InPlatforms.Num()), MoveTemp(InCompletionCallback))
{
}

FFilePlatformRequest::FFilePlatformRequest(const FName& InFilename, TArray<const ITargetPlatform*>&& InPlatforms, FCompletionCallback&& InCompletionCallback)
    : Platforms(MoveTemp(InPlatforms)), CompletionCallback(MoveTemp(InCompletionCallback))
{
    SetFilename(InFilename.ToString());
}

FFilePlatformRequest::FFilePlatformRequest(const FFilePlatformRequest& InFilePlatformRequest)
    : Filename(InFilePlatformRequest.Filename), Platforms(InFilePlatformRequest.Platforms)
{
    check(!InFilePlatformRequest.CompletionCallback);  // CompletionCallbacks can not be copied, so the caller's intent is not clear in this constructor if the input has one
}

FFilePlatformRequest::FFilePlatformRequest(FFilePlatformRequest&& InFilePlatformRequest)
    : Filename(MoveTemp(InFilePlatformRequest.Filename)), Platforms(MoveTemp(InFilePlatformRequest.Platforms)), CompletionCallback(MoveTemp(InFilePlatformRequest.CompletionCallback))
{
}

FFilePlatformRequest& FFilePlatformRequest::operator=(FFilePlatformRequest&& InFileRequest)
{
    Filename  = MoveTemp(InFileRequest.Filename);
    Platforms = MoveTemp(InFileRequest.Platforms);
    check(!CompletionCallback);  // We don't support holding multiple completion callbacks
    CompletionCallback = MoveTemp(InFileRequest.CompletionCallback);
    return *this;
}

void FFilePlatformRequest::SetFilename(FString InFilename)
{
    Filename = FPackageNameCache::GetStandardFileName(InFilename);
}

const FName& FFilePlatformRequest::GetFilename() const
{
    return Filename;
}

const TArray<const ITargetPlatform*>& FFilePlatformRequest::GetPlatforms() const
{
    return Platforms;
}

TArray<const ITargetPlatform*>& FFilePlatformRequest::GetPlatforms()
{
    return Platforms;
}

void FFilePlatformRequest::RemovePlatform(const ITargetPlatform* Platform)
{
    Platforms.Remove(Platform);
}

void FFilePlatformRequest::AddPlatform(const ITargetPlatform* Platform)
{
    check(Platform != nullptr);
    Platforms.Add(Platform);
}

bool FFilePlatformRequest::HasPlatform(const ITargetPlatform* Platform) const
{
    return Platforms.Find(Platform) != INDEX_NONE;
}

FCompletionCallback& FFilePlatformRequest::GetCompletionCallback()
{
    return CompletionCallback;
}

bool FFilePlatformRequest::IsValid() const
{
    return Filename != NAME_None;
}

void FFilePlatformRequest::Clear()
{
    Filename = TEXT("");
    Platforms.Empty();
}

bool FFilePlatformRequest::operator==(const FFilePlatformRequest& InFileRequest) const
{
    if (InFileRequest.Filename == Filename)
    {
        if (InFileRequest.Platforms == Platforms)
        {
            return true;
        }
    }
    return false;
}

FString FFilePlatformRequest::ToString() const
{
    FString Result = FString::Printf(TEXT("%s;"), *Filename.ToString());

    for (const ITargetPlatform* Platform: Platforms)
    {
        Result += FString::Printf(TEXT("%s,"), *Platform->PlatformName());
    }
    return Result;
}

void FFilePlatformRequest::RemapTargetPlatforms(const TMap<ITargetPlatform*, ITargetPlatform*>& Remap)
{
    RemapArrayElements(Platforms, Remap);
}

//////////////////////////////////////////////////////////////////////////
// FExternalRequests

int32 FExternalRequests::GetNumRequests() const
{
    return RequestCount;
}

bool FExternalRequests::HasRequests() const
{
    return RequestCount > 0;
}

void FExternalRequests::AddCallback(FSchedulerCallback&& Callback)
{
    FScopeLock ScopeLock(&RequestLock);

    Callbacks.Add(MoveTemp(Callback));
    ++RequestCount;
}

void FExternalRequests::EnqueueUnique(FFilePlatformRequest&& FileRequest, bool bForceFrontOfQueue)
{
    FScopeLock ScopeLock(&RequestLock);
    FName Filename                        = FileRequest.GetFilename();
    FFilePlatformRequest* ExistingRequest = RequestMap.Find(Filename);
    if (!ExistingRequest)
    {
        RequestMap.Add(Filename, MoveTemp(FileRequest));
        if (bForceFrontOfQueue)
        {
            Queue.AddFront(Filename);
        }
        else
        {
            Queue.Add(Filename);
        }

        ++RequestCount;
    }
    else
    {
        if (FileRequest.GetCompletionCallback())
        {
            check(!ExistingRequest->GetCompletionCallback());  // We don't support multiple callbacks
            ExistingRequest->GetCompletionCallback() = MoveTemp(FileRequest.GetCompletionCallback());
        }

        // add the requested platforms to the platform list
        for (const ITargetPlatform* Platform: FileRequest.GetPlatforms())
        {
            ExistingRequest->GetPlatforms().AddUnique(Platform);
        }

        if (bForceFrontOfQueue)
        {
            FName* ExistingName = Algo::Find(Queue, Filename);
            int32 Index         = Queue.ConvertPointerToIndex(ExistingName);
            check(Index != INDEX_NONE);
            if (Index != 0)
            {
                Queue[Index] = Queue[0];
                Queue[0]     = Filename;
            }
        }
    }
}

EExternalRequestType FExternalRequests::DequeueRequest(TArray<FSchedulerCallback>& OutCallbacks, FFilePlatformRequest& OutToBuild)
{
    FScopeLock ScopeLock(&RequestLock);

    if (ThreadUnsafeDequeueCallbacks(OutCallbacks))
    {
        return EExternalRequestType::Callback;
    }
    else if (Queue.Num())
    {
        FName Filename = Queue.PopFrontValue();
        OutToBuild     = RequestMap.FindAndRemoveChecked(Filename);
        --RequestCount;
        return EExternalRequestType::Cook;
    }
    else
    {
        return EExternalRequestType::None;
    }
}

bool FExternalRequests::DequeueCallbacks(TArray<FSchedulerCallback>& OutCallbacks)
{
    FScopeLock ScopeLock(&RequestLock);
    return ThreadUnsafeDequeueCallbacks(OutCallbacks);
}

bool FExternalRequests::ThreadUnsafeDequeueCallbacks(TArray<FSchedulerCallback>& OutCallbacks)
{
    if (Callbacks.Num() > 0)
    {
        OutCallbacks = MoveTemp(Callbacks);
        Callbacks.Empty();
        RequestCount -= OutCallbacks.Num();
        return true;
    }
    else
    {
        return false;
    }
}

void FExternalRequests::EmptyRequests()
{
    FScopeLock ScopeLock(&RequestLock);

    Queue.Empty();
    RequestMap.Empty();
    Callbacks.Empty();
    RequestCount = 0;
}

void FExternalRequests::DequeueAll(TArray<FSchedulerCallback>& OutCallbacks, TArray<FFilePlatformRequest>& OutCookRequests)
{
    FScopeLock ScopeLock(&RequestLock);

    OutCallbacks = MoveTemp(Callbacks);
    Callbacks.Empty();

    for (TPair<FName, FFilePlatformRequest>& Request: RequestMap)
    {
        OutCookRequests.Add(MoveTemp(Request.Value));
    }
    RequestMap.Empty();
    Queue.Empty();

    RequestCount = 0;
}

void FExternalRequests::OnRemoveSessionPlatform(const ITargetPlatform* TargetPlatform)
{
    FScopeLock ScopeLock(&RequestLock);

    // The caller should not be removing platforms if we have an active request referencing that platform, but in case they did, remove the platform
    // from all pending requests
    for (TPair<FName, FFilePlatformRequest>& kvpair: RequestMap)
    {
        FFilePlatformRequest& Request = kvpair.Value;
        Request.GetPlatforms().Remove(TargetPlatform);
        if (Request.GetPlatforms().Num() == 0)
        {
            UE_LOG(LogCook, Error, TEXT("RemovePlatform call has left an empty list of platforms requested in CookOnTheSide request."));
        }
    }
}

void FExternalRequests::RemapTargetPlatforms(const TMap<ITargetPlatform*, ITargetPlatform*>& Remap)
{
    for (TPair<FName, FFilePlatformRequest>& KVPair: RequestMap)
    {
        KVPair.Value.RemapTargetPlatforms(Remap);
    }
}

}  // namespace Cook
}  // namespace UE