Skip to content

Commit 07f0dc3

Browse files
albert-githubalbert-github
committed
Warnings when generating diagrams with LaTeX and HTMLHelp / QHP enabled
When we have an example with dot / msc /plantuml /dia / mermaid / formulas/ class / call graph ... and we have LaTeX / Docbook / rtf enabled and chm and / or qhp we get warnings when we generate the chm / qch file due to files hat were added to the `hhp` / `ghp` file. Same occurs with the extra file specified for latex.
1 parent 89a7906 commit 07f0dc3

26 files changed

Lines changed: 93 additions & 79 deletions

‎src/dia.cpp‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,15 @@
1919
#include "message.h"
2020
#include "util.h"
2121
#include "dir.h"
22+
#include "indexlist.h"
23+
#include "doxygen.h"
2224

2325

2426
static const int maxCmdLine = 40960;
2527

2628
void writeDiaGraphFromFile(const QCString &inFile,const QCString &outDir,
2729
const QCString &outFile,DiaOutputFormat format,
28-
const QCString &srcFile,int srcLine)
30+
const QCString &srcFile,int srcLine,bool toIndex)
2931
{
3032
QCString absOutFile = outDir;
3133
absOutFile+=Portable::pathSeparator();
@@ -80,6 +82,7 @@ void writeDiaGraphFromFile(const QCString &inFile,const QCString &outDir,
8082
Dir().remove(outFile.str()+".eps");
8183
}
8284
}
85+
if (toIndex) Doxygen::indexList->addImageFile(outFile+extension);
8386

8487
error:
8588
Dir::setCurrent(oldDir);

‎src/dia.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ enum class DiaOutputFormat { BITMAP , EPS };
2525

2626
void writeDiaGraphFromFile(const QCString &inFile,const QCString &outDir,
2727
const QCString &outFile,DiaOutputFormat format,
28-
const QCString &srcFile,int srcLine);
28+
const QCString &srcFile,int srcLine,bool toIndex);
2929

3030
#endif
3131

‎src/diagram.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1360,7 +1360,7 @@ void ClassDiagram::writeFigure(TextStream &output,const QCString &path,
13601360

13611361
void ClassDiagram::writeImage(TextStream &t,const QCString &path,
13621362
const QCString &relPath,const QCString &fileName,
1363-
bool generateMap) const
1363+
bool generateMap,bool toIndex) const
13641364
{
13651365
uint32_t baseRows=p->base.computeRows();
13661366
uint32_t superRows=p->super.computeRows();
@@ -1387,6 +1387,6 @@ void ClassDiagram::writeImage(TextStream &t,const QCString &path,
13871387

13881388
#define IMAGE_EXT ".png"
13891389
image.save(QCString(path)+"/"+fileName+IMAGE_EXT);
1390-
Doxygen::indexList->addImageFile(QCString(fileName)+IMAGE_EXT);
1390+
if (toIndex) Doxygen::indexList->addImageFile(QCString(fileName)+IMAGE_EXT);
13911391
}
13921392

‎src/diagram.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ class ClassDiagram
3636
void writeFigure(TextStream &t,const QCString &path,
3737
const QCString &file) const;
3838
void writeImage(TextStream &t,const QCString &path,const QCString &relPath,
39-
const QCString &file,bool generateMap=true) const;
39+
const QCString &file,bool generateMap,bool toIndex) const;
4040
private:
4141
struct Private;
4242
std::unique_ptr<Private> p;

‎src/docbookgen.cpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1005,7 +1005,7 @@ DB_GEN_C
10051005
m_t << " <imagedata width=\"50%\" align=\"center\" valign=\"middle\" scalefit=\"0\" fileref=\""
10061006
<< relPath << fileName << ".png\">" << "</imagedata>\n";
10071007
m_t << " </imageobject>\n";
1008-
d.writeImage(m_t,dir(),relPath,fileName,FALSE);
1008+
d.writeImage(m_t,dir(),relPath,fileName,false,false);
10091009
m_t << " </mediaobject>\n";
10101010
m_t << " </informalfigure>\n";
10111011
m_t << "</para>\n";

