PerlModGenerator Class Reference

List of all members.

Public Member Functions

 PerlModGenerator (bool pretty)
void generatePerlModForMember (MemberDef *md, Definition *)
void generatePerlModSection (Definition *d, MemberList *ml, const char *name, const char *header=0)
void addListOfAllMembers (ClassDef *cd)
void generatePerlModForClass (ClassDef *cd)
void generatePerlModForNamespace (NamespaceDef *nd)
void generatePerlModForFile (FileDef *fd)
void generatePerlModForGroup (GroupDef *gd)
void generatePerlModForPage (PageDef *pi)
bool createOutputFile (QFile &f, const char *s)
bool createOutputDir (QDir &perlModDir)
bool generateDoxyLatexTex ()
bool generateDoxyFormatTex ()
bool generateDoxyStructurePM ()
bool generateDoxyLatexPL ()
bool generateDoxyLatexStructurePL ()
bool generateDoxyRules ()
bool generateMakefile ()
bool generatePerlModOutput ()
void generate ()

Public Attributes

PerlModOutput m_output
QString pathDoxyStructurePM
QString pathDoxyDocsTex
QString pathDoxyFormatTex
QString pathDoxyLatexTex
QString pathDoxyLatexDVI
QString pathDoxyLatexPDF
QString pathDoxyStructureTex
QString pathDoxyDocsPM
QString pathDoxyLatexPL
QString pathDoxyLatexStructurePL
QString pathDoxyRules
QString pathMakefile

Detailed Description

Definition at line 1361 of file perlmodgen.cpp.

Constructor & Destructor Documentation

PerlModGenerator::PerlModGenerator ( bool  pretty  )  [inline]

Definition at line 1380 of file perlmodgen.cpp.

Member Function Documentation

void PerlModGenerator::generatePerlModForMember ( MemberDef *  md,
Definition *   
)

Definition at line 1406 of file perlmodgen.cpp.

References PerlModOutput::addFieldBoolean(), PerlModOutput::addFieldQuotedString(), MemberDef::argsString(), MemberDef::argumentList(), Argument::array, Argument::attrib, Definition::briefDescription(), PerlModOutput::closeHash(), PerlModOutput::closeList(), MemberDef::DCOP, MemberDef::declArgumentList(), MemberDef::Define, Argument::defval, Definition::documentation(), MemberDef::Enumeration, MemberDef::enumFieldList(), MemberDef::EnumValue, MemberDef::Event, MemberDef::excpString(), MemberDef::Friend, MemberDef::Function, Definition::getDefFileName(), Definition::getDefLine(), Definition::getOuterScope(), MemberDef::initializer(), MemberDef::isStatic(), m_output, MemberDef::memberType(), Argument::name, MemberDef::name, PerlModOutput::openHash(), PerlModOutput::openList(), MemberDef::Property, MemberDef::protection(), MemberDef::Prototype, QCString, MemberDef::reimplementedBy(), MemberDef::reimplements(), MemberDef::Signal, MemberDef::Slot, Argument::type, MemberDef::Typedef, MemberDef::typeString(), MemberDef::Variable, and MemberDef::virtualness().

Referenced by generatePerlModSection().

void PerlModGenerator::generatePerlModSection ( Definition *  d,
MemberList *  ml,
const char *  name,
const char *  header = 0 
)

Definition at line 1563 of file perlmodgen.cpp.

References PerlModOutput::addFieldQuotedString(), PerlModOutput::closeHash(), PerlModOutput::closeList(), generatePerlModForMember(), m_output, PerlModOutput::openHash(), and PerlModOutput::openList().

Referenced by generatePerlModForClass(), generatePerlModForFile(), generatePerlModForGroup(), and generatePerlModForNamespace().

void PerlModGenerator::addListOfAllMembers ( ClassDef *  cd  ) 

Definition at line 1584 of file perlmodgen.cpp.

References PerlModOutput::addFieldQuotedString(), MemberInfo::ambiguityResolutionScope, PerlModOutput::closeList(), MemberDef::getClassDef(), MemberDef::getGroupDef(), SDict< MemberNameInfo >::Iterator, m_output, MemberInfo::memberDef, ClassDef::memberNameInfoSDict(), ClassDef::name, MemberDef::name, PerlModOutput::openHash(), PerlModOutput::openList(), MemberInfo::prot, and MemberDef::virtualness().

