perlmodgen.cpp 文件参考

#include <stdlib.h>
#include <stack>
#include <fstream>
#include <iostream>
#include "perlmodgen.h"
#include "docparser.h"
#include "message.h"
#include "doxygen.h"
#include "pagedef.h"
#include "memberlist.h"
#include "arguments.h"
#include "config.h"
#include "groupdef.h"
#include "classdef.h"
#include "classlist.h"
#include "filename.h"
#include "membername.h"
#include "namespacedef.h"
#include "membergroup.h"
#include "section.h"
#include "util.h"
#include "htmlentity.h"
#include "emoji.h"
#include "dir.h"

perlmodgen.cpp 的引用(Include)关系图:

浏览源代码.

类
class	PerlModOutputStream
class	PerlModOutput
class	PerlModDocVisitor
	Concrete visitor implementation for PerlMod output. 更多...
class	PerlModGenerator

宏定义
#define	PERLOUTPUT_MAX_INDENTATION   40

函数
static void	addTemplateArgumentList (const ArgumentList &al, PerlModOutput &output, const QCString &)
static void	addTemplateList (const ClassDef *cd, PerlModOutput &output)
static void	addTemplateList (const ConceptDef *cd, PerlModOutput &output)
static void	addPerlModDocBlock (PerlModOutput &output, const QCString &name, const QCString &fileName, int lineNr, const Definition *scope, const MemberDef *md, const QCString &text)
static const char *	getProtectionName (Protection prot)
static const char *	getVirtualnessName (Specifier virt)
void	setPerlModDoxyfile (const QCString &qs)
void	generatePerlMod ()

变量
static QCString	pathDoxyfile
static QCString	pathDoxyExec

宏定义说明

PERLOUTPUT_MAX_INDENTATION

#define PERLOUTPUT_MAX_INDENTATION   40

在文件 perlmodgen.cpp 第 47 行定义.

函数说明

addPerlModDocBlock()

static void addPerlModDocBlock ( PerlModOutput &  output, const QCString &  name, const QCString &  fileName, int  lineNr, const Definition *  scope, const MemberDef *  md, const QCString &  text  )

static

在文件 perlmodgen.cpp 第 1458 行定义.

{
  QCString stext = text.stripWhiteSpace();
  if (stext.isEmpty())
    output.addField(name).add("{}");
  else {
    std::unique_ptr<IDocParser> parser { createDocParser() };
    std::unique_ptr<DocRoot>    root   { validatingParseDoc(*parser.get(),
                                         fileName,lineNr,scope,md,stext,FALSE,FALSE,
                                         QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT)) };
    output.openHash(name);
    auto visitor = std::make_unique<PerlModDocVisitor>(output);
    root->accept(visitor.get());
    visitor->finish();
    output.closeHash();
  }
}

引用了 PerlModOutput::add(), PerlModOutput::addField(), PerlModOutput::closeHash(), Config_getBool, createDocParser(), FALSE, QCString::isEmpty(), PerlModOutput::openHash(), QCString::stripWhiteSpace() , 以及 validatingParseDoc().

被这些函数引用 PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForConcept(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForNamespace() , 以及 PerlModGenerator::generatePerlModForPage().

addTemplateArgumentList()

static void addTemplateArgumentList ( const ArgumentList &  al, PerlModOutput &  output, const QCString &    )

static

在文件 perlmodgen.cpp 第 1429 行定义.

{
  if (!al.hasParameters()) return;
  output.openList("template_parameters");
  for (const Argument &a : al)
  {
    output.openHash();
    if (!a.type.isEmpty())
      output.addFieldQuotedString("type", a.type);
    if (!a.name.isEmpty())
      output.addFieldQuotedString("declaration_name", a.name)
        .addFieldQuotedString("definition_name", a.name);
    if (!a.defval.isEmpty())
      output.addFieldQuotedString("default", a.defval);
    output.closeHash();
  }
  output.closeList();
}

引用了 PerlModOutput::addFieldQuotedString(), PerlModOutput::closeHash(), PerlModOutput::closeList(), ArgumentList::hasParameters(), PerlModOutput::openHash() , 以及 PerlModOutput::openList().

被这些函数引用 addTemplateList().

addTemplateList() [1/2]

static void addTemplateList ( const ClassDef *  cd, PerlModOutput &  output  )

static

在文件 perlmodgen.cpp 第 1448 行定义.

{
  addTemplateArgumentList(cd->templateArguments(),output,cd->name());
}

引用了 addTemplateArgumentList(), Definition::name() , 以及 ClassDef::templateArguments().

被这些函数引用 PerlModGenerator::generatePerlModForClass() , 以及 PerlModGenerator::generatePerlModForConcept().

addTemplateList() [2/2]

static void addTemplateList ( const ConceptDef *  cd, PerlModOutput &  output  )

static

在文件 perlmodgen.cpp 第 1453 行定义.

{
  addTemplateArgumentList(cd->getTemplateParameterList(),output,cd->name());
}

引用了 addTemplateArgumentList(), ConceptDef::getTemplateParameterList() , 以及 Definition::name().

generatePerlMod()

void generatePerlMod

(

)

在文件 perlmodgen.cpp 第 2958 行定义.

{
  PerlModGenerator pmg(Config_getBool(PERLMOD_PRETTY));
  pmg.generate();
}

引用了 Config_getBool , 以及 PerlModGenerator::generate().

被这些函数引用 generateOutput().

getProtectionName()

static const char* getProtectionName ( Protection  prot )

static

在文件 perlmodgen.cpp 第 1482 行定义.

{
  switch (prot)
  {
  case Public:    return "public";
  case Protected: return "protected";
  case Private:   return "private";
  case Package:   return "package";
  }
  return 0;
}

引用了 Package, Private, Protected , 以及 Public.

被这些函数引用 PerlModGenerator::addListOfAllMembers(), PerlModGenerator::generatePerlModForClass() , 以及 PerlModGenerator::generatePerlModForMember().

getVirtualnessName()

static const char* getVirtualnessName ( Specifier  virt )

static

在文件 perlmodgen.cpp 第 1494 行定义.

{
  switch(virt)
  {
  case Normal:  return "non_virtual";
  case Virtual: return "virtual";
  case Pure:    return "pure_virtual";
  }
  return 0;
}

引用了 Normal, Pure , 以及 Virtual.

被这些函数引用 PerlModGenerator::addListOfAllMembers(), PerlModGenerator::generatePerlModForClass() , 以及 PerlModGenerator::generatePerlModForMember().

setPerlModDoxyfile()

void setPerlModDoxyfile

(

const QCString &

qs

)

在文件 perlmodgen.cpp 第 1508 行定义.

{
  pathDoxyfile = qs;
  pathDoxyExec = Dir::currentDirPath();
}

引用了 Dir::currentDirPath(), pathDoxyExec , 以及 pathDoxyfile.

被这些函数引用 readConfiguration().

变量说明

pathDoxyExec

QCString pathDoxyExec

static

在文件 perlmodgen.cpp 第 1506 行定义.

被这些函数引用 PerlModGenerator::generateDoxyRules() , 以及 setPerlModDoxyfile().

pathDoxyfile

QCString pathDoxyfile

static

在文件 perlmodgen.cpp 第 1505 行定义.

被这些函数引用 PerlModGenerator::generateDoxyRules() , 以及 setPerlModDoxyfile().