XMLCodeGenerator Class Reference

#include <src/xmlgen.h>

Inheritance diagram for XMLCodeGenerator:

Collaboration diagram for XMLCodeGenerator:

Public Member Functions
	XMLCodeGenerator (TextStream *t)
OutputType	type () const override
void	codify (const QCString &text) override
	Generator for producing XML formatted source code.
void	stripCodeComments (bool b) override
void	startSpecialComment () override
void	endSpecialComment () override
void	setStripIndentAmount (size_t amount) override
std::unique_ptr< OutputCodeIntf >	clone () override
void	writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip) override
void	writeTooltip (const QCString &, const DocLinkInfo &, const QCString &, const QCString &, const SourceLinkInfo &, const SourceLinkInfo &) override
void	startCodeLine (int) override
void	endCodeLine () override
void	startFontClass (const QCString &colorClass) override
void	endFontClass () override
void	writeCodeAnchor (const QCString &) override
void	writeLineNumber (const QCString &extRef, const QCString &compId, const QCString &anchorId, int l, bool writeLineAnchor) override
void	startCodeFragment (const QCString &) override
void	endCodeFragment (const QCString &) override
void	startFold (int, const QCString &, const QCString &) override
void	endFold () override
void	finish ()
Public Member Functions inherited from OutputCodeIntf
	OutputCodeIntf ()=default

Private Attributes
TextStream *	m_t
QCString	m_refId
QCString	m_external
int	m_lineNumber = -1
bool	m_isMemberRef = false
size_t	m_col = 0
bool	m_insideCodeLine = false
bool	m_normalHLNeedStartTag = true
bool	m_insideSpecialHL = false
bool	m_stripCodeComments = false
bool	m_hide = false
size_t	m_stripIndentAmount = 0

Detailed Description

Definition at line 20 of file xmlgen.h.

Constructor & Destructor Documentation

XMLCodeGenerator()

XMLCodeGenerator::XMLCodeGenerator

(

TextStream *

t

)

Definition at line 195 of file xmlgen.cpp.

                                                : m_t(t)
{
}

References m_t.

Member Function Documentation

clone()

std::unique_ptr< OutputCodeIntf > XMLCodeGenerator::clone ( )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 32 of file xmlgen.h.

{ return std::make_unique<XMLCodeGenerator>(*this); }

codify()

void XMLCodeGenerator::codify ( const QCString & text )

overridevirtual

Generator for producing XML formatted source code.

Implements OutputCodeIntf.

Definition at line 200 of file xmlgen.cpp.

{
  XML_DB(("(codify \"%s\")\n",qPrint(text)));
  if (!m_hide && m_insideCodeLine && !m_insideSpecialHL && m_normalHLNeedStartTag)
  {
    *m_t << "<highlight class=\"normal\">";
    m_normalHLNeedStartTag=FALSE;
  }
  writeXMLCodeString(m_hide,*m_t,text,m_col,m_stripIndentAmount);
}

References FALSE, m_col, m_hide, m_insideCodeLine, m_insideSpecialHL, m_normalHLNeedStartTag, m_stripIndentAmount, m_t, qPrint(), writeXMLCodeString(), and XML_DB.

endCodeFragment()

void XMLCodeGenerator::endCodeFragment ( const QCString & )

overridevirtual

Implements OutputCodeIntf.

Definition at line 361 of file xmlgen.cpp.

{
  XML_DB(("(endCodeFragment)\n"));
  *m_t << "    </programlisting>\n";
}

References m_t, and XML_DB.

endCodeLine()

void XMLCodeGenerator::endCodeLine ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 286 of file xmlgen.cpp.

{
  if (m_hide) return;
  XML_DB(("(endCodeLine)\n"));
  if (!m_insideSpecialHL && !m_normalHLNeedStartTag)
  {
    *m_t << "</highlight>";
    m_normalHLNeedStartTag=TRUE;
  }
  if (m_insideCodeLine)
  {
    *m_t << "</codeline>\n";
  }
  m_lineNumber = -1;
  m_refId.clear();
  m_external.clear();
  m_insideCodeLine=FALSE;
}

References FALSE, m_external, m_hide, m_insideCodeLine, m_insideSpecialHL, m_lineNumber, m_normalHLNeedStartTag, m_refId, m_t, TRUE, and XML_DB.

Referenced by finish().

endFold()

void XMLCodeGenerator::endFold ( )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 50 of file xmlgen.h.

{}

endFontClass()

void XMLCodeGenerator::endFontClass ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 318 of file xmlgen.cpp.

{
  if (m_hide) return;
  XML_DB(("(endFontClass)\n"));
  *m_t << "</highlight>"; // non DocBook
  m_insideSpecialHL=FALSE;
}

