journal.h

Go to the documentation of this file.

//
// Copyright 2025 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_EXEC_ESF_JOURNAL_H
#define PXR_EXEC_ESF_JOURNAL_H


#include "pxr/pxr.h"

#include "pxr/exec/esf/editReason.h"

#include "pxr/base/tf/denseHashMap.h"
#include "pxr/base/tf/hash.h"
#include "pxr/usd/sdf/path.h"

PXR_NAMESPACE_OPEN_SCOPE

class EsfJournal
{
    using _HashMap = TfDenseHashMap<SdfPath, EsfEditReason, TfHash>;

public:
    EsfJournal &Add(const SdfPath &path, EsfEditReason editReason) {
        if (TF_VERIFY(path.IsAbsolutePath()) && TF_VERIFY(!path.IsEmpty())) {
            _hashMap[path] |= editReason;
        }
        return *this;
    }

    void Merge(const EsfJournal &other) {
        for (const value_type &entry : other) {
            _hashMap[entry.first] |= entry.second;
        }
    }

    bool operator==(const EsfJournal &other) const {
        return _hashMap == other._hashMap;
    }

    bool operator!=(const EsfJournal &other) const {
        return _hashMap != other._hashMap;
    }

    using value_type = _HashMap::value_type;
    using iterator = _HashMap::iterator;
    using const_iterator = _HashMap::const_iterator;

    iterator begin() & {
        return _hashMap.begin();
    }

    iterator end() & {
        return _hashMap.end();
    }

    const_iterator begin() const & {
        return _hashMap.begin();
    }

    const_iterator end() const & {
        return _hashMap.end();
    }

    const_iterator cbegin() const & {
        return _hashMap.begin();
    }

    const_iterator cend() const & {
        return _hashMap.end();
    }

private:
    _HashMap _hashMap;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif