errorTransport.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_BASE_TF_ERROR_TRANSPORT_H
#define PXR_BASE_TF_ERROR_TRANSPORT_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/tf/diagnosticMgr.h"
#include "pxr/base/arch/hints.h"
#include "pxr/base/tf/api.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class TfErrorTransport
{
public:
    typedef TfDiagnosticMgr::ErrorList ErrorList;
 
    TfErrorTransport() {}
 
    void Post() {
        if (ARCH_UNLIKELY(!IsEmpty()))
            _PostImpl();
        _pin = {};
    }
 
    bool IsEmpty() const { return _errorList.empty(); }
 
    void swap(TfErrorTransport &other) {
        _errorList.swap(other._errorList);
        std::swap(_pin, other._pin);
    }
 
private:
    friend class Tf_DiagnosticMgrTestAccess;
    friend class TfErrorMark;
 
    TfErrorTransport(ErrorList &src,
                     ErrorList::iterator first,
                     ErrorList::iterator last,
                     TfDiagnosticMgr::_LogTextPin &&pin)
        : _pin(std::move(pin))
    {
        _errorList.splice(_errorList.begin(), src, first, last);
    }
 
    TF_API
    void _PostImpl();
 
    ErrorList _errorList;
    TfDiagnosticMgr::_LogTextPin _pin;
};
 
inline void
swap(TfErrorTransport &l, TfErrorTransport &r)
{
    l.swap(r);
}
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_TF_ERROR_TRANSPORT_H