diagnosticBase.h

Go to the documentation of this file.

//
// Copyright 2016 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_BASE_TF_DIAGNOSTIC_BASE_H
#define PXR_BASE_TF_DIAGNOSTIC_BASE_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/tf/api.h"
#include "pxr/base/tf/callContext.h"
#include "pxr/base/tf/enum.h"
#include "pxr/base/tf/refBase.h"
#include "pxr/base/tf/stringUtils.h"
#include "pxr/base/tf/weakPtr.h"
 
#include "pxr/base/arch/inttypes.h"
#include "pxr/base/arch/attributes.h"
#include "pxr/base/arch/function.h"
 
#include <any>
#include <cstdarg>
#include <string>
 
PXR_NAMESPACE_OPEN_SCOPE
 
typedef std::any TfDiagnosticInfo;
 
class TfDiagnosticMgr;
 
class TfDiagnosticBase {
public:
 
    const TfCallContext &GetContext() const {
        return _context;
    }
 
    std::string GetSourceFileName() const {
        return _context.GetFile();
    }
 
    size_t GetSourceLineNumber() const {
        return _context.GetLine();
    }
 
    std::string const &GetCommentary() const {
        return _commentary;
    }
 
    std::string GetSourceFunction() const {
        return ArchGetPrettierFunctionName(_context.GetFunction(),
                                           _context.GetPrettyFunction());
    }
 
    void AugmentCommentary(const std::string& s) {
        if (_commentary.empty())
            _commentary = s;
        else {
            _commentary += "\n";
            _commentary += s;
        }
    }
 
    TfEnum GetDiagnosticCode() const {
        return _code;
    }
    
 
    const std::string& GetDiagnosticCodeAsString() const {
        return _codeString;
    }
    
    template <typename T>
    const T* GetInfo() const {
        return std::any_cast<T>(&_info);
    }
 
    void SetInfo(TfDiagnosticInfo any) {
        _info = any;
    }
 
    bool GetQuiet() const {
        return _quiet;
    }
 
    TF_API
    bool IsFatal() const;
 
    TF_API
    bool IsCodingError() const;
    
    TF_API
    TfDiagnosticBase(TfEnum code, char const *codeString,
                     TfCallContext const &context,
                     const std::string& commentary,
                     TfDiagnosticInfo info, bool quiet);
 
protected:
    TfCallContext _context;
 
    std::string _commentary;
    TfEnum _code;
    std::string _codeString;
    TfDiagnosticInfo _info;
    size_t _serial = 0;
    bool _quiet = false;
 
    friend class TfDiagnosticMgr;
    friend class TfErrorTransport;
    friend class TfErrorMark;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_TF_DIAGNOSTIC_BASE_H