message.cpp File Reference

#include <cstdio>
#include <cstdlib>
#include <mutex>
#include <atomic>
#include "config.h"
#include "debug.h"
#include "portable.h"
#include "message.h"
#include "doxygen.h"
#include "fileinfo.h"
#include "dir.h"

Include dependency graph for message.cpp:

Go to the source code of this file.

Functions
static void	format_warn (const QCString &file, int line, const QCString &text)
static void	handle_warn_as_error ()
static void	do_warn (const QCString &file, int line, const char *prefix, fmt::string_view fmt, fmt::format_args args)
void	msg_ (fmt::string_view fmt, fmt::format_args args)
void	warn_ (WarningType type, const QCString &file, int line, fmt::string_view fmt, fmt::format_args args)
void	warn_uncond_ (fmt::string_view fmt, fmt::format_args args)
void	err_ (fmt::string_view fmt, fmt::format_args args)
void	err_full_ (const QCString &file, int line, fmt::string_view fmt, fmt::format_args args)
void	term_ (fmt::string_view fmt, fmt::format_args args)
QCString	warn_line (const QCString &file, int line)
void	warn_flush ()
void	initWarningFormat ()
void	finishWarnExit ()

Variables
static QCString	g_warnFormat
static QCString	g_warnLineFormat
static const char *	g_warningStr = "warning: "
static const char *	g_errorStr = "error: "
static FILE *	g_warnFile = stderr
static WARN_AS_ERROR_t	g_warnBehavior = WARN_AS_ERROR_t::NO
static QCString	g_warnlogFile
static bool	g_warnlogTemp = false
static std::atomic_bool	g_warnStat = false
static std::mutex	g_mutex

Function Documentation

do_warn()

static void do_warn ( const QCString & file, int line, const char * prefix, fmt::string_view fmt, fmt::format_args args )

static

Definition at line 109 of file message.cpp.

{
  format_warn(file,line,QCString(prefix+fmt::vformat(fmt,args)));
  handle_warn_as_error();
}

References format_warn(), handle_warn_as_error(), and prefix.

Referenced by warn_().

err_()

void err_	(	fmt::string_view	fmt,
		fmt::format_args	args )

Definition at line 159 of file message.cpp.

{
  fmt::print(g_warnFile,"{}{}",g_errorStr,fmt::vformat(fmt,args));
  handle_warn_as_error();
}

References g_errorStr, g_warnFile, and handle_warn_as_error().

Referenced by err_fmt().

err_full_()

void err_full_	(	const QCString &	file,
		int	line,
		fmt::string_view	fmt,
		fmt::format_args	args )

Definition at line 167 of file message.cpp.

{
  format_warn(file,line,QCString(g_errorStr+fmt::vformat(fmt,args)));
}

References format_warn(), and g_errorStr.

Referenced by err_full_fmt().

finishWarnExit()

void finishWarnExit

(

)

Definition at line 276 of file message.cpp.

{
  fflush(stdout);
  if (g_warnBehavior == WARN_AS_ERROR_t::FAIL_ON_WARNINGS_PRINT && g_warnlogFile != "-")
  {
    Portable::fclose(g_warnFile);
    g_warnFile = nullptr;
  }
  if (g_warnStat && g_warnBehavior == WARN_AS_ERROR_t::FAIL_ON_WARNINGS_PRINT && g_warnlogFile != "-")
  {
 
    std::ifstream warnFile = Portable::openInputStream(g_warnlogFile);
    if (!warnFile.is_open())
    {
      g_warnFile = stderr;
      err("Cannot open warnings file '{}' for reading\n",g_warnlogFile);
    }
    else
    {
      std::string line;
      while (getline(warnFile,line))
      {
        fmt::print(stderr,"{}\n",line);
      }
      warnFile.close();
    }
  }
 
  if (g_warnlogTemp) Portable::unlink(g_warnlogFile);
 
  if (g_warnStat && (g_warnBehavior == WARN_AS_ERROR_t::FAIL_ON_WARNINGS ||
                     g_warnBehavior == WARN_AS_ERROR_t::FAIL_ON_WARNINGS_PRINT))
  {
    exit(1);
  }
}

References err, Portable::fclose(), g_warnBehavior, g_warnFile, g_warnlogFile, g_warnlogTemp, g_warnStat, Portable::openInputStream(), and Portable::unlink().

Referenced by generateOutput().

format_warn()

static void format_warn ( const QCString & file, int line, const QCString & text )

static

Definition at line 43 of file message.cpp.

{
  QCString fileSubst = file.isEmpty() ? "<unknown>" : file;
  QCString lineSubst; lineSubst.setNum(line);
  QCString textSubst = text;
  QCString versionSubst;
  // substitute markers by actual values
  QCString msgText =
      substitute(
        substitute(
          substitute(
            substitute(
              g_warnFormat,
              "$file",fileSubst
            ),
            "$line",lineSubst
          ),
          "$version",versionSubst
        ),
        "$text",textSubst
      );
  if (g_warnBehavior == WARN_AS_ERROR_t::YES)
  {
    msgText += " (warning treated as error, aborting now)";
  }
  msgText += '\n';
 
  {
    std::unique_lock<std::mutex> lock(g_mutex);
    // print resulting message
    fwrite(msgText.data(),1,msgText.length(),g_warnFile);
  }
  if (g_warnBehavior == WARN_AS_ERROR_t::YES)
  {
    if (g_warnFile != stderr && !Config_getBool(QUIET))
    {
      msg("See '{}' for the reason of termination.\n",g_warnlogFile);
    }
    exit(1);
  }
  g_warnStat = true;
}

References Config_getBool, QCString::data(), g_mutex, g_warnBehavior, g_warnFile, g_warnFormat, g_warnlogFile, g_warnStat, QCString::isEmpty(), QCString::length(), msg, QCString::setNum(), and substitute().

Referenced by do_warn(), and err_full_().

handle_warn_as_error()

static void handle_warn_as_error ( )

static

Definition at line 88 of file message.cpp.

{
  if (g_warnBehavior == WARN_AS_ERROR_t::YES)
  {
    {
      std::unique_lock<std::mutex> lock(g_mutex);
      QCString msgText = " (warning treated as error, aborting now)\n";
      fwrite(msgText.data(),1,msgText.length(),g_warnFile);
      if (g_warnFile != stderr && !Config_getBool(QUIET))
      {
        // cannot use `msg` due to the mutex
        fprintf(stdout,"See '%s' for the reason of termination.\n",qPrint(g_warnlogFile));
      }
    }
    exit(1);
  }
  g_warnStat = true;
}

References Config_getBool, QCString::data(), g_mutex, g_warnBehavior, g_warnFile, g_warnlogFile, g_warnStat, QCString::length(), and qPrint().

Referenced by do_warn(), err_(), and warn_uncond_().

initWarningFormat()

void initWarningFormat

(

)

Definition at line 218 of file message.cpp.

{
  g_warnFormat     = Config_getString(WARN_FORMAT);
  g_warnLineFormat = Config_getString(WARN_LINE_FORMAT);
  g_warnBehavior   = Config_getEnum(WARN_AS_ERROR);
  g_warnlogFile    = Config_getString(WARN_LOGFILE);
  if (g_warnlogFile.isEmpty() && g_warnBehavior == WARN_AS_ERROR_t::FAIL_ON_WARNINGS_PRINT)
  {
    uint32_t pid = Portable::pid();
    g_warnlogFile.sprintf("doxygen_warnings_temp_%d.tmp",pid);
    g_warnlogTemp = true;
  }
 
  if (!g_warnlogFile.isEmpty())
  {
    if (g_warnlogFile == "-")
    {
      g_warnFile = stdout;
    }
    else
    {
      FileInfo fi(g_warnlogFile.str());
      Dir d(fi.dirPath().c_str());
      if (!d.exists() && !d.mkdir(fi.dirPath().c_str()))
      {
        // point it to something valid, because warn() relies on it
        g_warnFile = stderr;
        err("Cannot create directory for '{}', redirecting 'WARN_LOGFILE' output to 'stderr'\n",g_warnlogFile);
      }
      else if (!(g_warnFile = Portable::fopen(g_warnlogFile,"w")))
      {
        // point it to something valid, because warn() relies on it
        g_warnFile = stderr;
        err("Cannot open '{}' for writing, redirecting 'WARN_LOGFILE' output to 'stderr'\n",g_warnlogFile);
      }
    }
  }
  else
  {
    g_warnFile = stderr;
  }
  if (g_warnBehavior != WARN_AS_ERROR_t::NO)
  {
    g_warningStr = g_errorStr;
  }
 
  // make sure the g_warnFile is closed in case we call exit and it is still open
  std::atexit([](){
      if (g_warnFile && g_warnFile!=stderr && g_warnFile!=stdout)
      {
        Portable::fclose(g_warnFile);
        g_warnFile = nullptr;
      }
  });
}

References Config_getEnum, Config_getString, FileInfo::dirPath(), err, Dir::exists(), Portable::fclose(), Portable::fopen(), g_errorStr, g_warnBehavior, g_warnFile, g_warnFormat, g_warningStr, g_warnLineFormat, g_warnlogFile, g_warnlogTemp, Dir::mkdir(), and Portable::pid().

Referenced by checkConfiguration().

msg_()

void msg_	(	fmt::string_view	fmt,
		fmt::format_args	args )

Definition at line 117 of file message.cpp.

{
  if (!Config_getBool(QUIET))
  {
    std::unique_lock<std::mutex> lock(g_mutex);
    if (Debug::isFlagSet(Debug::Time))
    {
      fmt::print("{:.3f} sec: ",(static_cast<double>(Debug::elapsedTime())));
    }
    fmt::print("{}",fmt::vformat(fmt,args));
  }
}

References Config_getBool, Debug::elapsedTime(), g_mutex, Debug::isFlagSet(), and Debug::Time.

Referenced by msg_fmt().

term_()

void term_	(	fmt::string_view	fmt,
		fmt::format_args	args )

Definition at line 174 of file message.cpp.

{
  {
    std::unique_lock<std::mutex> lock(g_mutex);
    fmt::print(g_warnFile, "{}{}", g_errorStr, fmt::vformat(fmt,args));
    if (g_warnFile != stderr)
    {
      size_t l = strlen(g_errorStr);
      for (size_t i=0; i<l; i++) fmt::print(g_warnFile, " ");
      fmt::print(g_warnFile, "{}\n", "Exiting...");
      if (!Config_getBool(QUIET))
      {
        // cannot use `msg` due to the mutex
        fmt::print("See '{}' for the reason of termination.\n",g_warnlogFile);
      }
    }
  }
  exit(1);
}

References Config_getBool, g_errorStr, g_mutex, g_warnFile, and g_warnlogFile.

Referenced by term_fmt().

warn_()

void warn_	(	WarningType	type,
		const QCString &	file,
		int	line,
		fmt::string_view	fmt,
		fmt::format_args	args )

Definition at line 132 of file message.cpp.

{
  bool enabled = false;
  switch (type)
  {
    case WarningType::Generic:       enabled = Config_getBool(WARNINGS);               break;
    case WarningType::Undocumented:  enabled = Config_getBool(WARN_IF_UNDOCUMENTED);   break;
    case WarningType::IncompleteDoc: enabled = Config_getBool(WARN_IF_INCOMPLETE_DOC); break;
    case WarningType::DocError:      enabled = Config_getBool(WARN_IF_DOC_ERROR);      break;
    case WarningType::Layout:        enabled = Config_getBool(WARN_LAYOUT_FILE);       break;
  }
  if (enabled)
  {
    do_warn(file, line, g_warningStr, fmt, args);
  }
}

References Config_getBool, do_warn(), DocError, g_warningStr, Generic, IncompleteDoc, Layout, and Undocumented.

Referenced by warn_fmt().

warn_flush()

void warn_flush

(

)

Definition at line 211 of file message.cpp.

{
  fflush(g_warnFile);
}

References g_warnFile.

Referenced by Statistics::end().

warn_line()

QCString warn_line	(	const QCString &	file,
		int	line )

Definition at line 196 of file message.cpp.

{
  QCString fileSubst = file.isEmpty() ? "<unknown>" : file;
  QCString lineSubst; lineSubst.setNum(line);
  return  substitute(
            substitute(
              g_warnLineFormat,
              "$file",fileSubst
            ),
            "$line",lineSubst
          );
}

References g_warnLineFormat, QCString::isEmpty(), QCString::setNum(), and substitute().

Referenced by addMemberFunction(), checkPageRelations(), computePageRelations(), and findGlobalMember().

warn_uncond_()

void warn_uncond_	(	fmt::string_view	fmt,
		fmt::format_args	args )

Definition at line 151 of file message.cpp.

{
  fmt::print(g_warnFile,"{}{}",g_warningStr,vformat(fmt,args));
  handle_warn_as_error();
}

References g_warnFile, g_warningStr, and handle_warn_as_error().

Referenced by warn_uncond_fmt().

Variable Documentation

g_errorStr

const char* g_errorStr = "error: "

static

Definition at line 33 of file message.cpp.

Referenced by err_(), err_full_(), initWarningFormat(), and term_().

g_mutex

std::mutex g_mutex

static

Definition at line 39 of file message.cpp.

Referenced by format_warn(), handle_warn_as_error(), msg_(), and term_().

g_warnBehavior

WARN_AS_ERROR_t g_warnBehavior = WARN_AS_ERROR_t::NO

static

Definition at line 35 of file message.cpp.

Referenced by finishWarnExit(), format_warn(), handle_warn_as_error(), and initWarningFormat().

g_warnFile

FILE* g_warnFile = stderr

static

Definition at line 34 of file message.cpp.

Referenced by err_(), finishWarnExit(), format_warn(), handle_warn_as_error(), initWarningFormat(), term_(), warn_flush(), and warn_uncond_().

g_warnFormat

QCString g_warnFormat

static

Definition at line 30 of file message.cpp.

Referenced by format_warn(), and initWarningFormat().

g_warningStr

const char* g_warningStr = "warning: "

static

Definition at line 32 of file message.cpp.

Referenced by initWarningFormat(), warn_(), and warn_uncond_().

g_warnLineFormat

QCString g_warnLineFormat

static

Definition at line 31 of file message.cpp.

Referenced by initWarningFormat(), and warn_line().

g_warnlogFile

QCString g_warnlogFile

static

Definition at line 36 of file message.cpp.

Referenced by finishWarnExit(), format_warn(), handle_warn_as_error(), initWarningFormat(), and term_().

g_warnlogTemp

bool g_warnlogTemp = false

static

Definition at line 37 of file message.cpp.

Referenced by finishWarnExit(), and initWarningFormat().

g_warnStat

std::atomic_bool g_warnStat = false

static

Definition at line 38 of file message.cpp.

Referenced by finishWarnExit(), format_warn(), and handle_warn_as_error().