perlmodgen.cpp File Reference

#include <stdlib.h>
#include <qdir.h>
#include <qstack.h>
#include <qdict.h>
#include <qfile.h>
#include "perlmodgen.h"
#include "docparser.h"
#include "message.h"
#include "doxygen.h"
#include "pagedef.h"
#include "memberlist.h"
#include "ftextstream.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"

Go to the source code of this file.

Classes
class	PerlModOutputStream
class	PerlModOutput
class	PerlModDocVisitor
	Concrete visitor implementation for PerlMod output. More...
class	PerlModGenerator

Macros
#define	PERLOUTPUT_MAX_INDENTATION   40

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

Variables
static QCString	pathDoxyfile
static QCString	pathDoxyExec

Macro Definition Documentation

#define PERLOUTPUT_MAX_INDENTATION   40

Definition at line 47 of file perlmodgen.cpp.

Referenced by PerlModOutput::decIndent(), and PerlModOutput::incIndent().

Function Documentation

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

static

Definition at line 1449 of file perlmodgen.cpp.

References DocNode::accept(), PerlModOutput::add(), PerlModOutput::addField(), PerlModOutput::closeHash(), PerlModDocVisitor::finish(), PerlModOutput::openHash(), and validatingParseDoc().

Referenced by PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForNamespace(), and PerlModGenerator::generatePerlModForPage().

{
  QCString stext = text.stripWhiteSpace();
  if (stext.isEmpty())
    output.addField(name).add("{}");
  else {
    DocNode *root = validatingParseDoc(fileName,lineNr,scope,md,stext,FALSE,0);
    output.openHash(name);
    PerlModDocVisitor *visitor = new PerlModDocVisitor(output);
    root->accept(visitor);
    visitor->finish();
    output.closeHash();
    delete visitor;
    delete root;
  }
}

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

static

Definition at line 1412 of file perlmodgen.cpp.

References PerlModOutput::addFieldQuotedString(), PerlModOutput::closeHash(), PerlModOutput::closeList(), Argument::defval, Argument::name, PerlModOutput::openHash(), PerlModOutput::openList(), and Argument::type.

Referenced by addTemplateList().

{
  if (!al)
    return;
  output.openList("template_parameters");
  ArgumentListIterator ali(*al);
  Argument *a;
  for (ali.toFirst();(a=ali.current());++ali)
  {
    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();
}

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

static

Definition at line 1444 of file perlmodgen.cpp.

References addTemplateArgumentList(), Definition::name(), and ClassDef::templateArguments().

Referenced by PerlModGenerator::generatePerlModForClass().

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

void generatePerlMod

(

)

Definition at line 3000 of file perlmodgen.cpp.

References Config_getBool, and PerlModGenerator::generate().

Referenced by generateOutput().

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

static const char* getProtectionName ( Protection  prot )

static

Definition at line 1472 of file perlmodgen.cpp.

References Package, Private, Protected, and Public.

Referenced by PerlModGenerator::addListOfAllMembers(), PerlModGenerator::generatePerlModForClass(), and PerlModGenerator::generatePerlModForMember().

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

static const char* getVirtualnessName ( Specifier  virt )

static

Definition at line 1484 of file perlmodgen.cpp.

References Normal, Pure, and Virtual.

Referenced by PerlModGenerator::addListOfAllMembers(), PerlModGenerator::generatePerlModForClass(), and PerlModGenerator::generatePerlModForMember().

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

void setPerlModDoxyfile

(

const QCString &

qs

)

Definition at line 1498 of file perlmodgen.cpp.

Referenced by readConfiguration().

{
  pathDoxyfile = qs;
  pathDoxyExec = QDir::currentDirPath().utf8();
}

Variable Documentation

QCString pathDoxyExec

static

Definition at line 1496 of file perlmodgen.cpp.

QCString pathDoxyfile

static

Definition at line 1495 of file perlmodgen.cpp.