#include <stdio.h>
#include "config.h"
#include "debug.h"
#include "portable.h"
#include "message.h"
#include "doxygen.h"
#include <mutex>

message.cpp 的引用(Include)关系图:

函数
void	initWarningFormat ()

void	msg (const char *fmt,...)

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

static void	handle_warn_as_error ()

static void	do_warn (bool enabled, const QCString &file, int line, const char prefix, const char fmt, va_list args)

void	warn (const QCString &file, int line, const char *fmt,...)

void	va_warn (const QCString &file, int line, const char *fmt, va_list args)

void	warn_simple (const QCString &file, int line, const char *text)

void	warn_undoc (const QCString &file, int line, const char *fmt,...)

void	warn_incomplete_doc (const QCString &file, int line, const char *fmt,...)

void	warn_doc_error (const QCString &file, int line, const char *fmt,...)

void	warn_uncond (const char *fmt,...)

void	err (const char *fmt,...)

void	err_full (const QCString &file, int line, const char *fmt,...)

void	term (const char *fmt,...)

void	warn_flush ()

void	printlex (int dbg, bool enter, const char lexName, const char fileName)

void	finishWarnExit ()

变量
static QCString	g_warnFormat

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 bool	g_warnStat = false

static std::mutex	g_mutex

函数说明

◆ do_warn()

static void do_warn	(	bool	enabled,
		const QCString &	file,
		int	line,
		const char *	prefix,
		const char *	fmt,
		va_list	args
	)

static

在文件 message.cpp 第 122 行定义.

 {
   if (!enabled) return; // warning type disabled
  
   va_list argsCopy;
   va_copy(argsCopy, args);
  
   int l=0;
   if (prefix)
   {
     l=(int)strlen(prefix);
   }
   // determine needed buffersize based on:
   // format + arguments
   // prefix
   // 1 position for `\0`
   int bufSize = vsnprintf(NULL, 0, fmt, args) + l + 1;
   QCString text(bufSize);
   if (prefix)
   {
     qstrncpy(text.rawData(),prefix,bufSize);
   }
   vsnprintf(text.rawData()+l, bufSize-l, fmt, argsCopy);
   text[bufSize-1]='\0';
   format_warn(file,line,text);
  
   va_end(argsCopy);
 }

引用了 format_warn(), qstrncpy() , 以及 QCString::rawData().

被这些函数引用 err_full(), va_warn(), warn(), warn_doc_error(), warn_incomplete_doc() , 以及 warn_undoc().

◆ err()

void err	(	const char *	fmt,
			...
	)

在文件 message.cpp 第 203 行定义.

 {
   va_list args;
   va_start(args, fmt);
   vfprintf(g_warnFile, (QCString(g_errorStr) + fmt).data(), args);
   va_end(args);
   handle_warn_as_error();
 }

引用了 g_errorStr, g_warnFile , 以及 handle_warn_as_error().

◆ err_full()

void err_full	(	const QCString &	file,
		int	line,
		const char *	fmt,
			...
	)

在文件 message.cpp 第 212 行定义.

 {
   va_list args;
   va_start(args, fmt);
   do_warn(TRUE, file, line, g_errorStr, fmt, args);
   va_end(args);
 }

引用了 do_warn(), g_errorStr , 以及 TRUE.

被这些函数引用 NamespaceDefImpl::compoundTypeString(), getMscImageMapFromFile(), DotRunner::run(), runPlantumlContent(), writeDiaGraphFromFile() , 以及 writeMscGraphFromFile().

◆ finishWarnExit()

void finishWarnExit ( )

在文件 message.cpp 第 271 行定义.

 {
   if (g_warnStat && g_warnBehavior == WARN_AS_ERROR_t::FAIL_ON_WARNINGS)
   {
     exit(1);
   }
 }

引用了 g_warnBehavior , 以及 g_warnStat.

被这些函数引用 generateOutput().

◆ format_warn()

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

static

在文件 message.cpp 第 69 行定义.

 {
   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)
   {
     exit(1);
   }
   g_warnStat = true;
 }

引用了 QCString::data(), g_mutex, g_warnBehavior, g_warnFile, g_warnFormat, g_warnStat, QCString::isEmpty(), QCString::length(), QCString::setNum() , 以及 substitute().

被这些函数引用 do_warn() , 以及 warn_simple().

◆ handle_warn_as_error()

static void handle_warn_as_error ( )

static