Referenced by generatePerlModForClass().

void PerlModGenerator::generatePerlModForClass ( ClassDef *  cd  ) 

Definition at line 1618 of file perlmodgen.cpp.

References PerlModOutput::addFieldBoolean(), PerlModOutput::addFieldQuotedString(), addListOfAllMembers(), ClassDef::baseClasses(), Definition::briefDescription(), PerlModOutput::closeHash(), PerlModOutput::closeList(), MemberList::dcopMethods, FileDef::docName(), Definition::documentation(), IncludeInfo::fileDef, MemberList::friends, generatePerlModSection(), Definition::getDefFileName(), Definition::getDefLine(), Definition::getEndBodyLine(), ClassDef::getInnerClasses(), ClassDef::getMemberGroupSDict(), ClassDef::getMemberList(), FileDef::getOutputFileBase(), Definition::getStartBodyLine(), MemberGroup::header(), ClassDef::includeInfo(), IncludeInfo::includeName, Definition::isReference(), ClassDef::isReference(), DotClassGraph::isTrivial(), SIntDict< MemberGroup >::Iterator, SDict< ClassDef >::Iterator, IncludeInfo::local, m_output, MemberGroup::members(), ClassDef::name, PerlModOutput::openHash(), PerlModOutput::openList(), MemberList::priAttribs, MemberList::priMethods, MemberList::priSlots, MemberList::priStaticAttribs, MemberList::priStaticMethods, MemberList::priTypes, MemberList::proAttribs, MemberList::proMethods, MemberList::properties, MemberList::proSlots, MemberList::proStaticAttribs, MemberList::proStaticMethods, MemberList::proTypes, MemberList::pubAttribs, MemberList::pubMethods, MemberList::pubSlots, MemberList::pubStaticAttribs, MemberList::pubStaticMethods, MemberList::pubTypes, QCString, MemberList::related, MemberList::signals, ClassDef::subClasses(), and ClassDef::templateMaster().

Referenced by generatePerlModOutput().

void PerlModGenerator::generatePerlModForNamespace ( NamespaceDef *  nd  ) 

Definition at line 1768 of file perlmodgen.cpp.

References PerlModOutput::addFieldQuotedString(), Definition::briefDescription(), PerlModOutput::closeHash(), PerlModOutput::closeList(), MemberList::decDefineMembers, MemberList::decEnumMembers, MemberList::decFuncMembers, MemberList::decProtoMembers, MemberList::decTypedefMembers, MemberList::decVarMembers, Definition::documentation(), generatePerlModSection(), NamespaceDef::getClassSDict(), Definition::getDefFileName(), Definition::getDefLine(), NamespaceDef::getMemberGroupSDict(), NamespaceDef::getMemberList(), NamespaceDef::getNamespaceSDict(), MemberGroup::header(), Definition::isReference(), SIntDict< MemberGroup >::Iterator, SDict< NamespaceDef >::Iterator, SDict< ClassDef >::Iterator, m_output, MemberGroup::members(), ClassDef::name, Definition::name(), PerlModOutput::openHash(), and PerlModOutput::openList().

Referenced by generatePerlModOutput().

void PerlModGenerator::generatePerlModForFile ( FileDef *  fd  ) 

Definition at line 1831 of file perlmodgen.cpp.

References PerlModOutput::addFieldQuotedString(), Definition::briefDescription(), PerlModOutput::closeHash(), PerlModOutput::closeList(), MemberList::decDefineMembers, MemberList::decEnumMembers, MemberList::decFuncMembers, MemberList::decProtoMembers, MemberList::decTypedefMembers, MemberList::decVarMembers, Definition::documentation(), IncludeInfo::fileDef, generatePerlModSection(), Definition::getDefFileName(), Definition::getDefLine(), FileDef::getMemberList(), FileDef::getOutputFileBase(), FileDef::includedByFileList(), FileDef::includeFileList(), IncludeInfo::includeName, Definition::isReference(), m_output, FileDef::name(), PerlModOutput::openHash(), and PerlModOutput::openList().

Referenced by generatePerlModOutput().

void PerlModGenerator::generatePerlModForGroup ( GroupDef *  gd  ) 

Definition at line 1900 of file perlmodgen.cpp.

