tracktion_EditFileOperations.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 EditFileOperations
{
public:
    EditFileOperations (Edit&);
    ~EditFileOperations();
 
    juce::File getEditFile() const;
 
    bool save (bool warnOfFailure, bool forceSaveEvenIfNotModified, bool offerToDiscardChanges);
    bool saveAs (const juce::File&, bool forceOverwriteExisting = false);
    bool saveAs();
 
    bool writeToFile (const juce::File&, bool writeQuickBinaryVersion);
 
    bool saveTempVersion (bool forceSaveEvenIfUnchanged);
    void deleteTempVersion();
    juce::File getTempVersionFile() const;
    static juce::File getTempVersionOfEditFile (const juce::File&);
    static void updateEditFiles();
 
    juce::Time getTimeOfLastSave() const    { return timeOfLastSave; }
 
private:
    Edit& edit;
    juce::ValueTree state;
 
    struct SharedDataPimpl;
    std::unique_ptr<SharedDataPimpl> sharedDataPimpl;
 
    juce::Time& timeOfLastSave;
    EditSnapshot::Ptr& editSnapshot;
};
 
//==============================================================================
std::unique_ptr<Edit> loadEditFromFile (Engine&, const juce::File&,
                                        Edit::EditRole role = Edit::EditRole::forEditing);
 
std::unique_ptr<Edit> createEmptyEdit (Engine&, const juce::File&);
 
juce::ValueTree loadEditFromProjectManager (ProjectManager&, ProjectItemID);
 
std::unique_ptr<Edit> loadEditForExamining (ProjectManager&, ProjectItemID, 
                                            Edit::EditRole role = Edit::EditRole::forExamining);
 
juce::ValueTree loadEditFromFile (Engine&, const juce::File&, ProjectItemID);
 
juce::ValueTree createEmptyEdit (Engine&);
 
juce::ValueTree updateLegacyEdit (const juce::ValueTree&);
 
void updateLegacyEdit (juce::XmlElement& editXML);
 
 
}} // namespace tracktion { inline namespace engine