diagnosticDelegate.h

Go to the documentation of this file.

//
// Copyright 2018 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 PXRUSDMAYA_DIAGNOSTICDELEGATE_H
#define PXRUSDMAYA_DIAGNOSTICDELEGATE_H


#include "usdMaya/api.h"

#include "pxr/pxr.h"

#include "pxr/base/tf/diagnosticMgr.h"

#include "pxr/usd/usdUtils/coalescingDiagnosticDelegate.h"

#include <maya/MGlobal.h>

#include <atomic>
#include <memory>

PXR_NAMESPACE_OPEN_SCOPE

class UsdMayaDiagnosticBatchContext;

class UsdMayaDiagnosticDelegate : TfDiagnosticMgr::Delegate {
public:
    PXRUSDMAYA_API
    ~UsdMayaDiagnosticDelegate() override;

    PXRUSDMAYA_API
    void IssueError(const TfError& err) override;
    PXRUSDMAYA_API
    void IssueStatus(const TfStatus& status) override;
    PXRUSDMAYA_API
    void IssueWarning(const TfWarning& warning) override;
    PXRUSDMAYA_API
    void IssueFatalError(
        const TfCallContext& context,
        const std::string& msg) override;

    PXRUSDMAYA_API
    static void InstallDelegate();
    PXRUSDMAYA_API
    static void RemoveDelegate();
    PXRUSDMAYA_API
    static int GetBatchCount();

private:
    friend class UsdMayaDiagnosticBatchContext;

    std::atomic_int _batchCount;
    std::unique_ptr<UsdUtilsCoalescingDiagnosticDelegate> _batchedStatuses;
    std::unique_ptr<UsdUtilsCoalescingDiagnosticDelegate> _batchedWarnings;

    UsdMayaDiagnosticDelegate();

    void _StartBatch();
    void _EndBatch();
    void _FlushBatch();
};

class UsdMayaDiagnosticBatchContext
{
public:
    PXRUSDMAYA_API
    UsdMayaDiagnosticBatchContext();
    PXRUSDMAYA_API
    ~UsdMayaDiagnosticBatchContext();

    UsdMayaDiagnosticBatchContext(
            const UsdMayaDiagnosticBatchContext&) = delete;
    UsdMayaDiagnosticBatchContext& operator=(
            const UsdMayaDiagnosticBatchContext&) = delete;

private:
    std::weak_ptr<UsdMayaDiagnosticDelegate> _delegate;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif