message.h File Reference

#include <fmt/core.h>
#include <fmt/compile.h>
#include "types.h"
#include "qcstring.h"

Include dependency graph for message.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	fmt::formatter< T >
struct	fmt::formatter< QCString >
	adds support for formatting QCString More...
struct	fmt::formatter< Protection >
	adds support for formatting Protected More...
struct	fmt::formatter< Specifier >
	adds support for formatting Specifier More...
struct	fmt::formatter< MethodTypes >
	adds support for formatting MethodTypes More...
struct	fmt::formatter< RelatesType >
	adds support for formatting RelatesType More...
struct	fmt::formatter< Relationship >
	adds support for formatting RelationShip More...
struct	fmt::formatter< SrcLangExt >
	adds support for formatting SrcLangExt More...
struct	fmt::formatter< MemberType >
	adds support for formatting MemberType More...
struct	fmt::formatter< TypeSpecifier >
	adds support for formatting TypeSpecifier More...
struct	fmt::formatter< EntryType >
	adds support for formatting EntryType More...
struct	fmt::formatter< MemberListType >
	adds support for formatting MemberListType More...

Namespaces
namespace	fmt

Macros
#define	msg_no_newline_allowed(x)
#define	msg_newline_required(x)
#define	msg(fmt, ...)
#define	warn(file, line, fmt, ...)
#define	warn_undoc(file, line, fmt, ...)
#define	warn_incomplete_doc(file, line, fmt, ...)
#define	warn_doc_error(file, line, fmt, ...)
#define	warn_layout(file, line, fmt, ...)
#define	warn_uncond(fmt, ...)
#define	err(fmt, ...)
#define	err_full(file, line, fmt, ...)
#define	term(fmt, ...)

Enumerations
enum class	WarningType {   Generic , Undocumented , IncompleteDoc , DocError ,   Layout }

Functions
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	initWarningFormat ()
void	warn_flush ()
void	finishWarnExit ()
template<typename ... Args>
void	err_fmt (fmt::format_string< Args... > fmt, Args &&... args)
template<typename ... Args>
void	err_full_fmt (const QCString &file, int line, fmt::format_string< Args... > fmt, Args &&... args)
template<typename ... Args>
void	term_fmt (fmt::format_string< Args... > fmt, Args &&... args)
template<typename ... Args>
void	msg_fmt (fmt::format_string< Args... > fmt, Args &&... args)
template<typename ... Args>
void	warn_fmt (WarningType type, const QCString &file, int line, fmt::format_string< Args... > fmt, Args &&... args)
template<typename ... Args>
void	warn_uncond_fmt (fmt::format_string< Args... > fmt, Args &&... args)
template<std::size_t N>
constexpr bool	has_newline_at_end (const char(&str)[N])

Macro Definition Documentation

err

#define err	(		fmt,
			... )

