summaryrefslogtreecommitdiffstats
path: root/src/message.cpp
blob: 8b24e318364496338281c1e676fd806b0b27e19b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
/******************************************************************************
 *
 * 
 *
 * Copyright (C) 1997-2007 by Dimitri van Heesch.
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby 
 * granted. No representations are made about the suitability of this software 
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
 *
 */

#include <stdarg.h>
#include <stdio.h>
#include <qdatetime.h>
#include "config.h"
#include "util.h"
#include "debug.h"
#include "doxygen.h"

static QCString outputFormat;
//static int warnFormatOrder; // 1 = $file,$line,$text
//                            // 2 = $text,$line,$file
//                            // 3 = $line,$text,$file
//                            // 4 = $file,$text,$line
//                            // 5 = $text,$file,$line
//                            // 6 = $line,$file,$text

static FILE *warnFile = stderr;

void initWarningFormat()
{
//  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 = fopen(Config_getString("WARN_LOGFILE"),"w");
  }
  if (!warnFile) // point it to something valid, because warn() relies on it
  {
    warnFile = stderr;
  }
}


void msg(const char *fmt, ...)
{
  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); 
  }
}

static void do_warn(const char *tag, const char *file, int line, const char *fmt, va_list args)
{
  if (!Config_getBool(tag)) return; // warning type disabled
  char text[40960];
  vsprintf(text, fmt, args);
  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
  QCString msgText = 
    substitute(
      substitute(
        substitute(
          substitute(
            substitute( 
              outputFormat,
              "$file",fileSubst
            ),
            "$text",textSubst
          ),
          "$line",lineSubst
        ),
        "$version",versionSubst
      ),
      "%","%%"
    )+'\n';

  // print resulting message
  fprintf(warnFile,msgText);
}

void warn(const char *file,int line,const char *fmt, ...)
{
  va_list args;
  va_start(args, fmt);
  do_warn("WARNINGS", file, line, fmt, args);
  va_end(args); 
}

void warn_cont(const char *fmt, ...)
{
  if (!Config_getBool("WARNINGS"))
    return;
  va_list args;
  va_start(args, fmt);
  vfprintf(warnFile, fmt, args);
  va_end(args); 
}
  
void warn_undoc(const char *file,int line,const char *fmt, ...)
{
  va_list args;
  va_start(args, fmt);
  do_warn("WARN_IF_UNDOCUMENTED", file, line, fmt, args);
  va_end(args);
}
  
void warn_doc_error(const char *file,int line,const char *fmt, ...)
{
  va_list args;
  va_start(args, fmt);
  do_warn("WARN_IF_DOC_ERROR", file, line, fmt, args);
  va_end(args);
}

