PerlModOutput类 参考

PerlModOutput 的协作图:

Public 成员函数
	PerlModOutput (bool pretty)
virtual	~PerlModOutput ()
void	setPerlModOutputStream (PerlModOutputStream *os)
PerlModOutput &	continueBlock ()
PerlModOutput &	add (char c)
PerlModOutput &	add (const QCString &s)
PerlModOutput &	add (QCString &s)
PerlModOutput &	add (int n)
PerlModOutput &	add (unsigned int n)
PerlModOutput &	addQuoted (const QCString &s)
PerlModOutput &	indent ()
PerlModOutput &	open (char c, const QCString &s=QCString())
PerlModOutput &	close (char c=0)
PerlModOutput &	addField (const QCString &s)
PerlModOutput &	addFieldQuotedChar (const QCString &field, char content)
PerlModOutput &	addFieldQuotedString (const QCString &field, const QCString &content)
PerlModOutput &	addFieldBoolean (const QCString &field, bool content)
PerlModOutput &	openList (const QCString &s=QCString())
PerlModOutput &	closeList ()
PerlModOutput &	openHash (const QCString &s=QCString())
PerlModOutput &	closeHash ()

Public 属性
bool	m_pretty

Protected 成员函数
void	incIndent ()
void	decIndent ()
void	iaddQuoted (const QCString &)
void	iaddFieldQuotedChar (const QCString &, char)
void	iaddFieldQuotedString (const QCString &, const QCString &)
void	iaddField (const QCString &)
void	iopen (char, const QCString &)
void	iclose (char)

Private 属性
PerlModOutputStream *	m_stream
int	m_indentation
bool	m_blockstart
char	m_spaces [PERLOUTPUT_MAX_INDENTATION *2+2]

详细描述

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

构造及析构函数说明

PerlModOutput()

PerlModOutput::PerlModOutput ( bool  pretty )

inline

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

    : m_pretty(pretty), m_stream(0), m_indentation(false), m_blockstart(true)
  {
    m_spaces[0] = 0;
  }

引用了 m_spaces.

~PerlModOutput()

virtual PerlModOutput::~PerlModOutput ( )

inlinevirtual

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

{ }

成员函数说明

add() [1/5]

PerlModOutput& PerlModOutput::add ( char  c )

inline

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

{ m_stream->add(c); return *this; }

引用了 PerlModOutputStream::add() , 以及 m_stream.

被这些函数引用 addPerlModDocBlock(), PerlModDocVisitor::enterText(), PerlModDocVisitor::finish(), PerlModGenerator::generatePerlModOutput(), PerlModDocVisitor::leaveText(), PerlModDocVisitor::visit(), PerlModDocVisitor::visitPost() , 以及 PerlModDocVisitor::visitPre().

add() [2/5]

PerlModOutput& PerlModOutput::add ( const QCString &  s )

inline

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

{ m_stream->add(s); return *this; }

引用了 PerlModOutputStream::add() , 以及 m_stream.

add() [3/5]

PerlModOutput& PerlModOutput::add ( int  n )

inline

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

{ m_stream->add(n); return *this; }

引用了 PerlModOutputStream::add() , 以及 m_stream.

add() [4/5]

PerlModOutput& PerlModOutput::add ( QCString &  s )

inline

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

{ m_stream->add(s); return *this; }

引用了 PerlModOutputStream::add() , 以及 m_stream.

add() [5/5]

PerlModOutput& PerlModOutput::add ( unsigned int  n )

inline

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

{ m_stream->add(n); return *this; }

引用了 PerlModOutputStream::add() , 以及 m_stream.

addField()

PerlModOutput& PerlModOutput::addField ( const QCString &  s )

inline

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

{ iaddField(s); return *this; }

引用了 iaddField().

被这些函数引用 addPerlModDocBlock() , 以及 PerlModDocVisitor::enterText().

addFieldBoolean()

PerlModOutput& PerlModOutput::addFieldBoolean ( const QCString &  field, bool  content  )

inline

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

  {
    return addFieldQuotedString(field, content ? "yes" : "no");
  }

引用了 addFieldQuotedString().

被这些函数引用 PerlModGenerator::addIncludeInfo(), PerlModGenerator::generatePerlModForMember() , 以及 PerlModDocVisitor::visit().

addFieldQuotedChar()

PerlModOutput& PerlModOutput::addFieldQuotedChar ( const QCString &  field, char  content  )

inline

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

  {
    iaddFieldQuotedChar(field, content); return *this;
  }

引用了 iaddFieldQuotedChar().

被这些函数引用 PerlModDocVisitor::visit().

addFieldQuotedString()

PerlModOutput& PerlModOutput::addFieldQuotedString ( const QCString &  field, const QCString &  content  )