Value:

    do {                   \
    msg_newline_required(fmt);              \
    err_fmt(FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Definition at line 127 of file message.h.

#define err(fmt,...) do {                   \
    msg_newline_required(fmt);              \
    err_fmt(FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Referenced by MemberDefImpl::_writeReimplements(), FileDefImpl::acquireFileVersion(), DefinitionImpl::addInnerCompound(), addValidAliasToMap(), adjustBoolSetting(), adjustColorStyleSetting(), adjustConfiguration(), adjustStringSetting(), RTFGenerator::beginRTFDocument(), bindIntParameter(), bindTextParameter(), Config::checkAndCorrect(), checkFileName(), checkList(), checkPngResult(), classInheritedProtectionLevel(), convertMapFile(), DotFilePatcher::convertMapFile(), copyExtraFiles(), copyFile(), copyIcon(), copyLatexStyleSheet(), copyLogo(), ResourceMgr::copyResourceAs(), copyStyleSheet(), MemberList::countDecMembers(), createCroppedEPS(), createCroppedPDF(), createDVIFile(), createEPSbboxFile(), PerlModGenerator::createOutputDir(), PerlModGenerator::createOutputFile(), createPNG(), createPostscriptFile(), HtmlHelp::Private::createProjectFile(), DotManager::createRunner(), FlowChart::createSVG(), createSVGFromPDF(), createSVGFromPDFviaInkscape(), RTFGenerator::decIndentLevel(), NamespaceLinkedRefMap::declVisible(), elemIsVisible(), Htags::execute(), extractBoundingBox(), fileToString(), DocParser::findAndCopyImage(), FlowChart::findLabel(), finishWarnExit(), generateDEF(), generateFormula(), generateOutput(), CitationManager::generatePage(), generateSqlite3(), generateXML(), generateXMLForClass(), generateXMLForConcept(), generateXMLForDir(), generateXMLForFile(), generateXMLForGroup(), generateXMLForModule(), generateXMLForNamespace(), generateXMLForPage(), FilterCache::getFileContentsPipe(), DocPara::handleShowDate(), hasNonReferenceNestedGroupRec(), hasNonReferenceNestedNamespaceRec(), hasNonReferenceSuperClassRec(), LatexDocVisitor::incIndentLevel(), RTFDocVisitor::incIndentLevel(), RTFGenerator::incIndentLevel(), RTFGenerator::init(), initializeTables(), initializeViews(), initWarningFormat(), CitationManager::insertCrossReferencesForBibFile(), FileDefImpl::insertMember(), GroupDefImpl::insertMember(), NamespaceDefImpl::insertMember(), ClassDefImpl::internalInsertMember(), ClassDefImpl::isBaseClass(), ClassDefImpl::isSubClass(), VhdlDocGen::isSubClass(), loadExtensions(), Htags::loadFilemap(), loadStylesheet(), openDbConnection(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), PerlModDocVisitor::operator()(), PerlModDocVisitor::operator()(), PerlModDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), TextDocVisitor::operator()(), XmlDocVisitor::operator()(), DotGraph::prepareDotFile(), prepareStatement(), preProcessFile(), RTFGenerator::preProcessFileInplace(), DotRunner::readBoundingBox(), readCodeFragment(), readConfiguration(), readInputFile(), readTagFile(), readTextFileByName(), FileDefImpl::removeMember(), GroupDefImpl::removeMember(), resetPDFSize(), DotFilePatcher::run(), runHtmlHelpCompiler(), runQHelpGenerator(), StyleData::setStyle(), showDate(), SysTimeKeeper::stop(), testRTFOutput(), updateEPSBoundingBox(), updateLanguageMapping(), SearchIndexExternal::write(), ResourceMgr::writeCategory(), writeCombineScript(), MemberDefImpl::writeDeclaration(), writeDefaultLayoutFile(), FileDefImpl::writeDetailedDescription(), writeDiaGraphFromFile(), ConceptDefImpl::writeDocumentation(), DirDefImpl::writeDocumentation(), FileDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), MemberList::writeDocumentation(), ModuleDefImpl::writeDocumentation(), NamespaceDefImpl::writeDocumentation(), ClassDefImpl::writeDocumentationContents(), HtmlGenerator::writeExternalSearchPage(), ClassDiagram::writeFigure(), FlowChart::writeFlowChart(), writeJavasScriptSearchDataPage(), MemberList::writePlainDeclarations(), HtmlGenerator::writeSearchPage(), DefinitionImpl::writeSourceDef(), HtmlGenerator::writeStyleInfo(), and writeTagFile().

err_full

#define err_full	(		file,
			line,
			fmt,
			... )