在文件 message.cpp 第 108 行定义.

 {
   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);
     }
     exit(1);
   }
   g_warnStat = true;
 }

引用了 QCString::data(), g_mutex, g_warnBehavior, g_warnFile, g_warnStat , 以及 QCString::length().

被这些函数引用 err() , 以及 warn_uncond().

◆ initWarningFormat()

void initWarningFormat ( )

在文件 message.cpp 第 34 行定义.

 {
   g_warnFormat = Config_getString(WARN_FORMAT);
   if (!Config_getString(WARN_LOGFILE).isEmpty())
   {
     g_warnFile = Portable::fopen(Config_getString(WARN_LOGFILE).data(),"w");
   }
   if (!g_warnFile) // point it to something valid, because warn() relies on it
   {
     g_warnFile = stderr;
   }
   g_warnBehavior = Config_getEnum(WARN_AS_ERROR);
   if (g_warnBehavior != WARN_AS_ERROR_t::NO)
   {
     g_warningStr = g_errorStr;
   }
 }

引用了 Config_getEnum, Config_getString, Portable::fopen(), g_errorStr, g_warnBehavior, g_warnFile, g_warnFormat , 以及 g_warningStr.

被这些函数引用 checkConfiguration().

◆ msg()

void msg	(	const char *	fmt,
			...
	)

在文件 message.cpp 第 53 行定义.

 {
   if (!Config_getBool(QUIET))
   {
     std::unique_lock<std::mutex> lock(g_mutex);
     if (Debug::isFlagSet(Debug::Time))
     {
       printf("%.3f sec: ",((double)Debug::elapsedTime()));
     }
     va_list args;
     va_start(args, fmt);
     vfprintf(stdout, fmt, args);
     va_end(args);
   }
 }

引用了 Config_getBool, Debug::elapsedTime(), g_mutex, Debug::isFlagSet() , 以及 Debug::Time.

被这些函数引用 MemberDefImpl::_writeCallerGraph(), MemberDefImpl::_writeCallGraph(), FileDefImpl::acquireFileVersion(), adjustConfiguration(), Statistics::begin(), RTFGenerator::beginRTFDocument(), devUsage(), TagFileParser::dump(), LayoutParser::error(), TagFileParser::error(), exitDoxygen(), generateClassList(), generateConceptDocs(), generateConfigFile(), generateExampleDocs(), generateFileDocs(), generateFileSources(), FormulaManager::generateImages(), generateNamespaceClassDocs(), generateNamespaceConceptDocs(), generateNamespaceDocs(), generateOutput(), generatePageDocs(), generateXML(), generateXMLForClass(), LayoutDocManager::init(), loadExtensions(), loadStylesheet(), LayoutDocManager::parse(), parseFile(), parseFilesMultiThreading(), parseInput(), parseTagFile(), Statistics::print(), Debug::printFlags(), printNavTree(), readConfiguration(), readDir(), FormulaManager::readFormulas(), readTagFile(), TemplateNodeExtend::render(), DotManager::run(), runPlantumlContent(), stopDoxygen(), LayoutNavEntry::url(), usage(), version(), DirDefImpl::writeDirectoryGraph(), ClassDefImpl::writeDocumentationForInnerClasses(), GroupDefImpl::writeGroupGraph() , 以及 writeIndexHierarchyEntries().

◆ printlex()

void printlex	(	int	dbg,
		bool	enter,
		const char *	lexName,
		const char *	fileName
	)

在文件 message.cpp 第 243 行定义.

 {
   const char *enter_txt = "entering";
   const char *enter_txt_uc = "Entering";
  
   if (!enter)
   {
     enter_txt = "finished";
     enter_txt_uc = "Finished";
   }
  
   std::unique_lock<std::mutex> lock(g_mutex);
   if (dbg)
   {
     if (fileName)
       fprintf(stderr,"--%s lexical analyzer: %s (for: %s)\n",enter_txt, qPrint(lexName), qPrint(fileName));
     else
       fprintf(stderr,"--%s lexical analyzer: %s\n",enter_txt, qPrint(lexName));
   }
   else
   {
     if (fileName)
       Debug::print(Debug::Lex,0,"%s lexical analyzer: %s (for: %s)\n",enter_txt_uc, qPrint(lexName), qPrint(fileName));
     else
       Debug::print(Debug::Lex,0,"%s lexical analyzer: %s\n",enter_txt_uc, qPrint(lexName));
   }
 }

引用了 g_mutex, Debug::Lex, Debug::print() , 以及 qPrint().