References FALSE, m_hide, m_insideSpecialHL, m_t, and XML_DB.

endSpecialComment()

void XMLCodeGenerator::endSpecialComment ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 216 of file xmlgen.cpp.

{
  m_hide = false;
}

References m_hide.

finish()

void XMLCodeGenerator::finish

(

)

Definition at line 349 of file xmlgen.cpp.

{
  XML_DB(("(finish insideCodeLine=%d)\n",m_insideCodeLine));
  if (m_insideCodeLine) endCodeLine();
}

References endCodeLine(), m_insideCodeLine, and XML_DB.

setStripIndentAmount()

void XMLCodeGenerator::setStripIndentAmount ( size_t amount )

overridevirtual

Implements OutputCodeIntf.

Definition at line 226 of file xmlgen.cpp.

{
  m_stripIndentAmount = amount;
}

References m_stripIndentAmount.

startCodeFragment()

void XMLCodeGenerator::startCodeFragment ( const QCString & )

overridevirtual

Implements OutputCodeIntf.

Definition at line 355 of file xmlgen.cpp.

{
  XML_DB(("(startCodeFragment)\n"));
  *m_t << "    <programlisting>\n";
}

References m_t, and XML_DB.

startCodeLine()

void XMLCodeGenerator::startCodeLine ( int )

overridevirtual

Implements OutputCodeIntf.

Definition at line 255 of file xmlgen.cpp.

{
  m_col=0;
  if (m_hide) return;
  XML_DB(("(startCodeLine)\n"));
  *m_t << "<codeline";
  if (m_lineNumber!=-1)
  {
    *m_t << " lineno=\"" << m_lineNumber << "\"";
    if (!m_refId.isEmpty())
    {
      *m_t << " refid=\"" << m_refId << "\"";
      if (m_isMemberRef)
      {
        *m_t << " refkind=\"member\"";
      }
      else
      {
        *m_t << " refkind=\"compound\"";
      }
    }
    if (!m_external.isEmpty())
    {
      *m_t << " external=\"" << m_external << "\"";
    }
  }
  *m_t << ">";
  m_insideCodeLine=TRUE;
  m_col=0;
}

References m_col, m_external, m_hide, m_insideCodeLine, m_isMemberRef, m_lineNumber, m_refId, m_t, TRUE, and XML_DB.

startFold()

void XMLCodeGenerator::startFold ( int , const QCString & , const QCString &  )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 49 of file xmlgen.h.

{}

startFontClass()

void XMLCodeGenerator::startFontClass ( const QCString & colorClass )

overridevirtual

Implements OutputCodeIntf.

Definition at line 305 of file xmlgen.cpp.

{
  if (m_hide) return;
  XML_DB(("(startFontClass)\n"));
  if (m_insideCodeLine && !m_insideSpecialHL && !m_normalHLNeedStartTag)
  {
    *m_t << "</highlight>";
    m_normalHLNeedStartTag=TRUE;
  }
  *m_t << "<highlight class=\"" << colorClass << "\">"; // non DocBook
  m_insideSpecialHL=TRUE;
}

References m_hide, m_insideCodeLine, m_insideSpecialHL, m_normalHLNeedStartTag, m_t, TRUE, and XML_DB.

startSpecialComment()

void XMLCodeGenerator::startSpecialComment ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 221 of file xmlgen.cpp.

{
  m_hide = m_stripCodeComments;
}

References m_hide, and m_stripCodeComments.

stripCodeComments()

void XMLCodeGenerator::stripCodeComments ( bool b )

overridevirtual

Implements OutputCodeIntf.

Definition at line 211 of file xmlgen.cpp.

{
  m_stripCodeComments = b;
}

References m_stripCodeComments.

type()

OutputType XMLCodeGenerator::type ( ) const

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 25 of file xmlgen.h.

{ return OutputType::XML; }

References XML.

writeCodeAnchor()

void XMLCodeGenerator::writeCodeAnchor ( const QCString & )

overridevirtual

Implements OutputCodeIntf.

Definition at line 326 of file xmlgen.cpp.

{
  if (m_hide) return;
  XML_DB(("(writeCodeAnchor)\n"));
}

References m_hide, and XML_DB.

writeCodeLink()

void XMLCodeGenerator::writeCodeLink ( CodeSymbolType type, const QCString & ref, const QCString & file, const QCString & anchor, const QCString & name, const QCString & tooltip )

overridevirtual

Implements OutputCodeIntf.

Definition at line 231 of file xmlgen.cpp.

