DPrint.h

Go to the documentation of this file.

/******************************************************************************
 *
 * C++ Insights, copyright (C) by Andreas Fertig
 * Distributed under an MIT license. See LICENSE for details
 *
 ****************************************************************************/
 
#ifndef INSIGHTS_DPRINT_H
#define INSIGHTS_DPRINT_H
 
#include <source_location>
 
#include "InsightsStrCat.h"
//-----------------------------------------------------------------------------
 
namespace clang::insights {
 
namespace details {
 
inline const char* Normalize(const std::string& arg)
{
    static constexpr const char emptyString[]{""};
 
    if(arg.empty()) {
        return emptyString;
    }
 
    return arg.c_str();
}
//-----------------------------------------------------------------------------
 
inline uint64_t Normalize(const llvm::APInt& arg)
{
    return arg.getZExtValue();
}
//-----------------------------------------------------------------------------
 
inline const char* Normalize(const llvm::APSInt& arg)
{
    return Normalize(ToString(arg));
}
//-----------------------------------------------------------------------------
 
inline const char* Normalize(const StringRef& arg)
{
    return Normalize(arg.str());
}
//-----------------------------------------------------------------------------
 
inline const auto& Normalize(const auto& arg)
{
    return arg;
}
//-----------------------------------------------------------------------------
 
inline void FPrintf(const char* fmt, const auto&... args)
{
    if constexpr(0 < (sizeof...(args))) {
        fprintf(stderr, fmt, Normalize(args)...);
    } else {
        fprintf(stderr, "%s", fmt);
    }
}
//-----------------------------------------------------------------------------
 
}  // namespace details
 
/// \brief Debug print which is disabled in release-mode.
///
/// It takes a variable number of parameters which are normalized if they are a \ref std::string or a \ref StringRef.
inline void DPrint([[maybe_unused]] const char* fmt, [[maybe_unused]] const auto&... args)
{
#ifdef INSIGHTS_DEBUG
    details::FPrintf(fmt, args...);
#endif /* INSIGHTS_DEBUG */
}
//-----------------------------------------------------------------------------
 
/// \brief Log an error.
inline void Error(const char* fmt, const auto&... args)
{
    details::FPrintf(fmt, args...);
}
//-----------------------------------------------------------------------------
 
inline void Dump([[maybe_unused]] const auto* stmt)
{
#ifdef INSIGHTS_DEBUG
    if(stmt) {
        stmt->dump();
    }
#endif /* INSIGHTS_DEBUG */
}
//-----------------------------------------------------------------------------
 
/// \brief Log an error.
///
/// In debug-mode this dumps the \ref Decl which caused the error and the error message.
inline void Error(const Decl* stmt, const char* fmt, const auto&... args)
{
    if(stmt) {
        Dump(stmt);
    }
 
    Error(fmt, args...);
}
//-----------------------------------------------------------------------------
 
/// \brief Log an error.
///
/// In debug-mode this dumps the \ref Stmt which caused the error and the error message.
inline void Error(const Stmt* stmt, const char* fmt, const auto&... args)
{
    if(stmt) {
        Dump(stmt);
    }
 
    Error(fmt, args...);
}
//-----------------------------------------------------------------------------
 
/// \brief Helper function to generate TODO comments for an unsupported \ref Stmt.
void ToDo(const class Stmt*         stmt,
          class OutputFormatHelper& outputFormatHelper,
          std::source_location      loc = std::source_location::current());
/// \brief Helper function to generate TODO comments for an unsupported \ref Decl.
void ToDo(const class Decl*         stmt,
          class OutputFormatHelper& outputFormatHelper,
          std::source_location      loc = std::source_location::current());
//-----------------------------------------------------------------------------
/// \brief Helper function to generate TODO comments for an unsupported \ref TemplateArgument.
void ToDo(const class TemplateArgument& stmt,
          class OutputFormatHelper&     outputFormatHelper,
          std::source_location          loc = std::source_location::current());
//-----------------------------------------------------------------------------
 
}  // namespace clang::insights
 
#endif /* INSIGHTS_DPRINT_H */