◆ term()

void term	(	const char *	fmt,
			...
	)

在文件 message.cpp 第 220 行定义.

 {
   {
     std::unique_lock<std::mutex> lock(g_mutex);
     va_list args;
     va_start(args, fmt);
     vfprintf(g_warnFile, (QCString(g_errorStr) + fmt).data(), args);
     va_end(args);
     if (g_warnFile != stderr)
     {
       for (int i = 0; i < (int)strlen(g_errorStr); i++) fprintf(g_warnFile, " ");
       fprintf(g_warnFile, "%s\n", "Exiting...");
     }
   }
   exit(1);
 }

引用了 g_errorStr, g_mutex , 以及 g_warnFile.

被这些函数引用 checkPageRelations(), compareDoxyfile(), computePageRelations(), createSubDirs(), Qhp::finalize(), generateConfigFile(), FormulaManager::generateImages(), generateOutput(), RTFGenerator::init(), ManGenerator::init(), HtmlGenerator::init(), LatexGenerator::init(), DocbookGenerator::init(), EclipseHelp::initialize(), HtmlHelp::initialize(), DotGraph::prepareDotFile(), FormulaManager::readFormulas(), OutputGenerator::startPlainFile(), transcodeCharacterBuffer(), writeDotGraphFromFile(), writeDotImageMapFromFile(), ClassDiagram::writeFigure(), DotGfxHierarchyTable::writeGraph(), writeLatexMakefile() , 以及 writeMakeBat().

◆ va_warn()

void va_warn	(	const QCString &	file,
		int	line,
		const char *	fmt,
		va_list	args
	)

在文件 message.cpp 第 159 行定义.

 {
   do_warn(Config_getBool(WARNINGS), file, line, g_warningStr, fmt, args);
 }

引用了 Config_getBool, do_warn() , 以及 g_warningStr.

被这些函数引用 TemplateContextImpl::warn() , 以及 TemplateParser::warn().

◆ warn()

void warn	(	const QCString &	file,
		int	line,
		const char *	fmt,
			...
	)

在文件 message.cpp 第 151 行定义.

 {
   va_list args;
   va_start(args, fmt);
   do_warn(Config_getBool(WARNINGS), file, line, g_warningStr, fmt, args);
   va_end(args);
 }

引用了 Config_getBool, do_warn() , 以及 g_warningStr.

