collection.h

//
// Copyright 2018 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
 
#ifndef PXR_BASE_TRACE_COLLECTION_H
#define PXR_BASE_TRACE_COLLECTION_H
 
#include "pxr/pxr.h"
 
#include "pxr/base/trace/api.h"
#include "pxr/base/trace/event.h"
#include "pxr/base/trace/eventList.h"
#include "pxr/base/trace/threads.h"
 
#include "pxr/base/tf/mallocTag.h"
 
#include <map>
#include <unordered_map>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class TraceCollection {
public:
    TF_MALLOC_TAG_NEW("Trace", "TraceCollection");
 
    using This = TraceCollection;
 
    using EventList = TraceEventList;
    using EventListPtr = std::unique_ptr<EventList>;
 
    TraceCollection() = default;
 
    TraceCollection(TraceCollection&&) = default;
 
    TraceCollection& operator=(TraceCollection&&) = default;
 
    // Collections should not be copied because TraceEvents contain 
    // pointers to elements in the Key cache.
    TraceCollection(const TraceCollection&) = delete;
    TraceCollection& operator=(const TraceCollection&) = delete;
 
 
    TRACE_API void AddToCollection(const TraceThreadId& id, EventListPtr&& events);
 
    class Visitor {
    public:
        TRACE_API virtual ~Visitor();
 
        virtual void OnBeginCollection() = 0;
 
        virtual void OnEndCollection() = 0;
 
        virtual void OnBeginThread(const TraceThreadId& threadId) = 0;
 
        virtual void OnEndThread(const TraceThreadId& threadId) = 0;
 
        virtual bool AcceptsCategory(TraceCategoryId categoryId) = 0;
 
        virtual void OnEvent(
            const TraceThreadId& threadId, 
            const TfToken& key, 
            const TraceEvent& event) = 0;
    };
 
    TRACE_API void Iterate(Visitor& visitor) const;
 
    TRACE_API void ReverseIterate(Visitor& visitor) const;
 
private:
    using KeyTokenCache = 
        std::unordered_map<TraceKey, TfToken, TraceKey::HashFunctor>;
 
    void _Iterate(Visitor& visitor, bool doReverse) const;
 
    // Iterate through events in either forward or reverse order, depending on
    // the templated arguments
    template <class I> 
    void _IterateEvents(Visitor&, KeyTokenCache&, 
        const TraceThreadId&, I, I) const;
 
    using EventTable = std::map<TraceThreadId, EventListPtr>;
 
    EventTable _eventsPerThread;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_TRACE_COLLECTION_H