coalescingDiagnosticDelegate.h

Go to the documentation of this file.

//
// Copyright 2017 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_USD_USD_UTILS_COALESCING_DIAGNOSTIC_DELEGATE_H
#define PXR_USD_USD_UTILS_COALESCING_DIAGNOSTIC_DELEGATE_H


#include "pxr/pxr.h"
#include "pxr/usd/usdUtils/api.h"
#include "pxr/base/tf/diagnosticMgr.h"

#include <ostream>
#include <memory>
#include <string>
#include <vector>

#include <tbb/concurrent_queue.h>

PXR_NAMESPACE_OPEN_SCOPE

struct UsdUtilsCoalescingDiagnosticDelegateSharedItem {
    size_t sourceLineNumber;
    std::string sourceFunction;
    std::string sourceFileName;
};

struct UsdUtilsCoalescingDiagnosticDelegateUnsharedItem {
    TfCallContext context;
    std::string commentary;
};

struct UsdUtilsCoalescingDiagnosticDelegateItem {
    UsdUtilsCoalescingDiagnosticDelegateSharedItem sharedItem;
    std::vector<UsdUtilsCoalescingDiagnosticDelegateUnsharedItem> unsharedItems;
};

typedef std::vector<UsdUtilsCoalescingDiagnosticDelegateItem>
        UsdUtilsCoalescingDiagnosticDelegateVector;

class UsdUtilsCoalescingDiagnosticDelegate : public TfDiagnosticMgr::Delegate {
public:
    USDUTILS_API
    UsdUtilsCoalescingDiagnosticDelegate();

    USDUTILS_API
    virtual ~UsdUtilsCoalescingDiagnosticDelegate();

    
    USDUTILS_API
    virtual void IssueError(const TfError&) override; 

    USDUTILS_API
    virtual void IssueStatus(const TfStatus&) override; 

    USDUTILS_API
    virtual void IssueWarning(const TfWarning&) override; 

    USDUTILS_API
    virtual void IssueFatalError(const TfCallContext&, const std::string &) override; 

    // Methods that provide collection of diagnostics as well as sending
    // them to a stream(stderr, stdout, a file, etc).

    USDUTILS_API
    void DumpCoalescedDiagnostics(std::ostream& ostr);

    USDUTILS_API
    void DumpUncoalescedDiagnostics(std::ostream& ostr);

    USDUTILS_API
    UsdUtilsCoalescingDiagnosticDelegateVector TakeCoalescedDiagnostics();

    USDUTILS_API
    std::vector<std::unique_ptr<TfDiagnosticBase>> TakeUncoalescedDiagnostics(); 

private:
    tbb::concurrent_queue<TfDiagnosticBase*> _diagnostics; 
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_USD_USD_UTILS_COALESCING_DIAGNOSTIC_DELEGATE_H