tracktion_ProjectSearchIndex.h

Go to the documentation of this file.

 /*
    ,--.                     ,--.     ,--.  ,--.
  ,-'  '-.,--.--.,--,--.,---.|  |,-.,-'  '-.`--' ,---. ,--,--,      Copyright 2024
  '-.  .-'|  .--' ,-.  | .--'|     /'-.  .-',--.| .-. ||      \   Tracktion Software
    |  |  |  |  \ '-'  \ `--.|  \  \  |  |  |  |' '-' '|  ||  |       Corporation
    `---' `--'   `--`--'`---'`--'`--' `---' `--' `---' `--''--'    www.tracktion.com
 
    Tracktion Engine uses a GPL/commercial licence - see LICENCE.md for details.
*/
 
namespace tracktion { inline namespace engine
{
 
struct IndexedWord;
class SearchOperation;
 
//==============================================================================
class ProjectSearchIndex
{
public:
    ProjectSearchIndex (Project&);
 
    void addClip (const ProjectItem::Ptr&);
    void findMatches (SearchOperation&, juce::Array<ProjectItemID>& results);
 
    void writeToStream (juce::OutputStream&);
    void readFromStream (juce::InputStream&);
 
    IndexedWord* findWordMatch (const juce::String& word) const;
 
    Project& project;
    juce::OwnedArray<IndexedWord> index;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ProjectSearchIndex)
};
 
//==============================================================================
SearchOperation* createSearchForKeywords (const juce::String& keywords);
 
//==============================================================================
class SearchOperation
{
public:
    SearchOperation (SearchOperation* in1 = nullptr,
                     SearchOperation* in2 = nullptr);
    virtual ~SearchOperation();
 
    virtual juce::Array<int> getMatches (ProjectSearchIndex&) = 0;
 
protected:
    const std::unique_ptr<SearchOperation> in1, in2;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (SearchOperation)
};
 
}} // namespace tracktion { inline namespace engine