listOp.h

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_SDF_LIST_OP_H
#define PXR_USD_SDF_LIST_OP_H
 
#include "pxr/pxr.h"
#include "pxr/usd/sdf/api.h"
#include "pxr/base/tf/token.h"
#include "pxr/base/tf/hash.h"
#include "pxr/base/vt/traits.h"
 
#include <functional>
#include <iosfwd>
#include <list>
#include <map>
#include <optional>
#include <string>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
enum SdfListOpType {
    SdfListOpTypeExplicit,
    SdfListOpTypeAdded,
    SdfListOpTypeDeleted,
    SdfListOpTypeOrdered,
    SdfListOpTypePrepended,
    SdfListOpTypeAppended
};
 
template <class T>
struct Sdf_ListOpTraits
{
    typedef std::less<T> ItemComparator;
};
 
 
template <typename T>
class SdfListOp {
public:
    typedef T ItemType;
    typedef std::vector<ItemType> ItemVector;
    typedef ItemType value_type;
    typedef ItemVector value_vector_type;
 
    SDF_API
    static SdfListOp CreateExplicit(
        const ItemVector& explicitItems = ItemVector());
 
    SDF_API
    static SdfListOp Create(
        const ItemVector& prependedItems = ItemVector(),
        const ItemVector& appendedItems = ItemVector(),
        const ItemVector& deletedItems = ItemVector());
 
    SDF_API SdfListOp();
 
    SDF_API void Swap(SdfListOp<T>& rhs);
 
    bool HasKeys() const
    {
        if (IsExplicit()) {
            return true;
        }
        if (_addedItems.size() != 0 ||
            _prependedItems.size() != 0 ||
            _appendedItems.size() != 0 ||
            _deletedItems.size() != 0) {
            return true;
        }
        return _orderedItems.size() != 0;
    }
 
    SDF_API bool HasItem(const T& item) const;
 
    bool IsExplicit() const
    {
        return _isExplicit;
    }
 
    const ItemVector& GetExplicitItems() const
    {
        return _explicitItems;
    }
 
    const ItemVector& GetPrependedItems() const
    {
        return _prependedItems;
    }
 
    const ItemVector& GetAppendedItems() const
    {
        return _appendedItems;
    }
 
    const ItemVector& GetDeletedItems() const
    {
        return _deletedItems;
    }
 
    SDF_API const ItemVector& GetItems(SdfListOpType type) const;
 
    SDF_API ItemVector GetAppliedItems() const;
 
    SDF_API bool SetExplicitItems(const ItemVector &items, std::string* errMsg = nullptr);
 
    SDF_API bool SetPrependedItems(const ItemVector &items, std::string* errMsg = nullptr);
 
    SDF_API bool SetAppendedItems(const ItemVector &items, std::string* errMsg = nullptr);
 
    SDF_API bool SetDeletedItems(const ItemVector &items, std::string* errMsg = nullptr);
 
    SDF_API bool SetItems(const ItemVector &items, SdfListOpType type, 
                            std::string* errMsg = nullptr);
 
    SDF_API void Clear();
 
    SDF_API void ClearAndMakeExplicit();
 
    typedef std::function<
        std::optional<ItemType>(SdfListOpType, const ItemType&)
    > ApplyCallback;
 
    SDF_API 
    void ApplyOperations(ItemVector* vec, 
                         const ApplyCallback& cb = ApplyCallback()) const;
 
    SDF_API 
    std::optional<SdfListOp<T>>
    ApplyOperations(const SdfListOp<T> &inner) const;
 
    typedef std::function<
        std::optional<ItemType>(const ItemType&)
    > ModifyCallback;
 
    SDF_API
    bool ModifyOperations(const ModifyCallback& callback);
 
    SDF_API
    bool ModifyOperations(const ModifyCallback& callback,
                          bool unusedRemoveDuplicates);
 
    SDF_API 
    bool ReplaceOperations(const SdfListOpType op, size_t index, size_t n, 
                           const ItemVector& newItems);
 
    SDF_API 
    void ComposeOperations(const SdfListOp<T>& stronger, SdfListOpType op);
 
    const ItemVector& GetAddedItems() const
    {
        return _addedItems;
    }
 