inline

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

  {
    iaddFieldQuotedString(field, content); return *this;
  }

引用了 iaddFieldQuotedString().

被这些函数引用 addFieldBoolean(), PerlModGenerator::addIncludeInfo(), PerlModDocVisitor::addLink(), PerlModGenerator::addListOfAllMembers(), addTemplateArgumentList(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForConcept(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForNamespace(), PerlModGenerator::generatePerlModForPage(), PerlModGenerator::generatePerlModSection(), PerlModGenerator::generatePerlUserDefinedSection(), PerlModDocVisitor::openItem(), PerlModDocVisitor::visit() , 以及 PerlModDocVisitor::visitPre().

addQuoted()

PerlModOutput& PerlModOutput::addQuoted ( const QCString &  s )

inline

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

{ iaddQuoted(s); return *this; }

引用了 iaddQuoted().

被这些函数引用 PerlModDocVisitor::visit() , 以及 PerlModDocVisitor::visitPre().

close()

PerlModOutput& PerlModOutput::close ( char  c = 0 )

inline

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

{ iclose(c); return *this; }

引用了 iclose().

被这些函数引用 closeHash() , 以及 closeList().

closeHash()

PerlModOutput& PerlModOutput::closeHash ( )

inline

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

{ close('}'); return *this; }

引用了 close().

被这些函数引用 PerlModGenerator::addIncludeInfo(), PerlModGenerator::addListOfAllMembers(), addPerlModDocBlock(), addTemplateArgumentList(), PerlModDocVisitor::closeItem(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForConcept(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForNamespace(), PerlModGenerator::generatePerlModForPage(), PerlModGenerator::generatePerlModOutput(), PerlModGenerator::generatePerlModSection(), PerlModGenerator::generatePerlUserDefinedSection(), PerlModDocVisitor::leaveText(), PerlModDocVisitor::visitPost() , 以及 PerlModDocVisitor::visitPre().

closeList()

PerlModOutput& PerlModOutput::closeList ( )

inline

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

{ close(']'); return *this; }

引用了 close().

被这些函数引用 PerlModGenerator::addListOfAllMembers(), addTemplateArgumentList(), PerlModDocVisitor::closeSubBlock(), PerlModDocVisitor::finish(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForNamespace(), PerlModGenerator::generatePerlModOutput(), PerlModGenerator::generatePerlModSection(), PerlModGenerator::generatePerlUserDefinedSection(), PerlModDocVisitor::visitPost() , 以及 PerlModDocVisitor::visitPre().

continueBlock()

PerlModOutput& PerlModOutput::continueBlock ( )

inline

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

  {
    if (m_blockstart)
      m_blockstart = false;
    else
      m_stream->add(',');
    indent();
    return *this;
  }

引用了 PerlModOutputStream::add(), indent(), m_blockstart , 以及 m_stream.

被这些函数引用 iaddField() , 以及 iopen().

decIndent()

void PerlModOutput::decIndent ( )

protected

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

{
  m_indentation--;
  if (m_indentation < PERLOUTPUT_MAX_INDENTATION)
    m_spaces[m_indentation * 2] = 0;
}

引用了 m_indentation, m_spaces , 以及 PERLOUTPUT_MAX_INDENTATION.

被这些函数引用 iclose().

iaddField()

void PerlModOutput::iaddField ( const QCString &  s )

protected

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

{
  continueBlock();
  m_stream->add(s);
  m_stream->add(m_pretty ? " => " : "=>");
}

引用了 PerlModOutputStream::add(), continueBlock(), m_pretty , 以及 m_stream.

被这些函数引用 addField(), iaddFieldQuotedChar(), iaddFieldQuotedString() , 以及 iopen().

iaddFieldQuotedChar()

void PerlModOutput::iaddFieldQuotedChar ( const QCString &  field, char  content  )

protected

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

{
  iaddField(field);
  m_stream->add('\'');
  if ((content == '\'') || (content == '\\'))
    m_stream->add('\\');
  m_stream->add(content);
  m_stream->add('\'');
}

引用了 PerlModOutputStream::add(), iaddField() , 以及 m_stream.

被这些函数引用 addFieldQuotedChar().

iaddFieldQuotedString()

void PerlModOutput::iaddFieldQuotedString ( const QCString &  field, const QCString &  content  )

protected

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

{
  if (content == 0)
    return;
  iaddField(field);
  m_stream->add('\'');
  iaddQuoted(content);
  m_stream->add('\'');
}

引用了 PerlModOutputStream::add(), iaddField(), iaddQuoted() , 以及 m_stream.

被这些函数引用 addFieldQuotedString().

iaddQuoted()

void PerlModOutput::iaddQuoted ( const QCString &  str )

protected

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

{
  if (str.isEmpty()) return;
  const char *s = str.data();
  char c;
  while ((c = *s++) != 0)
  {
    if ((c == '\'') || (c == '\\'))
    {
      m_stream->add('\\');
    }
    m_stream->add(c);
  }
}

引用了 PerlModOutputStream::add(), QCString::data(), QCString::isEmpty() , 以及 m_stream.

被这些函数引用 addQuoted() , 以及 iaddFieldQuotedString().

iclose()

void PerlModOutput::iclose ( char  c )

protected

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

{
  decIndent();
  indent();
  if (c != 0)
    m_stream->add(c);
  m_blockstart = false;
}

引用了 PerlModOutputStream::add(), decIndent(), indent(), m_blockstart , 以及 m_stream.

被这些函数引用 close().

incIndent()

void PerlModOutput::incIndent ( )

protected

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

{
  if (m_indentation < PERLOUTPUT_MAX_INDENTATION)
  {
    char *s = &m_spaces[m_indentation * 2];
    *s++ = ' '; *s++ = ' '; *s = 0;
  }
  m_indentation++;
}

引用了 m_indentation, m_spaces , 以及 PERLOUTPUT_MAX_INDENTATION.

被这些函数引用 iopen().

indent()

PerlModOutput& PerlModOutput::indent ( )

inline

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

  {
    if (m_pretty) {
      m_stream->add('\n');
      m_stream->add(m_spaces);
    }
    return *this;
  }

引用了 PerlModOutputStream::add(), m_pretty, m_spaces , 以及 m_stream.

被这些函数引用 continueBlock() , 以及 iclose().

iopen()

void PerlModOutput::iopen ( char  c, const QCString &  s  )

protected

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

{
  if (s != 0)
    iaddField(s);
  else
    continueBlock();
  m_stream->add(c);
  incIndent();
  m_blockstart = true;
}

引用了 PerlModOutputStream::add(), continueBlock(), iaddField(), incIndent(), m_blockstart , 以及 m_stream.

被这些函数引用 open().

open()

PerlModOutput& PerlModOutput::open ( char  c, const QCString &  s = QCString()  )

inline

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

{ iopen(c, s); return *this; }

引用了 iopen().

被这些函数引用 openHash() , 以及 openList().

openHash()

PerlModOutput& PerlModOutput::openHash ( const QCString &  s = QCString() )

inline

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

{ open('{', s); return *this; }

引用了 open().

被这些函数引用 PerlModGenerator::addIncludeInfo(), PerlModGenerator::addListOfAllMembers(), addPerlModDocBlock(), addTemplateArgumentList(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForConcept(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForNamespace(), PerlModGenerator::generatePerlModForPage(), PerlModGenerator::generatePerlModOutput(), PerlModGenerator::generatePerlModSection(), PerlModGenerator::generatePerlUserDefinedSection(), PerlModDocVisitor::openItem() , 以及 PerlModDocVisitor::visitPre().

openList()

PerlModOutput& PerlModOutput::openList ( const QCString &  s = QCString() )

inline

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

{ open('[', s); return *this; }

引用了 open().

被这些函数引用 PerlModGenerator::addListOfAllMembers(), addTemplateArgumentList(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForNamespace(), PerlModGenerator::generatePerlModOutput(), PerlModGenerator::generatePerlModSection(), PerlModGenerator::generatePerlUserDefinedSection(), PerlModDocVisitor::openSubBlock(), PerlModDocVisitor::PerlModDocVisitor() , 以及 PerlModDocVisitor::visitPre().

setPerlModOutputStream()

void PerlModOutput::setPerlModOutputStream ( PerlModOutputStream *  os )

inline

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

{ m_stream = os; }

引用了 m_stream.

被这些函数引用 PerlModGenerator::generatePerlModOutput().

类成员变量说明

m_blockstart

bool PerlModOutput::m_blockstart

private

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

被这些函数引用 continueBlock(), iclose() , 以及 iopen().

m_indentation

int PerlModOutput::m_indentation

private

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

被这些函数引用 decIndent() , 以及 incIndent().

m_pretty

bool PerlModOutput::m_pretty

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

被这些函数引用 iaddField() , 以及 indent().

m_spaces

char PerlModOutput::m_spaces[PERLOUTPUT_MAX_INDENTATION *2+2]

private

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

被这些函数引用 decIndent(), incIndent(), indent() , 以及 PerlModOutput().

m_stream

PerlModOutputStream* PerlModOutput::m_stream

private

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

被这些函数引用 add(), continueBlock(), iaddField(), iaddFieldQuotedChar(), iaddFieldQuotedString(), iaddQuoted(), iclose(), indent(), iopen() , 以及 setPerlModOutputStream().

---

该类的文档由以下文件生成:

• src/perlmodgen.cpp