‎src/docbookvisitor.cpp‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1560,7 +1560,7 @@ void DocbookDocVisitor::writeMscFile(const QCString &fileName, const DocVerbatim
15601560
DB_VIS_C
15611561
QCString shortName = makeBaseName(fileName,".msc");
15621562
QCString outDir = Config_getString(DOCBOOK_OUTPUT);
1563-
if (newFile) writeMscGraphFromFile(fileName,outDir,shortName,MscOutputFormat::BITMAP,s.srcFile(),s.srcLine());
1563+
if (newFile) writeMscGraphFromFile(fileName,outDir,shortName,MscOutputFormat::BITMAP,s.srcFile(),s.srcLine(),false);
15641564
visitPreStart(m_t, s.children(), s.hasCaption(), s.relPath() + shortName + ".png", s.width(), s.height());
15651565
visitCaption(s.children());
15661566
visitPostEnd(m_t, s.hasCaption());
@@ -1571,7 +1571,7 @@ void DocbookDocVisitor::writePlantUMLFile(const QCString &baseName, const DocVer
15711571
DB_VIS_C
15721572
QCString shortName = stripPath(baseName);
15731573
QCString outDir = Config_getString(DOCBOOK_OUTPUT);
1574-
PlantumlManager::instance().generatePlantUMLOutput(baseName,outDir,PlantumlManager::PUML_BITMAP);
1574+
PlantumlManager::instance().generatePlantUMLOutput(baseName,outDir,PlantumlManager::PUML_BITMAP,false);
15751575
visitPreStart(m_t, s.children(), s.hasCaption(), s.relPath() + shortName + ".png", s.width(),s.height());
15761576
visitCaption(s.children());
15771577
visitPostEnd(m_t, s.hasCaption());
@@ -1597,7 +1597,7 @@ DB_VIS_C
15971597
for (const auto &bName: baseNameVector)
15981598
{
15991599
QCString baseName=makeBaseName(bName,".pu");
1600-
PlantumlManager::instance().generatePlantUMLOutput(baseName,outDir,PlantumlManager::PUML_BITMAP);
1600+
PlantumlManager::instance().generatePlantUMLOutput(baseName,outDir,PlantumlManager::PUML_BITMAP,false);
16011601
if (!first) endPlantUmlFile(hasCaption);
16021602
first = false;
16031603
m_t << "<para>\n";
@@ -1620,7 +1620,7 @@ DB_VIS_C
16201620
if (Config_getBool(MERMAID_RENDER_MODE)==MERMAID_RENDER_MODE_t::CLIENT_SIDE) return;
16211621
QCString shortName = stripPath(baseName);
16221622
QCString outDir = Config_getString(DOCBOOK_OUTPUT);
1623-
MermaidManager::instance().generateMermaidOutput(baseName,outDir,MermaidManager::OutputFormat::Bitmap);
1623+
MermaidManager::instance().generateMermaidOutput(baseName,outDir,MermaidManager::OutputFormat::Bitmap,false);
16241624
visitPreStart(m_t, s.children(), s.hasCaption(), s.relPath() + shortName + ".png", s.width(),s.height());
16251625
visitCaption(s.children());
16261626
visitPostEnd(m_t, s.hasCaption());
@@ -1644,7 +1644,7 @@ DB_VIS_C
16441644
QCString baseName = MermaidManager::instance().writeMermaidSource(outDir,
16451645
QCString(),inBuf,MermaidManager::OutputFormat::Bitmap,srcFile,srcLine);
16461646
QCString shortName = stripPath(baseName);
1647-
MermaidManager::instance().generateMermaidOutput(baseName,outDir,MermaidManager::OutputFormat::Bitmap);
1647+
MermaidManager::instance().generateMermaidOutput(baseName,outDir,MermaidManager::OutputFormat::Bitmap,false);
16481648
m_t << "<para>\n";
16491649
visitPreStart(m_t, children, hasCaption, relPath + shortName + ".png", width, height);
16501650
}
@@ -1672,7 +1672,7 @@ DB_VIS_C
16721672
QCString baseName=makeBaseName(fileName,".msc");
16731673
baseName.prepend("msc_");
16741674
QCString outDir = Config_getString(DOCBOOK_OUTPUT);
1675-
if (newFile) writeMscGraphFromFile(fileName,outDir,baseName,MscOutputFormat::BITMAP,srcFile,srcLine);
1675+
if (newFile) writeMscGraphFromFile(fileName,outDir,baseName,MscOutputFormat::BITMAP,srcFile,srcLine,false);
16761676
m_t << "<para>\n";
16771677
visitPreStart(m_t, children, hasCaption, relPath + baseName + ".png", width, height);
16781678
}
@@ -1690,7 +1690,7 @@ void DocbookDocVisitor::writeDiaFile(const QCString &baseName, const DocVerbatim
16901690
DB_VIS_C
16911691
QCString shortName = stripPath(baseName);
16921692
QCString outDir = Config_getString(DOCBOOK_OUTPUT);
1693-
writeDiaGraphFromFile(baseName+".dia",outDir,shortName,DiaOutputFormat::BITMAP,s.srcFile(),s.srcLine());
1693+
writeDiaGraphFromFile(baseName+".dia",outDir,shortName,DiaOutputFormat::BITMAP,s.srcFile(),s.srcLine(),false);
16941694
visitPreStart(m_t, s.children(), s.hasCaption(), shortName, s.width(),s.height());
16951695
visitCaption(s.children());
16961696
visitPostEnd(m_t, s.hasCaption());
@@ -1710,7 +1710,7 @@ DB_VIS_C
17101710
QCString baseName=makeBaseName(fileName,".dia");
17111711
baseName.prepend("dia_");
17121712
QCString outDir = Config_getString(DOCBOOK_OUTPUT);
1713-
if (newFile) writeDiaGraphFromFile(fileName,outDir,baseName,DiaOutputFormat::BITMAP,srcFile,srcLine);
1713+
if (newFile) writeDiaGraphFromFile(fileName,outDir,baseName,DiaOutputFormat::BITMAP,srcFile,srcLine,false);
17141714
m_t << "<para>\n";
17151715
visitPreStart(m_t, children, hasCaption, relPath + baseName + ".png", width, height);
17161716
}
@@ -1728,7 +1728,7 @@ void DocbookDocVisitor::writeDotFile(const QCString &fileName, const DocVerbatim
17281728
DB_VIS_C
17291729
QCString shortName = makeBaseName(fileName,".dot");
17301730
QCString outDir = Config_getString(DOCBOOK_OUTPUT);
1731-
if (newFile) writeDotGraphFromFile(fileName,outDir,shortName,GraphOutputFormat::BITMAP,s.srcFile(),s.srcLine());
1731+
if (newFile) writeDotGraphFromFile(fileName,outDir,shortName,GraphOutputFormat::BITMAP,s.srcFile(),s.srcLine(),false);
17321732
visitPreStart(m_t, s.children(), s.hasCaption(), s.relPath() + shortName + "." + getDotImageExtension(), s.width(),s.height());
17331733
visitCaption(s.children());
17341734
visitPostEnd(m_t, s.hasCaption());
@@ -1749,7 +1749,7 @@ DB_VIS_C
17491749
baseName.prepend("dot_");
17501750
QCString outDir = Config_getString(DOCBOOK_OUTPUT);
17511751
QCString imgExt = getDotImageExtension();
1752-
if (newFile) writeDotGraphFromFile(fileName,outDir,baseName,GraphOutputFormat::BITMAP,srcFile,srcLine);
1752+
if (newFile) writeDotGraphFromFile(fileName,outDir,baseName,GraphOutputFormat::BITMAP,srcFile,srcLine,false);
17531753
m_t << "<para>\n";
17541754
visitPreStart(m_t, children, hasCaption, relPath + baseName + "." + imgExt, width, height);
17551755
}

‎src/dot.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ bool DotManager::run()
229229

230230
void writeDotGraphFromFile(const QCString &inFile,const QCString &outDir,
231231
const QCString &outFile,GraphOutputFormat format,
232-
const QCString &srcFile,int srcLine)
232+
const QCString &srcFile,int srcLine,bool toIndex)
233233
{
234234
Dir d(outDir.str());
235235
if (!d.exists())
@@ -265,7 +265,7 @@ void writeDotGraphFromFile(const QCString &inFile,const QCString &outDir,
265265
return;
266266
}
267267

268-
Doxygen::indexList->addImageFile(imgName);
268+
if (toIndex) Doxygen::indexList->addImageFile(imgName);
269269

270270
}
271271