    const ItemVector& GetOrderedItems() const
    {
        return _orderedItems;
    }
    SDF_API void SetAddedItems(const ItemVector &items);
 
    SDF_API void SetOrderedItems(const ItemVector &items);
 
    friend inline size_t hash_value(const SdfListOp &op) {
        return TfHash::Combine(
            op._isExplicit,
            op._explicitItems,
            op._addedItems,
            op._prependedItems,
            op._appendedItems,
            op._deletedItems,
            op._orderedItems
        );
    }
 
    bool operator==(const SdfListOp<T> &rhs) const {
        return _isExplicit == rhs._isExplicit &&
               _explicitItems == rhs._explicitItems &&
               _addedItems == rhs._addedItems &&
               _prependedItems == rhs._prependedItems &&
               _appendedItems == rhs._appendedItems &&
               _deletedItems == rhs._deletedItems &&
               _orderedItems == rhs._orderedItems;
    };
 
    bool operator!=(const SdfListOp<T> &rhs) const {
        return !(*this == rhs);
    };
 
private:
    void _SetExplicit(bool isExplicit);
 
    typedef typename Sdf_ListOpTraits<T>::ItemComparator _ItemComparator;
    typedef std::list<ItemType> _ApplyList;
    typedef std::map<ItemType, typename _ApplyList::iterator, _ItemComparator>
        _ApplyMap;
 
    void _PrependKeys(const ApplyCallback& cb,
                      _ApplyList* result, _ApplyMap* search) const;
    void _AppendKeys(const ApplyCallback& cb,
                     _ApplyList* result, _ApplyMap* search) const;
    void _DeleteKeys(const ApplyCallback& cb,
                     _ApplyList* result, _ApplyMap* search) const;
 
    void _AddKeys(SdfListOpType, const ApplyCallback& cb,
                  _ApplyList* result, _ApplyMap* search) const;
 
    void _ReorderKeys(const ApplyCallback& cb,
                      _ApplyList* result, _ApplyMap* search) const;
    static void _ReorderKeysHelper(ItemVector order, const ApplyCallback& cb,
                                   _ApplyList *result, _ApplyMap *search);
    template <class ItemType>
    friend void SdfApplyListOrdering(std::vector<ItemType> *v,
                                    const std::vector<ItemType> &order);
    bool _MakeUnique(std::vector<T>& items, bool reverse=false, 
                    std::string* errMsg = nullptr);
 
private:
    bool _isExplicit;
    ItemVector _explicitItems;
    ItemVector _addedItems;
    ItemVector _prependedItems;
    ItemVector _appendedItems;
    ItemVector _deletedItems;
    ItemVector _orderedItems;
};
 
// SdfListOps can VtValue-compose.
template <class T>
struct VtValueTypeCanCompose<SdfListOp<T>> : std::true_type {};
 
// ADL swap.
template <class T>
void swap(SdfListOp<T> &x, SdfListOp<T> &y)
{
    x.Swap(y);
}
 
// Helper function for applying an ordering operation described by \p orderVector
// to vector \p v.
template <class ItemType>
SDF_API
void SdfApplyListOrdering(std::vector<ItemType>* v, 
                          const std::vector<ItemType>& order);
 
// Ostream output methods for list values (useful for debugging and required
// for storing a list value in a VtValue).
template <typename T>
SDF_API
std::ostream & operator<<( std::ostream &, const SdfListOp<T> & );
 
// Concrete, instantiated listop types.
typedef class SdfListOp<int> SdfIntListOp;
typedef class SdfListOp<unsigned int> SdfUIntListOp;
typedef class SdfListOp<int64_t> SdfInt64ListOp;
typedef class SdfListOp<uint64_t> SdfUInt64ListOp;
typedef class SdfListOp<TfToken> SdfTokenListOp;
typedef class SdfListOp<std::string> SdfStringListOp;
typedef class SdfListOp<class SdfPath> SdfPathListOp;
typedef class SdfListOp<class SdfReference> SdfReferenceListOp;
typedef class SdfListOp<class SdfPayload> SdfPayloadListOp;
typedef class SdfListOp<class SdfUnregisteredValue> SdfUnregisteredValueListOp;
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_SDF_LIST_OP_H