void err(const char *fmt, ...)
{
  va_list args;
  va_start(args, fmt);
  vfprintf(warnFile, fmt, args);
  va_end(args); 
}
"hl kwd">endMemberList(); void startAnonTypeScope(int) {} void endAnonTypeScope(int) {} void startMemberItem(int); void endMemberItem(); void startMemberTemplateParams() {} void endMemberTemplateParams() {} //void memberGroupSpacing(bool) {} //void memberGroupSeparator() {} void insertMemberAlign(bool) {} void writeRuler() { rtfwriteRuler_thin(); } void writeAnchor(const char *fileName,const char *name); void startCodeFragment(); void endCodeFragment(); //void startPreFragment() { startCodeFragment(); } //void endPreFragment() { endCodeFragment(); } //void startVerbatimFragment() { startCodeFragment(); } //void endVerbatimFragment() { endCodeFragment(); } void writeLineNumber(const char *,const char *,const char *,int l) { t << l << " "; } void startCodeLine() { col=0; } void endCodeLine() { lineBreak(); } //void writeBoldString(const char *text) // { t << "{\\b "; docify(text); t << "}"; } void startEmphasis() { t << "{\\i "; } void endEmphasis() { t << "}"; } void startBold() { t << "{\\b "; } void endBold() { t << "}"; } void startDescription(); void endDescription(); void startDescItem(); void endDescItem(); void lineBreak(); void startMemberDoc(const char *,const char *,const char *,const char *); void endMemberDoc(bool); void startDoxyAnchor(const char *,const char *,const char *,const char *,const char *); void endDoxyAnchor(const char *,const char *); void startCodeAnchor(const char *) {}; void endCodeAnchor() {}; void writeChar(char c); void writeLatexSpacing() {};//{ t << "\\hspace{0.3cm}"; } //void writeLatexLabel(const char *scope,const char *anchor); void writeStartAnnoItem(const char *type,const char *file, const char *path,const char *name); void writeEndAnnoItem(const char *name); void startSubsection(); void endSubsection(); void startSubsubsection(); void endSubsubsection(); void startCenter() { t << "{\\qc" << endl; } void endCenter() { t << "}"; } void startSmall() { t << "{\\sub "; } void endSmall() { t << "}"; } //void startSubscript() { t << "{\\sub " << endl;} //void endSubscript() { t << "}"; } //void startSuperscript() { t << "{\\super " << endl;} //void endSuperscript() { t << "}"; } //void startTable(bool,int); //void endTable(bool); //void startCaption(); //void endCaption(); //void nextTableRow(); //void endTableRow(); //void nextTableColumn(); //void endTableColumn(); //void writeCopyright() { t << "\251"; } //void writeQuote() { t << "\""; } //void writeUmlaut(char c); //void writeAcute(char c); //void writeGrave(char c); //void writeCirc(char c); //void writeTilde(char c); //void writeRing(char c); //void writeSharpS() { t << "\337"; } //void writeCCedil(char c); void startMemberDescription(); void endMemberDescription(); void startDescList(SectionTypes); //void endDescList(); void startSimpleSect(SectionTypes,const char *,const char *,const char *); void endSimpleSect(); void startParamList(ParamListTypes,const char *); void endParamList(); //void endDescTitle(); void writeDescItem(); void startSection(const char *,const char *,SectionInfo::SectionType); void endSection(const char *,SectionInfo::SectionType); //void writeSectionRef(const char *,const char *,const char *,const char *); //void writeSectionRefItem(const char *,const char *,const char *); //void writeSectionRefAnchor(const char *,const char *,const char *); void addIndexItem(const char *,const char *); void startIndent(); void endIndent(); void writeSynopsis() {} //void generateExternalIndex() {} void startClassDiagram(); void endClassDiagram(ClassDiagram &,const char *filename,const char *name); //void startColorFont(uchar,uchar,uchar) {} //void endColorFont() {} void startPageRef(); void endPageRef(const char *,const char *); //void startQuickIndexItem(const char *,const char *) {} //void endQuickIndexItem() {} void writeQuickLinks(bool,HighlightedItem) {} //void writeFormula(const char *,const char *); void writeNonBreakableSpace(int); //void startImage(const char *,const char *,bool); //void endImage(bool); //void startDotFile(const char *,bool); //void endDotFile(bool); void startDescTable(); void endDescTable(); void startDescTableTitle(); void endDescTableTitle(); void startDescTableData(); void endDescTableData(); void startDotGraph(); void endDotGraph(DotClassGraph &); void startInclDepGraph(); void endInclDepGraph(DotInclDepGraph &); void startGroupCollaboration(); void endGroupCollaboration(DotGroupCollaboration &g); void startCallGraph(); void endCallGraph(DotCallGraph &); void startDirDepGraph(); void endDirDepGraph(DotDirDeps &g); void writeGraphicalHierarchy(DotGfxHierarchyTable &) {} void startMemberGroupHeader(bool); void endMemberGroupHeader(); void startMemberGroupDocs(); void endMemberGroupDocs(); void startMemberGroup(); void endMemberGroup(bool); void startTextBlock(bool dense); void endTextBlock(bool); void lastIndexPage(); void startMemberDocPrefixItem() {} void endMemberDocPrefixItem() {} void startMemberDocName(bool) {} void endMemberDocName() {} void startParameterType(bool,const char *) {} void endParameterType() {} void startParameterName(bool) {} void endParameterName(bool,bool,bool) {} void startParameterList(bool) {} void endParameterList() {} void startFontClass(const char *) {} void endFontClass() {} //void startHtmlOnly() {} //void endHtmlOnly() {} //void startLatexOnly() {} //void endLatexOnly() {} //void startSectionRefList() {} //void endSectionRefList() {} void writeCodeAnchor(const char *) {} void linkableSymbol(int,const char *,Definition *,Definition *) {} static bool preProcessFileInplace(const char *path,const char *name); private: RTFGenerator(const RTFGenerator &); RTFGenerator &operator=(const RTFGenerator &); const char *rtf_BList_DepthStyle(); const char *rtf_CList_DepthStyle(); const char *rtf_EList_DepthStyle(); const char *rtf_LCList_DepthStyle(); const char *rtf_DList_DepthStyle(); const char *rtf_Code_DepthStyle(); void incrementIndentLevel(); void decrementIndentLevel(); int col; bool m_bstartedBody; // has startbody been called yet? int m_listLevel; // // RTF does not really have a addative indent...manually set list level. bool m_omitParagraph; // should a the next paragraph command be ignored? int m_numCols; // number of columns in a table QCString relPath; void beginRTFDocument(); void beginRTFChapter(); void beginRTFSection(); void rtfwriteRuler_doubleline(); void rtfwriteRuler_emboss(); void rtfwriteRuler_thick(); void rtfwriteRuler_thin(); void writeRTFReference(const char *label); //char *getMultiByte(int c); }; #endif