DialogueSearchManager.h

Go to the documentation of this file.

// Copyright Csaba Molnar, Daniel Butum. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
#include "Widgets/Docking/SDockTab.h"
 
#include "DialogueSearchResult.h"
 
// The maximum amount of global Dialogue Search windows opened.
static constexpr int32 MAX_GLOBAL_DIALOGUE_SEARCH_RESULTS = 4;
 
class SFindInDialogues;
class FAssetRegistryModule;
 
class FWorkspaceItem;
class UDialogueGraphNode;
class UDialogueGraphNode_Edge;
class UEdGraphNode_Comment;
class IAssetRegistry;
struct FAssetData;
struct FDlgCondition;
struct FDlgEvent;
struct FDlgEdge;
struct FDlgTextArgument;
 
struct FDialogueSearchData
{
    TWeakObjectPtr<UDlgDialogue> Dialogue;
};
 
class FDialogueSearchManager
{
private:
    typedef FDialogueSearchManager Self;
 
public:
    static Self* Get();
 
    FDialogueSearchManager();
    ~FDialogueSearchManager();
 
    bool QueryDlgTextArgument(
        const FDialogueSearchFilter& SearchFilter,
        const FDlgTextArgument& InDlgTextArgument,
        const TSharedPtr<FDialogueSearchResult>& OutParentNode,
        int32 ArgumentIndex = INDEX_NONE
    );
 
    bool QueryDlgCondition(
        const FDialogueSearchFilter& SearchFilter,
        const FDlgCondition& InDlgCondition,
        const TSharedPtr<FDialogueSearchResult>& OutParentNode,
        int32 ConditionIndex = INDEX_NONE,
        FName ConditionMemberName = TEXT("Condition")
    );
 
    bool QueryDlgEvent(
        const FDialogueSearchFilter& SearchFilter,
        const FDlgEvent& InDlgEvent,
        const TSharedPtr<FDialogueSearchResult>& OutParentNode,
        int32 EventIndex = INDEX_NONE,
        FName EventMemberName = TEXT("Event")
    );
 
    bool QueryDlgEdge(
        const FDialogueSearchFilter& SearchFilter,
        const FDlgEdge& InDlgEdge,
        const TSharedPtr<FDialogueSearchResult>& OutParentNode
    );
 
    bool QueryGraphNode(
        const FDialogueSearchFilter& SearchFilter,
        const UDialogueGraphNode* InGraphNode,
        const TSharedPtr<FDialogueSearchResult>& OutParentNode
    );
 
    bool QueryEdgeNode(
        const FDialogueSearchFilter& SearchFilter,
        const UDialogueGraphNode_Edge* InEdgeNode,
        const TSharedPtr<FDialogueSearchResult>& OutParentNode
    );
 
    bool QueryCommentNode(
        const FDialogueSearchFilter& SearchFilter,
        const UEdGraphNode_Comment* InCommentNode,
        const TSharedPtr<FDialogueSearchResult>& OutParentNode
    );
 
    bool QuerySingleDialogue(
        const FDialogueSearchFilter& SearchFilter,
        const UDlgDialogue* InDialogue,
        TSharedPtr<FDialogueSearchResult>& OutParentNode
    );
 
    // Searches for InSearchString in all Dialogues. Adds the result as children of OutParentNode.
    void QueryAllDialogues(const FDialogueSearchFilter& SearchFilter, TSharedPtr<FDialogueSearchResult>& OutParentNode);
 
    // Determines the global find results tab label
    FText GetGlobalFindResultsTabLabel(int32 TabIdx);
 
    // Close One of the global find results.
    void CloseGlobalFindResults(const TSharedRef<SFindInDialogues>& FindResults);
 
    // Find or create the global find results widget
    TSharedPtr<SFindInDialogues> GetGlobalFindResults();
 
    // Enables the global find results tab feature in the Windows Menu.
    void EnableGlobalFindResults(TSharedPtr<FWorkspaceItem> ParentTabCategory = nullptr);
 
    // Disables the global find results tab feature in the Windows Menu.
    void DisableGlobalFindResults();
 
    // Initializes the manager. Should only be called once in the FDlgSystemEditorModule::StartupModule()
    void Initialize(TSharedPtr<FWorkspaceItem> ParentTabCategory = nullptr);
 