Value:

    do {                   \
    msg_no_newline_allowed(fmt);                             \
    err_full_fmt(file,line,FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Definition at line 132 of file message.h.

#define err_full(file,line,fmt,...) do {                   \
    msg_no_newline_allowed(fmt);                             \
    err_full_fmt(file,line,FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Referenced by NamespaceDefImpl::compoundTypeString(), do_mscgen_generate(), DotRunner::run(), runPlantumlContent(), writeDiaGraphFromFile(), and writeMscGraphFromFile().

msg

#define msg	(		fmt,
			... )

Value:

  msg_fmt(FMT_STRING(fmt),##__VA_ARGS__)

Definition at line 94 of file message.h.

#define msg(fmt,...)                      \
  msg_fmt(FMT_STRING(fmt),##__VA_ARGS__)

Referenced by MemberDefImpl::_writeCallerGraph(), MemberDefImpl::_writeCallGraph(), FileDefImpl::acquireFileVersion(), adjustConfiguration(), Statistics::begin(), checkAndUpdatePath(), devUsage(), anonymous_namespace{tagreader.cpp}::TagFileParser::error(), LayoutParser::error(), exitDoxygen(), format_warn(), generateConceptDocs(), generateConfigFile(), generateDocsForClassList(), generateExampleDocs(), generateFileDocs(), generateFileSources(), generateFormula(), generateNamespaceClassDocs(), generateNamespaceConceptDocs(), generateNamespaceDocs(), generateOutput(), generatePageDocs(), generateSqlite3(), generateXML(), generateXMLForClass(), LayoutDocManager::init(), FormulaManager::initFromRepository(), initializeTables(), initializeViews(), loadExtensions(), loadStylesheet(), LayoutDocManager::parse(), XMLParser::parse(), parseFile(), parseFilesMultiThreading(), parseInput(), VHDLOutlineParser::parseInput(), parseMain(), parseMain(), parseMain(), parseMain(), parseTagFile(), Statistics::print(), Debug::printFlags(), processData(), readDir(), readIncludeFile(), readTagFile(), reportError(), DotManager::run(), runPlantumlContent(), AutoTrace::setExit(), setTranslator(), stopDoxygen(), LayoutNavEntry::url(), usage(), version(), DirDefImpl::writeDirectoryGraph(), ClassDefImpl::writeDocumentationForInnerClasses(), GroupDefImpl::writeGroupGraph(), writeIndex(), and writeIndexHierarchyEntries().

msg_newline_required

#define msg_newline_required

(

x

)

Value:

   static_assert(has_newline_at_end(x),"text: \"" x "\" should have \\n at end");

Definition at line 91 of file message.h.

#define msg_newline_required(x) \
   static_assert(has_newline_at_end(x),"text: \"" x "\" should have \\n at end");

msg_no_newline_allowed

#define msg_no_newline_allowed

(

x

)

Value:

   static_assert(!has_newline_at_end(x),"text: \"" x "\" should not have \\n at end");

Definition at line 88 of file message.h.

#define msg_no_newline_allowed(x) \
   static_assert(!has_newline_at_end(x),"text: \"" x "\" should not have \\n at end");

term

#define term	(		fmt,
			... )

Value:

    do {                   \
    msg_newline_required(fmt);               \
    term_fmt(FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Definition at line 137 of file message.h.

#define term(fmt,...) do {                   \
    msg_newline_required(fmt);               \
    term_fmt(FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Referenced by SearchIndexInfo::add(), Qhp::addContentsItem(), addTillEndOfString(), adjustConfiguration(), checkPageRelations(), compareDoxyfile(), computePageRelations(), createOutputDirectory(), createSubDirs(), generateConfigFile(), FormulaManager::generateImages(), generateOutput(), DocbookGenerator::init(), HtmlGenerator::init(), LatexGenerator::init(), ManGenerator::init(), RTFGenerator::init(), Crawlmap::initialize(), DocSets::initialize(), EclipseHelp::initialize(), HtmlHelp::initialize(), HtmlHelpRecoder::initialize(), Qhp::initialize(), Sitemap::initialize(), parseInput(), DotGraph::prepareDotFile(), processUntilMatchingTerminator(), OutputGenerator::startPlainFile(), transcodeCharacterBuffer(), writeDotGraphFromFile(), writeDotImageMapFromFile(), ClassDiagram::writeFigure(), DotGfxHierarchyTable::writeGraph(), writeJavasScriptSearchDataPage(), writeLatexMakefile(), and writeMakeBat().

warn

#define warn	(		file,
			line,
			fmt,
			... )

Value:

    do {                                        \
    msg_no_newline_allowed(fmt);                                            \
    warn_fmt(WarningType::Generic,file,line,FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Definition at line 97 of file message.h.

#define warn(file,line,fmt,...) do {                                        \
    msg_no_newline_allowed(fmt);                                            \
    warn_fmt(WarningType::Generic,file,line,FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Referenced by addAnchor(), addClassToGroups(), addConceptToGroups(), addDirToGroups(), ModuleManager::addDocs(), addExampleToGroups(), addGroupToGroups(), addIncludeFile(), addMemberDocs(), addMemberFunction(), addMemberToGroups(), addModuleToGroups(), addNamespaceToGroups(), addRelatedPage(), addSection(), addXRefItem(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildInterfaceAndServiceList(), checkBlocks(), checkFormula(), DocGroup::close(), convertCppComments(), decrLevel(), endCondSection(), endCondSection(), DocGroup::enterCompound(), anonymous_namespace{tagreader.cpp}::TagFileParser::error(), Markdown::Private::extractTitleId(), findClassRelation(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findGlobalMember(), findMainPage(), findMember(), getConvertLatexMacro(), MemberDefImpl::getOutputFileBase(), DocPara::handleCommand(), DocPara::handleDoxyConfig(), handleElse(), handleElseIf(), handleEndIf(), handleEndParBlock(), handleExample(), handleFileInfoResult(), handleInheritanceGraph(), handleMemberOf(), vhdl::parser::VhdlErrorHandler::handleOtherError(), handleParBlock(), vhdl::parser::VhdlErrorHandler::handleParseError(), handleRelated(), handleRelatedAlso(), handleSubpage(), handleToc(), vhdl::parser::VhdlErrorHandler::handleUnexpectedToken(), CitationManager::insertCrossReferencesForBibFile(), ClassDefImpl::internalInsertMember(), DocGroup::leaveFile(), vhdl::parser::VhdlTokenManagerErrorHandler::lexicalError(), vhdl::parser::VhdlTokenManagerErrorHandler::lexicalError(), loadExtensions(), loadStylesheet(), otherCaseDone(), CondParser::parse(), CommentScanner::parseCommentBlock(), parseIncludeOptions(), parseMain(), parsePrototype(), parsePrototype(), pop_state(), pop_state(), pop_state(), Preprocessor::processFile(), processSection(), readIncludeFile(), resolveClassNestingRelations(), subrHandleCommentBlock(), tryAddEnumDocsToGroupMember(), MemberDefImpl::virtualness(), MemberDefImpl::warnIfUndocumented(), writeDirTreeNode(), writeExceptionListImpl(), and writeGroupTreeNode().

warn_doc_error

#define warn_doc_error	(		file,
			line,
			fmt,
			... )

Value:

    do {                               \
    msg_no_newline_allowed(fmt);                                             \
    warn_fmt(WarningType::DocError,file,line,FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Definition at line 112 of file message.h.

#define warn_doc_error(file,line,fmt,...) do {                               \
    msg_no_newline_allowed(fmt);                                             \
    warn_fmt(WarningType::DocError,file,line,FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Referenced by DocParser::checkArgumentName(), DocParser::checkRetvalName(), DocParser::checkUnOrMultipleDocumentedParams(), DocParser::defaultHandleToken(), DocAnchor::DocAnchor(), DocCite::DocCite(), DocEmoji::DocEmoji(), DocFormula::DocFormula(), DocHtmlCaption::DocHtmlCaption(), DocRef::DocRef(), DocParser::errorHandleDefaultToken(), DocParser::findAndCopyImage(), DocParser::handleAHref(), DocParser::handleAnchor(), DocPara::handleCite(), DocPara::handleCommand(), DocPara::handleDoxyConfig(), DocPara::handleEmoji(), DocPara::handleFile(), DocPara::handleHtmlEndTag(), DocPara::handleHtmlStartTag(), DocPara::handleIFile(), DocPara::handleILine(), DocParser::handleImage(), DocParser::handleImg(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocParser::handleInternalRef(), DocPara::handleLink(), DocParser::handleLinkedWord(), DocParser::handlePrefix(), DocPara::handleRef(), DocPara::handleSection(), DocPara::handleShowDate(), DocPara::handleStartCode(), DocParser::handleStyleArgument(), DocParser::handleStyleLeave(), DocParser::handleUnclosedStyleCommands(), DocDiaFile::parse(), DocDotFile::parse(), DocHRef::parse(), DocHtmlBlockQuote::parse(), DocHtmlCaption::parse(), DocHtmlDescList::parse(), DocHtmlDescTitle::parse(), DocHtmlDetails::parse(), DocHtmlHeader::parse(), DocHtmlList::parse(), DocHtmlRow::parse(), DocHtmlSummary::parse(), DocHtmlTable::parse(), DocInclude::parse(), DocIncOperator::parse(), DocIndexEntry::parse(), DocInternal::parse(), DocLink::parse(), DocMscFile::parse(), DocPara::parse(), DocParamList::parse(), DocPlantUmlFile::parse(), DocRef::parse(), DocRoot::parse(), DocSecRefItem::parse(), DocSecRefList::parse(), DocSection::parse(), DocText::parse(), DocHtmlList::parseXml(), DocHtmlRow::parseXml(), DocParamList::parseXml(), DocParser::processCopyDoc(), readIncludeFile(), DocParser::readTextFileByName(), and MemberDefImpl::warnIfUndocumentedParams().

warn_incomplete_doc

#define warn_incomplete_doc	(		file,
			line,
			fmt,
			... )

Value:

    do {                               \
    msg_no_newline_allowed(fmt);                                                  \
    warn_fmt(WarningType::IncompleteDoc,file,line,FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Definition at line 107 of file message.h.

#define warn_incomplete_doc(file,line,fmt,...) do {                               \
    msg_no_newline_allowed(fmt);                                                  \
    warn_fmt(WarningType::IncompleteDoc,file,line,FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Referenced by DocParser::checkUnOrMultipleDocumentedParams().

warn_layout

#define warn_layout	(		file,
			line,
			fmt,
			... )

Value:

    do {                               \
    msg_no_newline_allowed(fmt);                                             \
    warn_fmt(WarningType::Layout,file,line,FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Definition at line 117 of file message.h.

#define warn_layout(file,line,fmt,...) do {                               \
    msg_no_newline_allowed(fmt);                                             \
    warn_fmt(WarningType::Layout,file,line,FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Referenced by LayoutParser::error(), mergeDocEntryLists(), LayoutParser::startElement(), and LayoutParser::startNavEntry().

warn_uncond

#define warn_uncond	(		fmt,
			... )

Value:

    do {                   \
    msg_newline_required(fmt);                      \
    warn_uncond_fmt(FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Definition at line 122 of file message.h.

#define warn_uncond(fmt,...) do {                   \
    msg_newline_required(fmt);                      \
    warn_uncond_fmt(FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Referenced by MemberDefImpl::_writeCallerGraph(), MemberDefImpl::_writeCallGraph(), Config::checkAndCorrect(), checkMarkdownMainfile(), computeVerifiedDotPath(), getCurrentDateTime(), FormulaManager::initFromRepository(), minClassDistance(), parseInput(), readDir(), readFileOrDirectory(), searchInputFiles(), Config::updateObsolete(), HtmlEntityMapper::validate(), ClassDefImpl::writeCollaborationGraph(), GroupDefImpl::writeGroupGraph(), FileDefImpl::writeIncludedByGraph(), FileDefImpl::writeIncludeGraph(), and ClassDefImpl::writeInheritanceGraph().

warn_undoc

#define warn_undoc	(		file,
			line,
			fmt,
			... )

Value:

    do {                                       \
    msg_no_newline_allowed(fmt);                                                 \
    warn_fmt(WarningType::Undocumented,file,line,FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Definition at line 102 of file message.h.

#define warn_undoc(file,line,fmt,...) do {                                       \
    msg_no_newline_allowed(fmt);                                                 \
    warn_fmt(WarningType::Undocumented,file,line,FMT_STRING(fmt),##__VA_ARGS__); \
  } while (0)

Referenced by computeClassRelations(), findMember(), MemberDefImpl::warnIfUndocumented(), and warnUndocumentedNamespaces().

Enumeration Type Documentation

WarningType

enum class WarningType

strong

Enumerator
Generic
Undocumented
IncompleteDoc
DocError
Layout

Definition at line 25 of file message.h.

{
  Generic,
  Undocumented,
  IncompleteDoc,
  DocError,
  Layout
};

Function Documentation

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_fmt()

template<typename ... Args>

void err_fmt	(	fmt::format_string< Args... >	fmt,
		Args &&...	args )

Definition at line 46 of file message.h.

{
  err_(fmt,fmt::make_format_args(args...));
}

References err_().

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().

err_full_fmt()

template<typename ... Args>

void err_full_fmt	(	const QCString &	file,
		int	line,
		fmt::format_string< Args... >	fmt,
		Args &&...	args )

Definition at line 52 of file message.h.

{
  err_full_(file,line,fmt,fmt::make_format_args(args...));
}

References err_full_().

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().

has_newline_at_end()

template<std::size_t N>

bool has_newline_at_end ( const char(&) str[N] )

constexpr

Definition at line 83 of file message.h.

{
  return str[N-2]=='\n';
}

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().

msg_fmt()

template<typename ... Args>

void msg_fmt	(	fmt::format_string< Args... >	fmt,
		Args &&...	args )

Definition at line 64 of file message.h.

{
  msg_(fmt,fmt::make_format_args(args...));
}

References msg_().

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().

term_fmt()

template<typename ... Args>

void term_fmt	(	fmt::format_string< Args... >	fmt,
		Args &&...	args )

Definition at line 58 of file message.h.

{
  term_(fmt,fmt::make_format_args(args...));
}

References term_().

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_fmt()

template<typename ... Args>

void warn_fmt	(	WarningType	type,
		const QCString &	file,
		int	line,
		fmt::format_string< Args... >	fmt,
		Args &&...	args )

Definition at line 70 of file message.h.

{
  warn_(type,file,line,fmt,fmt::make_format_args(args...));
}

References warn_().

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().

warn_uncond_fmt()

template<typename ... Args>

void warn_uncond_fmt	(	fmt::format_string< Args... >	fmt,
		Args &&...	args )

Definition at line 76 of file message.h.

{
  warn_uncond_(fmt,fmt::make_format_args(args...));
}

References warn_uncond_().