#include <stdio.h>
#include <qdatetime.h>
#include "config.h"
#include "util.h"
#include "debug.h"
#include "doxygen.h"
#include "portable.h"
#include "filedef.h"
#include "message.h"

Functions
void	initWarningFormat ()

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

static void	format_warn (const char file, int line, const char text)

static void	do_warn (const char tag, const char file, int line, const char prefix, const char fmt, va_list args)

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

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

void	warn_simple (const char file, int line, const char text)

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

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

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

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

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

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

Variables
static QCString	outputFormat

static const char *	warning_str = "warning: "

static const char *	error_str = "error: "

static FILE *	warnFile = stderr

Function Documentation

static void do_warn	(	const char *	tag,
		const char *	file,
		int	line,
		const char *	prefix,
		const char *	fmt,
		va_list	args
	)

static

Definition at line 167 of file message.cpp.

 {
   if (tag && !Config_getBool(tag)) return; // warning type disabled
   const int bufSize = 40960;
   char text[bufSize];
   int l=0;
   if (prefix)
   {
     qstrncpy(text,prefix,bufSize);
     l=strlen(prefix);
   }
   vsnprintf(text+l, bufSize-l, fmt, args);
   text[bufSize-1]='\0';
   format_warn(file,line,text);
 }

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

Definition at line 226 of file message.cpp.

 {
   va_list args;
   va_start(args, fmt);
   vfprintf(warnFile, (QCString(error_str) + fmt).data(), args);
   va_end(args);
 }

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

Definition at line 234 of file message.cpp.

 {
   va_list args;
   va_start(args, fmt);
   do_warn(NULL, file, line, error_str, fmt, args);
   va_end(args);
 }

static void format_warn	(	const char *	file,
		int	line,
		const char *	text
	)

static

Definition at line 122 of file message.cpp.

 {
   QCString fileSubst = file==0 ? "<unknown>" : file;
   QCString lineSubst; lineSubst.setNum(line);
   QCString textSubst = text;
   QCString versionSubst;
   if (file) // get version from file name
   {
     bool ambig;
     FileDef *fd=findFileDef(Doxygen::inputNameDict,file,ambig);
     if (fd)
     {
       versionSubst = fd->getVersion();
     }
   }
   // substitute markers by actual values
   bool warnAsError = Config_getBool("WARN_AS_ERROR");
   QCString msgText =
       substitute(
         substitute(
           substitute(
             substitute(
               outputFormat,
               "$file",fileSubst
             ),
             "$line",lineSubst
           ),
           "$version",versionSubst
         ),
         "$text",textSubst
       );
   if (warnAsError)
   {
     msgText += " (warning treated as error, aborting now)";
   }
   msgText += '\n';
 
   // print resulting message
   fwrite(msgText.data(),1,msgText.length(),warnFile);
   if (warnAsError)
   {
     exit(1);
   }
 }

void initWarningFormat ( )

Definition at line 38 of file message.cpp.

 {
 //  int filePos = Config_getString("WARN_FORMAT").find("$file");
 //  int linePos = Config_getString("WARN_FORMAT").find("$line");
 //  int textPos = Config_getString("WARN_FORMAT").find("$text");
 //
 //  // sort items on position (there are 6 cases)
 //  warnFormatOrder = 1;
 //  if (filePos>linePos && filePos>textPos)
 //  {
 //    if (linePos>textPos) // $text,$line,$file
 //    {
 //      warnFormatOrder = 2;
 //    }
 //    else                 // $line,$text,$file
 //    {
 //      warnFormatOrder = 3;
 //    }
 //  }
 //  else if (filePos<linePos && filePos<textPos)
 //  {
 //    if (linePos>textPos) // $file,$text,$line
 //    {
 //      warnFormatOrder = 4;
 //    }
 //  }
 //  else if (filePos<linePos && filePos>textPos) // $text,$file,$line
 //  {
 //    warnFormatOrder = 5;
 //  }
 //  else // $line,$file,$text
 //  {
 //    warnFormatOrder = 6;
 //  }
 //  outputFormat =
 //      substitute(
 //        substitute(
 //          substitute(
 //            Config_getString("WARN_FORMAT"),
 //           "$file","%s"
 //          ),
 //          "$text","%s"
 //        ),
 //        "$line","%d"
 //      )+'\n';
 
   //    replace(QRegExp("\\$file"),"%s").
   //    replace(QRegExp("\\$text"),"%s").
   //    replace(QRegExp("\\$line"),"%d")+
   //    '\n';
 
   outputFormat = Config_getString("WARN_FORMAT");
 
   if (!Config_getString("WARN_LOGFILE").isEmpty())
   {
     warnFile = portable_fopen(Config_getString("WARN_LOGFILE"),"w");
   }
   if (!warnFile) // point it to something valid, because warn() relies on it
   {
     warnFile = stderr;
   }
 
   if (Config_getBool("WARN_AS_ERROR"))
   {
     warning_str = error_str;
   }
 }

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

Definition at line 107 of file message.cpp.

 {
   if (!Config_getBool("QUIET"))
   {
     if (Debug::isFlagSet(Debug::Time))
     {
       printf("%.3f sec: ",((double)Doxygen::runningTime.elapsed())/1000.0);
     }
     va_list args;
     va_start(args, fmt);
     vfprintf(stdout, fmt, args);
     va_end(args);
   }
 }

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

Definition at line 242 of file message.cpp.

 {
   const char *enter_txt = "entering";
   const char *enter_txt_uc = "Entering";
 
   if (!enter)
   {
     enter_txt = "finished";
     enter_txt_uc = "Finished";
   }
 
   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));
   }
 }

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

Definition at line 191 of file message.cpp.

 {
   do_warn("WARNINGS", file, line, warning_str, fmt, args);
 }

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

Definition at line 183 of file message.cpp.

 {
   va_list args;
   va_start(args, fmt);
   do_warn("WARNINGS", file, line, warning_str, fmt, args);
   va_end(args);
 }

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

Definition at line 210 of file message.cpp.

 {
   va_list args;
   va_start(args, fmt);
   do_warn("WARN_IF_DOC_ERROR", file, line, warning_str, fmt, args);
   va_end(args);
 }

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

Definition at line 196 of file message.cpp.

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

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

Definition at line 218 of file message.cpp.

 {
   va_list args;
   va_start(args, fmt);
   vfprintf(warnFile, (QCString(warning_str) + fmt).data(), args);
   va_end(args);
 }

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

Definition at line 202 of file message.cpp.

 {
   va_list args;
   va_start(args, fmt);
   do_warn("WARN_IF_UNDOCUMENTED", file, line, warning_str, fmt, args);
   va_end(args);
 }

Variable Documentation

const char* error_str = "error: "

static

Definition at line 28 of file message.cpp.

QCString outputFormat

static

Definition at line 26 of file message.cpp.

FILE* warnFile = stderr

static

Definition at line 36 of file message.cpp.

const char* warning_str = "warning: "

static

Definition at line 27 of file message.cpp.

Functions

Variables

Function Documentation

Variable Documentation