References PerlModOutput::addFieldQuotedString(), Definition::briefDescription(), PerlModOutput::closeHash(), PerlModOutput::closeList(), MemberList::decDefineMembers, MemberList::decEnumMembers, MemberList::decFuncMembers, MemberList::decProtoMembers, MemberList::decTypedefMembers, MemberList::decVarMembers, Definition::documentation(), generatePerlModSection(), GroupDef::getClasses(), Definition::getDefFileName(), Definition::getDefLine(), GroupDef::getFiles(), GroupDef::getMemberGroupSDict(), GroupDef::getMemberList(), GroupDef::getNamespaces(), GroupDef::getPages(), GroupDef::getSubGroups(), GroupDef::groupTitle(), MemberGroup::header(), Definition::isReference(), SIntDict< MemberGroup >::Iterator, SDict< PageDef >::Iterator, SDict< NamespaceDef >::Iterator, SDict< ClassDef >::Iterator, m_output, MemberGroup::members(), ClassDef::name, FileDef::name(), Definition::name(), PerlModOutput::openHash(), PerlModOutput::openList(), and PageDef::title().

Referenced by generatePerlModOutput().

void PerlModGenerator::generatePerlModForPage ( PageDef *  pi  ) 

Definition at line 2006 of file perlmodgen.cpp.

References PerlModOutput::addFieldQuotedString(), PerlModOutput::closeHash(), Definition::docFile(), Definition::docLine(), Definition::documentation(), Definition::isReference(), m_output, Definition::name(), PerlModOutput::openHash(), Doxygen::sectionDict, and SectionInfo::title.

Referenced by generatePerlModOutput().

bool PerlModGenerator::createOutputFile ( QFile &  f,
const char *  s 
)

Definition at line 2088 of file perlmodgen.cpp.

References err().

Referenced by generateDoxyFormatTex(), generateDoxyLatexPL(), generateDoxyLatexStructurePL(), generateDoxyLatexTex(), generateDoxyRules(), generateDoxyStructurePM(), generateMakefile(), and generatePerlModOutput().

bool PerlModGenerator::createOutputDir ( QDir &  perlModDir  ) 

Definition at line 2099 of file perlmodgen.cpp.

References Config_getBool, Config_getString, err(), and QCString.

Referenced by generate().

bool PerlModGenerator::generateDoxyLatexTex (  ) 

Definition at line 2776 of file perlmodgen.cpp.

References createOutputFile(), pathDoxyDocsTex, and pathDoxyLatexTex.

Referenced by generate().

bool PerlModGenerator::generateDoxyFormatTex (  ) 

Definition at line 2613 of file perlmodgen.cpp.

References createOutputFile(), pathDoxyFormatTex, and pathDoxyStructureTex.

Referenced by generate().

bool PerlModGenerator::generateDoxyStructurePM (  ) 

Definition at line 2148 of file perlmodgen.cpp.

References createOutputFile(), and pathDoxyStructurePM.

Referenced by generate().

bool PerlModGenerator::generateDoxyLatexPL (  ) 

Definition at line 2490 of file perlmodgen.cpp.

References createOutputFile(), and pathDoxyLatexPL.

Referenced by generate().

bool PerlModGenerator::generateDoxyLatexStructurePL (  ) 

Definition at line 2456 of file perlmodgen.cpp.

References createOutputFile(), and pathDoxyLatexStructurePL.

Referenced by generate().

bool PerlModGenerator::generateDoxyRules (  ) 

Definition at line 2332 of file perlmodgen.cpp.

References Config_getBool, Config_getString, createOutputFile(), pathDoxyDocsPM, pathDoxyDocsTex, pathDoxyFormatTex, pathDoxyLatexDVI, pathDoxyLatexPDF, pathDoxyLatexPL, pathDoxyLatexStructurePL, pathDoxyLatexTex, pathDoxyRules, pathDoxyStructurePM, and pathDoxyStructureTex.

Referenced by generate().

bool PerlModGenerator::generateMakefile (  ) 

Definition at line 2429 of file perlmodgen.cpp.

References Config_getBool, Config_getString, createOutputFile(), pathDoxyRules, and pathMakefile.

Referenced by generate().

bool PerlModGenerator::generatePerlModOutput (  ) 

Definition at line 2025 of file perlmodgen.cpp.