被这些函数引用 addGroupToGroups(), addIncludeFile(), addMemberDocs(), addMemberToGroups(), addRelatedPage(), buildExampleList(), buildFileList(), buildGroupListFiltered(), DocGroup::close(), DocGroup::enterCompound(), LayoutParser::error(), findClassRelation(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findGlobalMember(), findMainPage(), findMember(), getConvertLatexMacro(), ExpressionParser::getNextToken(), MemberDefImpl::getOutputFileBase(), DocPara::handleCommand(), vhdl::parser::VhdlErrorHandler::handleOtherError(), vhdl::parser::VhdlErrorHandler::handleParseError(), vhdl::parser::VhdlErrorHandler::handleUnexpectedToken(), ClassDefImpl::internalInsertMember(), DocGroup::leaveFile(), vhdl::parser::VhdlTokenManagerErrorHandler::lexicalError(), loadExtensions(), loadStylesheet(), CondParser::parse(), ExpressionParser::parseNotExpression(), ExpressionParser::parsePrimaryExpression(), TemplateEngine::Private::printIncludeContext(), resolveClassNestingRelations(), LayoutParser::startElement(), LayoutParser::startNavEntry(), TemplateLexer::tokenize(), MemberDefImpl::virtualness(), writeDirTreeNode(), writeExceptionListImpl() , 以及 writeGroupTreeNode().

◆ warn_doc_error()

void warn_doc_error	(	const QCString &	file,
		int	line,
		const char *	fmt,
			...
	)

在文件 message.cpp 第 186 行定义.

 {
   va_list args;
   va_start(args, fmt);
   do_warn(Config_getBool(WARN_IF_DOC_ERROR), file, line, g_warningStr, fmt, args);
   va_end(args);
 }

引用了 Config_getBool, do_warn() , 以及 g_warningStr.

被这些函数引用 DocParser::checkArgumentName(), DocParser::checkRetvalName(), DocParser::checkUnOrMultipleDocumentedParams(), DocParser::defaultHandleTitleAndSize(), DocParser::defaultHandleToken(), MemberDefImpl::detectUndocumentedParams(), DocAnchor::DocAnchor(), DocCite::DocCite(), DocEmoji::DocEmoji(), DocFormula::DocFormula(), DocHtmlCaption::DocHtmlCaption(), DocLink::DocLink(), DocRef::DocRef(), DocParser::errorHandleDefaultToken(), DocParser::findAndCopyImage(), DocParser::handleAHref(), DocParser::handleAnchor(), DocPara::handleCite(), DocPara::handleCommand(), DocPara::handleEmoji(), DocPara::handleFile(), DocPara::handleHtmlEndTag(), DocPara::handleHtmlStartTag(), DocPara::handleIline(), DocPara::handleImage(), DocParser::handleImg(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocParser::handleInternalRef(), DocPara::handleLink(), DocParser::handleLinkedWord(), DocPara::handleRef(), DocPara::handleSection(), DocPara::handleStartCode(), DocParser::handleStyleArgument(), DocParser::handleStyleLeave(), DocParser::handleUnclosedStyleCommands(), DocInclude::parse(), DocIncOperator::parse(), DocIndexEntry::parse(), DocDotFile::parse(), DocMscFile::parse(), DocDiaFile::parse(), DocLink::parse(), DocHRef::parse(), DocHtmlHeader::parse(), DocHtmlDescTitle::parse(), DocHtmlDescList::parse(), DocSection::parse(), DocSecRefItem::parse(), DocSecRefList::parse(), DocInternal::parse(), DocHtmlList::parse(), DocPara::parse(), DocParamList::parse(), DocHtmlCaption::parse(), DocHtmlRow::parse(), DocHtmlTable::parse(), DocText::parse(), DocRoot::parse(), DocHtmlList::parseXml(), DocParamList::parseXml(), DocHtmlRow::parseXml(), DocParser::processCopyDoc(), DocParser::readTextFileByName() , 以及 MemberDefImpl::warnIfUndocumentedParams().

◆ warn_flush()

void warn_flush ( )

在文件 message.cpp 第 237 行定义.

 {
   fflush(g_warnFile);
 }

引用了 g_warnFile.

被这些函数引用 generateOutput().

◆ warn_incomplete_doc()

void warn_incomplete_doc	(	const QCString &	file,
		int	line,
		const char *	fmt,
			...
	)

在文件 message.cpp 第 178 行定义.

 {
   va_list args;
   va_start(args, fmt);
   do_warn(Config_getBool(WARN_IF_INCOMPLETE_DOC), file, line, g_warningStr, fmt, args);
   va_end(args);
 }

引用了 Config_getBool, do_warn() , 以及 g_warningStr.

被这些函数引用 DocParser::checkUnOrMultipleDocumentedParams().

◆ warn_simple()

void warn_simple	(	const QCString &	file,
		int	line,
		const char *	text
	)

在文件 message.cpp 第 164 行定义.

 {
   if (!Config_getBool(WARNINGS)) return; // warning type disabled
   format_warn(file,line,QCString(g_warningStr) + text);
 }

引用了 Config_getBool, format_warn() , 以及 g_warningStr.

被这些函数引用 addMemberFunction().

◆ warn_uncond()

void warn_uncond	(	const char *	fmt,
			...
	)

在文件 message.cpp 第 194 行定义.

 {
   va_list args;
   va_start(args, fmt);
   vfprintf(g_warnFile, (QCString(g_warningStr) + fmt).data(), args);
   va_end(args);
   handle_warn_as_error();
 }

引用了 g_warnFile, g_warningStr , 以及 handle_warn_as_error().

被这些函数引用 MemberDefImpl::_writeCallerGraph(), MemberDefImpl::_writeCallGraph(), getCurrentDateTime(), getResolvedNamespace(), minClassDistance(), parseInput(), readDir(), readFileOrDirectory(), FormulaManager::readFormulas(), HtmlEntityMapper::validate(), FileDefImpl::writeIncludedByGraph(), FileDefImpl::writeIncludeGraph() , 以及 ClassDefImpl::writeInheritanceGraph().

◆ warn_undoc()

void warn_undoc	(	const QCString &	file,
		int	line,
		const char *	fmt,
			...
	)

在文件 message.cpp 第 170 行定义.

 {
   va_list args;
   va_start(args, fmt);
   do_warn(Config_getBool(WARN_IF_UNDOCUMENTED), file, line, g_warningStr, fmt, args);
   va_end(args);
 }