tracktion_ProjectItemID.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 ProjectItemID
{
public:
    ProjectItemID() noexcept = default;
    ProjectItemID (const ProjectItemID&) noexcept = default;
    ProjectItemID& operator= (const ProjectItemID&) noexcept = default;
    ~ProjectItemID() noexcept = default;
 
    explicit ProjectItemID (const juce::String& stringID) noexcept;
 
    ProjectItemID (int itemID, int projectID) noexcept;
 
    static ProjectItemID createNewID (int projectID) noexcept;
    static ProjectItemID fromProperty (const juce::ValueTree&, const juce::Identifier&);
 
    ProjectItemID withNewProjectID (int newProjectID) const;
 
    //==============================================================================
    // TODO: create strong types for ProjectID and the ItemID
 
    int getProjectID() const;
    int getItemID() const;
 
    int64_t getRawID() const noexcept                   { return combinedID; }
 
    //==============================================================================
    bool isValid() const noexcept                       { return combinedID != 0; }
    bool isInvalid() const noexcept                     { return combinedID == 0; }
 
    //==============================================================================
    juce::String toString() const;
    juce::String toStringSuitableForFilename() const;
 
    //==============================================================================
    bool operator== (ProjectItemID other) const         { return combinedID == other.combinedID; }
    bool operator!= (ProjectItemID other) const         { return combinedID != other.combinedID; }
    bool operator<  (ProjectItemID other) const         { return combinedID <  other.combinedID; }
 
private:
    int64_t combinedID = 0;
 
    // (NB: this is disallowed because it's ambiguous whether a string or int64 format is intended)
    ProjectItemID (const juce::var&) = delete;
};
 
}} // namespace tracktion { inline namespace engine
 
namespace juce
{
    template <>
    struct VariantConverter<tracktion::engine::ProjectItemID>
    {
        static tracktion::engine::ProjectItemID fromVar (const var& v)   { return tracktion::engine::ProjectItemID (v.toString()); }
        static var toVar (const tracktion::engine::ProjectItemID& v)     { return v.toString(); }
    };
}