{
  if (m_hide) return;
  XML_DB(("(writeCodeLink)\n"));
  if (m_insideCodeLine && !m_insideSpecialHL && m_normalHLNeedStartTag)
  {
    *m_t << "<highlight class=\"normal\">";
    m_normalHLNeedStartTag=FALSE;
  }
  writeXMLLink(*m_t,ref,file,anchor,name,tooltip);
  m_col+=name.length();
}

References FALSE, QCString::length(), m_col, m_hide, m_insideCodeLine, m_insideSpecialHL, m_normalHLNeedStartTag, m_t, writeXMLLink(), and XML_DB.

writeLineNumber()

void XMLCodeGenerator::writeLineNumber ( const QCString & extRef, const QCString & compId, const QCString & anchorId, int l, bool writeLineAnchor )

overridevirtual

Implements OutputCodeIntf.

Definition at line 332 of file xmlgen.cpp.

{
  if (m_hide) return;
  XML_DB(("(writeLineNumber)\n"));
  // we remember the information provided here to use it
  // at the <codeline> start tag.
  m_lineNumber = l;
  if (!compId.isEmpty())
  {
    m_refId=compId;
    if (!anchorId.isEmpty()) m_refId+=QCString("_1")+anchorId;
    m_isMemberRef = anchorId!=nullptr;
    if (!extRef.isEmpty()) m_external=extRef;
  }
}

References QCString::isEmpty(), m_external, m_hide, m_isMemberRef, m_lineNumber, m_refId, and XML_DB.

writeTooltip()

void XMLCodeGenerator::writeTooltip ( const QCString & , const DocLinkInfo & , const QCString & , const QCString & , const SourceLinkInfo & , const SourceLinkInfo &  )

overridevirtual

Implements OutputCodeIntf.

Definition at line 247 of file xmlgen.cpp.

{
  if (m_hide) return;
  XML_DB(("(writeToolTip)\n"));
}

References m_hide, and XML_DB.

Member Data Documentation

m_col

size_t XMLCodeGenerator::m_col = 0

private

Definition at line 60 of file xmlgen.h.

Referenced by codify(), startCodeLine(), and writeCodeLink().

m_external

QCString XMLCodeGenerator::m_external

private

Definition at line 57 of file xmlgen.h.

Referenced by endCodeLine(), startCodeLine(), and writeLineNumber().

m_hide

bool XMLCodeGenerator::m_hide = false

private

Definition at line 66 of file xmlgen.h.

Referenced by codify(), endCodeLine(), endFontClass(), endSpecialComment(), startCodeLine(), startFontClass(), startSpecialComment(), writeCodeAnchor(), writeCodeLink(), writeLineNumber(), and writeTooltip().

m_insideCodeLine

bool XMLCodeGenerator::m_insideCodeLine = false

private

Definition at line 62 of file xmlgen.h.

Referenced by codify(), endCodeLine(), finish(), startCodeLine(), startFontClass(), and writeCodeLink().

m_insideSpecialHL

bool XMLCodeGenerator::m_insideSpecialHL = false

private

Definition at line 64 of file xmlgen.h.

Referenced by codify(), endCodeLine(), endFontClass(), startFontClass(), and writeCodeLink().

m_isMemberRef

bool XMLCodeGenerator::m_isMemberRef = false

private

Definition at line 59 of file xmlgen.h.

Referenced by startCodeLine(), and writeLineNumber().

m_lineNumber

int XMLCodeGenerator::m_lineNumber = -1

private

Definition at line 58 of file xmlgen.h.

Referenced by endCodeLine(), startCodeLine(), and writeLineNumber().

m_normalHLNeedStartTag

bool XMLCodeGenerator::m_normalHLNeedStartTag = true

private

Definition at line 63 of file xmlgen.h.

Referenced by codify(), endCodeLine(), startFontClass(), and writeCodeLink().

m_refId

QCString XMLCodeGenerator::m_refId

private

Definition at line 56 of file xmlgen.h.

Referenced by endCodeLine(), startCodeLine(), and writeLineNumber().

m_stripCodeComments

bool XMLCodeGenerator::m_stripCodeComments = false

private

Definition at line 65 of file xmlgen.h.

Referenced by startSpecialComment(), and stripCodeComments().

m_stripIndentAmount

size_t XMLCodeGenerator::m_stripIndentAmount = 0

private

Definition at line 67 of file xmlgen.h.

Referenced by codify(), and setStripIndentAmount().

m_t

TextStream* XMLCodeGenerator::m_t

private

Definition at line 55 of file xmlgen.h.

Referenced by codify(), endCodeFragment(), endCodeLine(), endFontClass(), startCodeFragment(), startCodeLine(), startFontClass(), writeCodeLink(), and XMLCodeGenerator().

---

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

• src/xmlgen.h
• src/xmlgen.cpp