tracktion_SourceFileReference.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
{
 
//==============================================================================
class SourceFileReference
{
public:
    SourceFileReference (Edit&, juce::ValueTree&, const juce::Identifier& prop);
    ~SourceFileReference();
 
    //==============================================================================
    Edit& edit;
    juce::CachedValue<juce::String> source;
 
    juce::File getFile() const;
    bool isUsingProjectReference() const;
    ProjectItemID getSourceProjectItemID() const;
    ProjectItem::Ptr getSourceProjectItem() const;
 
    void setToDirectFileReference (const juce::File&, bool useRelativePath);
 
    void setToProjectFileReference (const juce::File&, bool updateProjectItem);
 
    void setToProjectFileReference (ProjectItemID);
 
    static juce::String findPathFromFile (Edit&, const juce::File&, bool useRelativePath);
    static juce::File findFileFromString (Edit&, const juce::String& source);
 
private:
    juce::ValueTree state;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (SourceFileReference)
};
 
 
}} // namespace tracktion { inline namespace engine