/******************************************************************************
*
*
*
* Copyright (C) 1997-2015 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.
*
*/
/*! \file
* This class represents a list of output generators that work in "parallel".
* The class only knows about the abstract base class OutputGenerators.
* All output is produced by calling a method of this class, which forwards
* the call to all output generators.
*/
#include "outputlist.h"
#include "outputgen.h"
#include "config.h"
#include "message.h"
#include "definition.h"
#include "docparser.h"
#include "vhdldocgen.h"
OutputList::OutputList(bool)
{
//printf("OutputList::OutputList()\n");
m_outputs.setAutoDelete(TRUE);
}
OutputList::~OutputList()
{
//printf("OutputList::~OutputList()\n");
}
void OutputList::add(const OutputGenerator *og)
{
if (og) m_outputs.append(og);
}
void OutputList::disableAllBut(OutputGenerator::OutputType o)
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
og->disableIfNot(o);
}
}
void OutputList::enableAll()
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
og->enable();
}
}
void OutputList::disableAll()
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
og->disable();
}
}
void OutputList::disable(OutputGenerator::OutputType o)
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
og->disableIf(o);
}
}
void OutputList::enable(OutputGenerator::OutputType o)
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
og->enableIf(o);
}
}
bool OutputList::isEnabled(OutputGenerator::OutputType o)
{
bool result=FALSE;
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
result=result || og->isEnabled(o);
}
return result;
}
void OutputList::pushGeneratorState()
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
og->pushGeneratorState();
}
}
void OutputList::popGeneratorState()
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
og->popGeneratorState();
}
}
bool OutputList::generateDoc(const char *fileName,int startLine,
Definition *ctx,MemberDef * md,
const QCString &docStr,bool indexWords,
bool isExample,const char *exampleName,
bool singleLine,bool linkFromIndex)
{
int count=0;
if (docStr.isEmpty()) return TRUE;
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
if (og->isEnabled()) count++;
}
if (count==0) return TRUE; // no output formats enabled.
DocRoot *root=0;
root = validatingParseDoc(fileName,startLine,
ctx,md,docStr,indexWords,isExample,exampleName,
singleLine,linkFromIndex);
writeDoc(root,ctx,md);
bool isEmpty = root->isEmpty();
delete root;
return isEmpty;
}
void OutputList::writeDoc(DocRoot *root,Definition *ctx,MemberDef *md)
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
//printf("og->printDoc(extension=%s)\n",
// ctx?ctx->getDefFileExtension().data():"<null>");
if (og->isEnabled()) og->writeDoc(root,ctx,md);
}
VhdlDocGen::setFlowMember(0);
}
bool OutputList::parseText(const QCString &textStr)
{
int count=0;
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
if (og->isEnabled()) count++;
}
if (count==0) return TRUE; // no output formats enabled.
DocText *root = validatingParseText(textStr);
for (it.toFirst();(og=it.current());++it)
{
if (og->isEnabled()) og->writeDoc(root,0,0);
}
bool isEmpty = root->isEmpty();
delete root;
return isEmpty;
}
//--------------------------------------------------------------------------
// Create some overloaded definitions of the forall function.
// Using template functions here would have made it a little less
// portable (I guess).
// zero arguments
void OutputList::forall(void (OutputGenerator::*func)())
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
if (og->isEnabled()) (og->*func)();
}
}
// one argument
#define FORALL1(a1,p1) \
void OutputList::forall(void (OutputGenerator::*func)(a1),a1) \
{ \
QListIterator<OutputGenerator> it(m_outputs); \
OutputGenerator *og; \
for (it.toFirst();(og=it.current());++it) \
{ \
if (og->isEnabled()) (og->*func)(p1); \
} \
}
// two arguments
#define FORALL2(a1,a2,p1,p2) \
void OutputList::forall(void (OutputGenerator::*func)(a1,a2),a1,a2) \
{ \
QListIterator<OutputGenerator> it(m_outputs); \
OutputGenerator *og; \
for (it.toFirst();(og=it.current());++it) \
{ \
if (og->isEnabled()) (og->*func)(p1,p2); \
} \
}
// three arguments
#define FORALL3(a1,a2,a3,p1,p2,p3) \
void OutputList::forall(void (OutputGenerator::*func)(a1,a2,a3),a1,a2,a3) \
{ \
QListIterator<OutputGenerator> it(m_outputs); \
OutputGenerator *og; \
for (it.toFirst();(og=it.current());++it) \
{ \
if (og->isEnabled()) (og->*func)(p1,p2,p3); \
} \
}
// four arguments
#define FORALL4(a1,a2,a3,a4,p1,p2,p3,p4) \
void OutputList::forall(void (OutputGenerator::*func)(a1,a2,a3,a4),a1,a2,a3,a4) \
{ \
QListIterator<OutputGenerator> it(m_outputs); \
OutputGenerator *og; \
for (it.toFirst();(og=it.current());++it) \
{ \
if (og->isEnabled()) (og->*func)(p1,p2,p3,p4); \
} \
}
// five arguments
#define FORALL5(a1,a2,a3,a4,a5,p1,p2,p3,p4,p5) \
void OutputList::forall(void (OutputGenerator::*func)(a1,a2,a3,a4,a5),a1,a2,a3,a4,a5) \
{ \
QListIterator<OutputGenerator> it(m_outputs); \
OutputGenerator *og; \
for (it.toFirst();(og=it.current());++it) \
{ \
if (og->isEnabled()) (og->*func)(p1,p2,p3,p4,p5); \
} \
}
// six arguments
#define FORALL6(a1,a2,a3,a4,a5,a6,p1,p2,p3,p4,p5,p6) \
void OutputList::forall(void (OutputGenerator::*func)(a1,a2,a3,a4,a5,a6),a1,a2,a3,a4,a5,a6) \
{ \
QListIterator<OutputGenerator> it(m_outputs); \
OutputGenerator *og; \
for (it.toFirst();(og=it.current());++it) \
{ \
if (og->isEnabled()) (og->*func)(p1,p2,p3,p4,p5,p6); \
} \
}
// seven arguments
#define FORALL7(a1,a2,a3,a4,a5,a6,a7,p1,p2,p3,p4,p5,p6,p7) \
void OutputList::forall(void (OutputGenerator::*func)(a1,a2,a3,a4,a5,a6,a7),a1,a2,a3,a4,a5,a6,a7) \
{ \
QListIterator<OutputGenerator> it(m_outputs); \
OutputGenerator *og; \
for (it.toFirst();(og=it.current());++it) \
{ \
if (og->isEnabled()) (og->*func)(p1,p2,p3,p4,p5,p6,p7); \
} \
}
// eight arguments
#define FORALL8(a1,a2,a3,a4,a5,a6,a7,a8,p1,p2,p3,p4,p5,p6,p7,p8) \
void OutputList::forall(void (OutputGenerator::*func)(a1,a2,a3,a4,a5,a6,a7,a8),a1,a2,a3,a4,a5,a6,a7,a8) \
{ \
QListIterator<OutputGenerator> it(m_outputs); \
OutputGenerator *og; \
for (it.toFirst();(og=it.current());++it) \
{ \
if (og->isEnabled()) (og->*func)(p1,p2,p3,p4,p5,p6,p7,p8); \
} \
}
// now instantiate only the ones we need.
FORALL1(const char *a1,a1)
FORALL1(char a1,a1)
FORALL1(int a1,a1)
FORALL1(const DotClassGraph &a1,a1)
FORALL1(const DotInclDepGraph &a1,a1)
FORALL1(const DotCallGraph &a1,a1)
FORALL1(const DotDirDeps &a1,a1)
FORALL1(const DotGfxHierarchyTable &a1,a1)
FORALL1(const DotGroupCollaboration &a1,a1)
FORALL1(SectionTypes a1,a1)
#if defined(HAS_BOOL_TYPE) || defined(Q_HAS_BOOL_TYPE)
FORALL1(bool a1,a1)
FORALL2(bool a1,int a2,a1,a2)
FORALL2(bool a1,bool a2,a1,a2)
FORALL2(const char *a1,bool a2,a1,a2)
FORALL4(const char *a1,const char *a2,const char *a3,bool a4,a1,a2,a3,a4)
#endif
FORALL2(int a1,bool a2,a1,a2)
FORALL2(bool a1,const char *a2,a1,a2)
FORALL2(ParamListTypes a1,const char *a2,a1,a2)
FORALL1(IndexSections a1,a1)
FORALL2(const char *a1,const char *a2,a1,a2)
FORALL2(const char *a1,int a2,a1,a2)
FORALL2(const char *a1,SectionInfo::SectionType a2,a1,a2)
FORALL3(bool a1,HighlightedItem a2,const char *a3,a1,a2,a3)
FORALL3(bool a1,bool a2,bool a3,a1,a2,a3)
FORALL3(const ClassDiagram &a1,const char *a2,const char *a3,a1,a2,a3)
FORALL3(const char *a1,const char *a2,const char *a3,a1,a2,a3)
FORALL3(const char *a1,const char *a2,bool a3,a1,a2,a3)
FORALL3(const char *a1,int a2,const char *a3,a1,a2,a3)
FORALL3(const char *a1,const char *a2,SectionInfo::SectionType a3,a1,a2,a3)
FORALL3(uchar a1,uchar a2,uchar a3,a1,a2,a3)
FORALL3(Definition *a1,const char *a2,bool a3,a1,a2,a3)
FORALL4(SectionTypes a1,const char *a2,const char *a3,const char *a4,a1,a2,a3,a4)
FORALL4(const char *a1,const char *a2,const char *a3,const char *a4,a1,a2,a3,a4)
FORALL4(const char *a1,const char *a2,const char *a3,int a4,a1,a2,a3,a4)
FORALL5(const char *a1,const char *a2,const char *a3,const char *a4,const char *a5,a1,a2,a3,a4,a5)
FORALL5(const char *a1,const char *a2,const char *a3,const char *a4,bool a5,a1,a2,a3,a4,a5)
FORALL6(const char *a1,const char *a2,const char *a3,const char *a4,const char *a5,const char *a6,a1,a2,a3,a4,a5,a6)
FORALL6(const char *a1,const DocLinkInfo &a2,const char *a3,const char *a4,const SourceLinkInfo &a5,const SourceLinkInfo &a6,a1,a2,a3,a4,a5,a6)
FORALL7(const char *a1,const char *a2,const char *a3,const char *a4,int a5,int a6,bool a7,a1,a2,a3,a4,a5,a6,a7)
//--------------------------------------------------------------------------