References PerlModOutput::add(), Doxygen::classSDict, PerlModOutput::closeHash(), PerlModOutput::closeList(), createOutputFile(), generatePerlModForClass(), generatePerlModForFile(), generatePerlModForGroup(), generatePerlModForNamespace(), generatePerlModForPage(), Doxygen::groupSDict, Doxygen::inputNameList, SDict< PageDef >::Iterator, SDict< GroupDef >::Iterator, SDict< NamespaceDef >::Iterator, SDict< ClassDef >::Iterator, m_output, Doxygen::mainPage, Doxygen::namespaceSDict, PerlModOutput::openHash(), PerlModOutput::openList(), Doxygen::pageSDict, pathDoxyDocsPM, and PerlModOutput::setPerlModOutputStream().

Referenced by generate().

void PerlModGenerator::generate (  ) 

Definition at line 2802 of file perlmodgen.cpp.

References Config_getBool, createOutputDir(), generateDoxyFormatTex(), generateDoxyLatexPL(), generateDoxyLatexStructurePL(), generateDoxyLatexTex(), generateDoxyRules(), generateDoxyStructurePM(), generateMakefile(), generatePerlModOutput(), pathDoxyDocsPM, pathDoxyDocsTex, pathDoxyFormatTex, pathDoxyLatexDVI, pathDoxyLatexPDF, pathDoxyLatexPL, pathDoxyLatexStructurePL, pathDoxyLatexTex, pathDoxyRules, pathDoxyStructurePM, pathDoxyStructureTex, and pathMakefile.

Referenced by generatePerlMod().

Member Data Documentation

PerlModOutput PerlModGenerator::m_output

Definition at line 1365 of file perlmodgen.cpp.

Referenced by addListOfAllMembers(), generatePerlModForClass(), generatePerlModForFile(), generatePerlModForGroup(), generatePerlModForMember(), generatePerlModForNamespace(), generatePerlModForPage(), generatePerlModOutput(), and generatePerlModSection().

QString PerlModGenerator::pathDoxyStructurePM

Definition at line 1367 of file perlmodgen.cpp.

Referenced by generate(), generateDoxyRules(), and generateDoxyStructurePM().

QString PerlModGenerator::pathDoxyDocsTex

Definition at line 1368 of file perlmodgen.cpp.

Referenced by generate(), generateDoxyLatexTex(), and generateDoxyRules().

QString PerlModGenerator::pathDoxyFormatTex

Definition at line 1369 of file perlmodgen.cpp.

Referenced by generate(), generateDoxyFormatTex(), and generateDoxyRules().

QString PerlModGenerator::pathDoxyLatexTex

Definition at line 1370 of file perlmodgen.cpp.

Referenced by generate(), generateDoxyLatexTex(), and generateDoxyRules().

QString PerlModGenerator::pathDoxyLatexDVI

Definition at line 1371 of file perlmodgen.cpp.

Referenced by generate(), and generateDoxyRules().

QString PerlModGenerator::pathDoxyLatexPDF

Definition at line 1372 of file perlmodgen.cpp.

Referenced by generate(), and generateDoxyRules().

QString PerlModGenerator::pathDoxyStructureTex

Definition at line 1373 of file perlmodgen.cpp.

Referenced by generate(), generateDoxyFormatTex(), and generateDoxyRules().

QString PerlModGenerator::pathDoxyDocsPM

Definition at line 1374 of file perlmodgen.cpp.

Referenced by generate(), generateDoxyRules(), and generatePerlModOutput().

QString PerlModGenerator::pathDoxyLatexPL

Definition at line 1375 of file perlmodgen.cpp.

Referenced by generate(), generateDoxyLatexPL(), and generateDoxyRules().

QString PerlModGenerator::pathDoxyLatexStructurePL

Definition at line 1376 of file perlmodgen.cpp.

Referenced by generate(), generateDoxyLatexStructurePL(), and generateDoxyRules().

QString PerlModGenerator::pathDoxyRules

Definition at line 1377 of file perlmodgen.cpp.

Referenced by generate(), generateDoxyRules(), and generateMakefile().

QString PerlModGenerator::pathMakefile

Definition at line 1378 of file perlmodgen.cpp.

Referenced by generate(), and generateMakefile().

The documentation for this class was generated from the following file:


Generated on Mon Mar 31 10:59:02 2008 by  doxygen 1.5.1