cello_object.h

/*
    Copyright (c) 2023 Brett g Porter
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:
    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.
*/
 
#pragma once
 
#include <juce_core/juce_core.h>
#include <juce_data_structures/juce_data_structures.h>
 
#include "cello_update_source.h"
 
namespace cello
{
class ValueBase;
class Query;
 
class Object : public UpdateSource,
               public juce::ValueTree::Listener
{
public:
    enum class FileFormat
    {
        xml,    // load/store as XML text.
        binary, // load/store in juce's binary format.
        zipped  // GZIPped juce binary.
    };
 
    enum class CreationType
    {
        initialized, // this object was default initialized when created.
        wrapped      // this object wrapped an existing tree.
    };

    Object (const juce::String& type, const Object* state);

    Object (const juce::String& type, const Object& state);

    Object (const juce::String& type, juce::ValueTree tree);

    Object (const juce::String& type, juce::File file, FileFormat format = FileFormat::xml);

    Object (const Object& rhs);

    CreationType wrap (const Object& other);

    Object& operator= (const Object& rhs);

    ~Object () override;

    bool operator== (const juce::ValueTree& rhs) const noexcept { return data == rhs; }
 
    bool operator!= (const juce::ValueTree& rhs) const noexcept { return data != rhs; }

    juce::Identifier getType () const { return data.getType (); }

    juce::String getTypeName () const { return getType ().toString (); }

    juce::String toXmlString (const juce::XmlElement::TextFormat& format = {}) const
    {
        return data.toXmlString (format);
    }

    CreationType getCreationType () const { return creationType; }

    bool wasWrapped () const { return creationType == CreationType::wrapped; }

    bool wasInitialized () const { return creationType == CreationType::initialized; }

    operator juce::ValueTree () const { return data; }

    juce::ValueTree clone (bool deep) const;

    void update (const juce::MemoryBlock& updateBlock);


    juce::ValueTree find (const cello::Query& query, bool deep = false);

    juce::ValueTree findOne (const cello::Query& query, bool deep = false);

    bool upsert (const Object* object, const juce::Identifier& key, bool deep = false);

    void upsertAll (const Object* parent, const juce::Identifier& key, bool deep = false);


    void setUndoManager (juce::UndoManager* undo);

    juce::UndoManager* getUndoManager () const;

    bool canUndo () const;

    bool undo ();

    bool canRedo () const;

    bool redo ();

    void clearUndoHistory ();

 
    // An iterator to access child objects; note that it works in terms
    // of ValueTrees, not objects (since our list of children can be
    // heterogeneous)
    using Iterator = juce::ValueTree::Iterator;
    Iterator begin () { return data.begin (); }
    Iterator end () { return data.end (); }

    juce::ValueTree operator[] (int index) const;

    int getNumChildren () const;

    void append (Object* object);

    void insert (Object* object, int index);

    Object* remove (Object* object);

    juce::ValueTree remove (int index);

    void move (int fromIndex, int toIndex);

    template <typename Comparator> void sort (Comparator& comp, bool stableSort);


    void excludeListener (juce::ValueTree::Listener* listener) { excludedListener = listener; }

    juce::ValueTree::Listener* getExcludedListener () const { return excludedListener; }


    void onPropertyChange (juce::Identifier id, PropertyUpdateFn callback);

    void onPropertyChange (PropertyUpdateFn callback) { onPropertyChange (getType (), callback); }

    void onPropertyChange (const ValueBase& val, PropertyUpdateFn callback);
 
    using ChildUpdateFn = std::function<void (juce::ValueTree& child, int oldIndex, int newIndex)>;
 
    ChildUpdateFn onChildAdded;
    ChildUpdateFn onChildRemoved;
    ChildUpdateFn onChildMoved;
 
    using SelfUpdateFn = std::function<void (void)>;
 
    SelfUpdateFn onParentChanged;
    SelfUpdateFn onTreeRedirected;



    template <typename T> T getattr (const juce::Identifier& attr, const T& defaultVal) const
    {
        return juce::VariantConverter<T>::fromVar (data.getProperty (attr, defaultVal));
    }

    bool hasattr (const juce::Identifier& attr) const;

    template <typename T> Object& setattr (const juce::Identifier& attr, const T& attrVal)
    {
        data.setProperty (attr, juce::VariantConverter<T>::toVar (attrVal), getUndoManager ());
        return (*this);
    }

    void delattr (const juce::Identifier& attr);



    static juce::ValueTree load (juce::File file, FileFormat format = FileFormat::xml);

    juce::Result save (juce::File file, FileFormat format = FileFormat::xml) const;

private:
    CreationType wrap (const juce::String& type, juce::ValueTree tree);

    void valueTreePropertyChanged (juce::ValueTree& treeWhosePropertyHasChanged,
                                   const juce::Identifier& property) override;

    void valueTreeChildAdded (juce::ValueTree& parentTree, juce::ValueTree& childTree) override;

    void valueTreeChildRemoved (juce::ValueTree& parentTree, juce::ValueTree& childTree, int index) override;

    void valueTreeChildOrderChanged (juce::ValueTree& childTree, int oldIndex, int newIndex) override;

    void valueTreeParentChanged (juce::ValueTree& tree) override;

    void valueTreeRedirected (juce::ValueTree& tree) override;
 
protected:
    juce::ValueTree data;

    juce::UndoManager* undoManager { nullptr };

    CreationType creationType { CreationType::wrapped };

    juce::ValueTree::Listener* excludedListener { nullptr };

    bool doForceUpdates { false };
 
private:
    struct PropertyUpdate
    {
        PropertyUpdate (juce::Identifier id_, PropertyUpdateFn fn_)
        : id { id_ }
        , fn { fn_ }
        {
        }
 
        juce::Identifier id;
        PropertyUpdateFn fn;
    };
 
    std::vector<PropertyUpdate> propertyUpdaters;
};
 
} // namespace cello