message.h File Reference

#include <cstdarg>
#include "qcstring.h"
#include "util.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.

Macros
#define	PRINTFLIKE(FORMAT, PARAM)
#define	msg_no_newline_allowed(x)
#define	msg_newline_required(x)
#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_uncond(fmt, ...)
#define	err(fmt, ...)
#define	err_full(file, line, fmt, ...)
#define	term(fmt, ...)

Functions
void	msg (const char *fmt,...) PRINTFLIKE(1
void void	warn_ (const QCString &file, int line, const char *fmt,...) PRINTFLIKE(3
void void void	va_warn (const QCString &file, int line, const char *fmt, va_list args)
void	warn_undoc_ (const QCString &file, int line, const char *fmt,...) PRINTFLIKE(3
void void	warn_incomplete_doc_ (const QCString &file, int line, const char *fmt,...) PRINTFLIKE(3
void void void	warn_doc_error_ (const QCString &file, int line, const char *fmt,...) PRINTFLIKE(3
void void void void	warn_uncond_ (const char *fmt,...) PRINTFLIKE(1
void void void void void	err_ (const char *fmt,...) PRINTFLIKE(1
void void void void void void	err_full_ (const QCString &file, int line, const char *fmt,...) PRINTFLIKE(3
void void void void void void void	term_ (const char *fmt,...) PRINTFLIKE(1
void void void void void void void QCString	warn_line (const QCString &file, int line)
void	initWarningFormat ()
void	warn_flush ()
void	finishWarnExit ()
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,##__VA_ARGS__);     \
   } while(0)

Definition at line 84 of file message.h.

#define err(fmt,...) do {     \
   msg_newline_required(fmt); \
   err_(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_(removeLongPathMarker(file),line,fmt,##__VA_ARGS__); \
   } while(0)

Definition at line 89 of file message.h.

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

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

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 56 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 53 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");

PRINTFLIKE

#define PRINTFLIKE	(		FORMAT,
			PARAM )

Definition at line 26 of file message.h.

Referenced by err_(), err_full_(), msg(), term_(), warn_(), warn_doc_error_(), warn_incomplete_doc_(), warn_uncond_(), and warn_undoc_().

term

#define term	(		fmt,
			... )

Value:

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

Definition at line 94 of file message.h.

#define term(fmt,...) do {    \
   msg_newline_required(fmt); \
   term_(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_(removeLongPathMarker(file),line,fmt,##__VA_ARGS__); \
   } while(0)

Definition at line 59 of file message.h.

#define warn(file,line,fmt,...) do { \
   msg_no_newline_allowed(fmt);      \
   warn_(removeLongPathMarker(file),line,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(), buildGroupListFiltered(), checkBlocks(), checkFormula(), DocGroup::close(), convertCppComments(), decrLevel(), endCondSection(), endCondSection(), DocGroup::enterCompound(), LayoutParser::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(), LayoutParser::startElement(), LayoutParser::startNavEntry(), 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_doc_error_(removeLongPathMarker(file),line,fmt,##__VA_ARGS__); \
   } while(0)

Definition at line 74 of file message.h.

#define warn_doc_error(file,line,fmt,...) do { \
   msg_no_newline_allowed(fmt);                \
   warn_doc_error_(removeLongPathMarker(file),line,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_incomplete_doc_(removeLongPathMarker(file),line,fmt,##__VA_ARGS__); \
   } while(0)

Definition at line 69 of file message.h.

#define warn_incomplete_doc(file,line,fmt,...) do { \
   msg_no_newline_allowed(fmt);                     \
   warn_incomplete_doc_(removeLongPathMarker(file),line,fmt,##__VA_ARGS__); \
   } while(0)

Referenced by DocParser::checkUnOrMultipleDocumentedParams().

warn_uncond

#define warn_uncond	(		fmt,
			... )

Value:

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

Definition at line 79 of file message.h.

#define warn_uncond(fmt,...) do { \
   msg_newline_required(fmt);     \
   warn_uncond_(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_undoc_(removeLongPathMarker(file),line,fmt,##__VA_ARGS__); \
   } while(0)

Definition at line 64 of file message.h.

#define warn_undoc(file,line,fmt,...) do { \
   msg_no_newline_allowed(fmt);            \
   warn_undoc_(removeLongPathMarker(file),line,fmt,##__VA_ARGS__); \
   } while(0)

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

Function Documentation

err_()

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

extern

References err_(), and PRINTFLIKE.

err_full_()

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

extern

References err_full_(), and PRINTFLIKE.

finishWarnExit()

void finishWarnExit ( )

extern

Definition at line 310 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 '%s' for reading\n",g_warnlogFile.data());
    }
    else
    {
      std::string line;
      while (getline(warnFile,line))
      {
        fprintf(stderr,"%s\n",line.c_str());
      }
      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(), and term_().

has_newline_at_end()

template<std::size_t N>

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

constexpr

Definition at line 48 of file message.h.

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

initWarningFormat()

void initWarningFormat

(

)

Definition at line 41 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 '%s', redirecting 'WARN_LOGFILE' output to 'stderr'\n",g_warnlogFile.data());
      }
      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 '%s' for writing, redirecting 'WARN_LOGFILE' output to 'stderr'\n",g_warnlogFile.data());
      }
    }
  }
  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(), and term_().

msg()

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

extern

References PRINTFLIKE.

term_()

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

extern

References finishWarnExit(), initWarningFormat(), PRINTFLIKE, term_(), warn_flush(), and warn_line().

va_warn()

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

extern

Definition at line 225 of file message.cpp.

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

References Config_getBool, do_warn(), and g_warningStr.

Referenced by warn_().

warn_()

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

extern

References PRINTFLIKE, va_warn(), and warn_().

warn_doc_error_()

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

extern

References PRINTFLIKE, and warn_doc_error_().

warn_flush()

void warn_flush

(

)

Definition at line 303 of file message.cpp.

{
  fflush(g_warnFile);
}

References g_warnFile.

Referenced by Statistics::end(), and term_().

warn_incomplete_doc_()

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

extern

References PRINTFLIKE, and warn_incomplete_doc_().

warn_line()

void void void void void void void QCString warn_line ( const QCString & file, int line )

extern

Definition at line 205 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(), findGlobalMember(), and term_().

warn_uncond_()

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

extern

References PRINTFLIKE, and warn_uncond_().

warn_undoc_()

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

extern

References PRINTFLIKE, and warn_undoc_().