‎src/dot.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ class DotManager
5151

5252
void writeDotGraphFromFile(const QCString &inFile,const QCString &outDir,
5353
const QCString &outFile,GraphOutputFormat format,
54-
const QCString &srcFile,int srcLine);
54+
const QCString &srcFile,int srcLine,bool toIndex);
5555
void writeDotImageMapFromFile(TextStream &t,
5656
const QCString &inFile, const QCString& outDir,
5757
const QCString &relPath,const QCString& baseName,

‎src/dotclassgraph.cpp‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -456,6 +456,8 @@ QCString DotClassGraph::writeGraph(TextStream &out,
456456
bool generateImageMap,
457457
int graphId)
458458
{
459+
m_doNotAddImageToIndex = textFormat!=EmbeddedOutputFormat::Html;
460+
459461
return DotGraph::writeGraph(out, graphFormat, textFormat, path, fileName, relPath, generateImageMap, graphId);
460462
}
461463

‎src/dotdirdeps.cpp‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -441,6 +441,9 @@ QCString DotDirDeps::writeGraph(TextStream &out, GraphOutputFormat graphFormat,
441441
{
442442
m_linkRelations = linkRelations;
443443
m_urlOnly = TRUE;
444+
445+
m_doNotAddImageToIndex = textFormat!=EmbeddedOutputFormat::Html;
446+
444447
return DotGraph::writeGraph(out, graphFormat, textFormat, path, fileName, relPath, generateImageMap, graphId);
445448
}
446449

0 commit comments

Comments
 (0)