    // Uninitializes the manager. Should only be called once in the FDlgSystemEditorModule::ShutdownModule()
    void UnInitialize();
 
private:
    // Helper method to make a Text Node and add it as a child to ParentNode
    TSharedPtr<FDialogueSearchResult> MakeChildTextNode(
        const TSharedPtr<FDialogueSearchResult>& ParentNode,
        const FText& DisplayName, const FText& Category,
        const FString& CommentString
    )
    {
        TSharedPtr<FDialogueSearchResult> TextNode = MakeShared<FDialogueSearchResult>(DisplayName, ParentNode);
        TextNode->SetCategory(Category);
        if (!CommentString.IsEmpty())
        {
            TextNode->SetCommentString(CommentString);
        }
        ParentNode->AddChild(TextNode);
        return TextNode;
    }
 
    bool SearchForTextLocalizationData(
        const TSharedPtr<FDialogueSearchResult>& ParentNode,
        const FString& SearchString,
        const FText& Text,
        const FText& NamespaceCategory,
        const FString& NamespaceCommentString,
        const FText& KeyCategory,
        const FString& KeyCommentString
    )
    {
        static const FString DefaultValue = TEXT("");
        bool bContainsSearchString = false;
 
        const FString CurrentFullNamespace = FTextInspector::GetNamespace(Text).Get(DefaultValue);
        const FString CurrentKey = FTextInspector::GetKey(Text).Get(DefaultValue);
        if (CurrentFullNamespace.Contains(SearchString))
        {
            bContainsSearchString = true;
            MakeChildTextNode(
                ParentNode,
                FText::AsCultureInvariant(CurrentFullNamespace),
                NamespaceCategory,
                NamespaceCommentString
            );
        }
        if (CurrentKey.Contains(SearchString))
        {
            bContainsSearchString = true;
            MakeChildTextNode(
                ParentNode,
                FText::AsCultureInvariant(CurrentKey),
                KeyCategory,
                KeyCommentString
            );
        }
 
        return bContainsSearchString;
    }
 
    // Handler for a request to spawn a new global find results tab
    TSharedRef<SDockTab> SpawnGlobalFindResultsTab(const FSpawnTabArgs& SpawnTabArgs, int32 TabIdx);
 
    // Creates and opens a new global find results tab. The next one in the available list.
    TSharedPtr<SFindInDialogues> OpenGlobalFindResultsTab();
 
    // Builds the cache from all available Dialogues assets that the asset registry has discovered at the time of this function. Occurs on startup.
    void BuildCache();
 
    // Callback hook from the Asset Registry when an asset is added
    void HandleOnAssetAdded(const FAssetData& InAssetData);
 
    // Callback hook from the Asset Registry, marks the asset for deletion from the cache
    void HandleOnAssetRemoved(const FAssetData& InAssetData);
 
    // Callback hook from the Asset Registry, marks the asset for deletion from the cache
    void HandleOnAssetRenamed(const FAssetData& InAssetData, const FString& InOldName);
 
    // Callback hook from the Asset Registry when an asset is loaded
    void HandleOnAssetLoaded(UObject* InAsset);
 
    // Callback when the Asset Registry loads all its assets
    void HandleOnAssetRegistryFilesLoaded();
 
private:
    static Self* Instance;
 
    // Maps the Dialogue path => SearchData.
    TMap<FName, FDialogueSearchData> SearchMap;
 
    // Because we are unable to query for the module on another thread, cache it for use later
    IAssetRegistry* AssetRegistry = nullptr;
 
    // The tab identifier/instance name for global find results
    FName GlobalFindResultsTabIDs[MAX_GLOBAL_DIALOGUE_SEARCH_RESULTS];
 
    // Array of open global find results widgets
    TArray<TWeakPtr<SFindInDialogues>> GlobalFindResultsWidgets;
 
    // Global Find Results workspace menu item
    TSharedPtr<FWorkspaceItem> GlobalFindResultsMenuItem;
 
    // Handlers
    FDelegateHandle OnAssetAddedHandle;
    FDelegateHandle OnAssetRemovedHandle;
    FDelegateHandle OnAssetRenamedHandle;
    FDelegateHandle OnFilesLoadedHandle;
    FDelegateHandle OnAssetLoadedHandle;
};