cello_query.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>
 
namespace cello
{
 
class Query
{
public:
    static inline const juce::Identifier Result { "result" };
 
    // query function, returns true if the tree it is passed should
    // be included in the result set.
    using Predicate = std::function<bool (juce::ValueTree)>;
 
    // comparison/sort function.
    // return 0 if the two trees should sort equally.
    // return -1 if left should come before right
    // return +1 if right should come before left.
    using Comparison = std::function<int (const juce::ValueTree&, const juce::ValueTree&)>;

    Query (const juce::Identifier& resultType = Result);

    Query (Predicate filter, const juce::Identifier& resultType = Result);
 
    ~Query ()                       = default;
    Query (const Query&)            = default;
    Query& operator= (const Query&) = default;
    Query (Query&&)                 = default;
    Query& operator= (Query&&)      = default;

    Query& addFilter (Predicate filter);

    juce::ValueTree search (juce::ValueTree tree, bool deep, bool returnFirstFound = false) const;

    int remove (juce::ValueTree tree) const;

    Query& addComparison (Comparison sorter);

    juce::ValueTree sort (juce::ValueTree tree, juce::UndoManager* undo = nullptr, bool stableSort = false) const;
 
private:
    bool filter (juce::ValueTree tree) const;
 
    // ValueTree needs to be able to use our compareElements method.
    friend class juce::ValueTree;
    int compareElements (const juce::ValueTree& left, const juce::ValueTree& right) const;
 
private:
    juce::Identifier type;
    std::vector<Predicate> filters;
    std::vector<Comparison> sorters;
};
 
} // namespace cello