DocbookCodeGenerator Class Reference

#include <src/docbookgen.h>

Inheritance diagram for DocbookCodeGenerator:

Collaboration diagram for DocbookCodeGenerator:

Public Member Functions
	DocbookCodeGenerator (TextStream *t)
void	setTextStream (TextStream *t)
OutputType	type () const override
std::unique_ptr< OutputCodeIntf >	clone () override
void	codify (const QCString &text) override
void	stripCodeComments (bool b) override
void	startSpecialComment () override
void	endSpecialComment () override
void	setStripIndentAmount (size_t amount) 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 &style) override
void	endCodeFragment (const QCString &style) override
void	startFold (int, const QCString &, const QCString &) override
void	endFold () override
void	setRelativePath (const QCString &path)
void	setSourceFileName (const QCString &sourceFileName)
QCString	sourceFileName ()
void	finish ()
Public Member Functions inherited from OutputCodeIntf
	OutputCodeIntf ()=default

Private Member Functions
void	writeCodeLinkLine (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip, bool)

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

Detailed Description

Definition at line 47 of file docbookgen.h.

Constructor & Destructor Documentation

DocbookCodeGenerator()

DocbookCodeGenerator::DocbookCodeGenerator

(

TextStream *

t

)

Definition at line 161 of file docbookgen.cpp.

                                                        : m_t(t)
{
}

References m_t.

Member Function Documentation

clone()

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

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 54 of file docbookgen.h.

{ return std::make_unique<DocbookCodeGenerator>(m_t); }

References m_t.

codify()

void DocbookCodeGenerator::codify ( const QCString & text )

overridevirtual

Implements OutputCodeIntf.

Definition at line 165 of file docbookgen.cpp.

{
  Docbook_DB(("(codify \"%s\")\n",text));
  writeDocbookCodeString(m_hide,*m_t,text,m_col,static_cast<size_t>(m_stripIndentAmount));
}

References Docbook_DB, m_col, m_hide, m_stripIndentAmount, m_t, and writeDocbookCodeString().

Referenced by writeLineNumber().

endCodeFragment()

void DocbookCodeGenerator::endCodeFragment ( const QCString & style )

overridevirtual

Implements OutputCodeIntf.

Definition at line 307 of file docbookgen.cpp.

{
DB_GEN_C1(*m_t)
  bool wasHidden = m_hide;
  m_hide = false;
  //endCodeLine checks is there is still an open code line, if so closes it.
  endCodeLine();
  m_hide = wasHidden;
 
  *m_t << "</programlisting>";
}

References DB_GEN_C1, endCodeLine(), m_hide, and m_t.

endCodeLine()

void DocbookCodeGenerator::endCodeLine ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 232 of file docbookgen.cpp.

{
  if (m_hide) return;
  if (m_insideCodeLine) *m_t << "\n";
  Docbook_DB(("(endCodeLine)\n"));
  m_lineNumber = -1;
  m_refId.clear();
  m_external.clear();
  m_insideCodeLine=FALSE;
}

References Docbook_DB, FALSE, m_external, m_hide, m_insideCodeLine, m_lineNumber, m_refId, and m_t.

Referenced by endCodeFragment(), and finish().

endFold()

void DocbookCodeGenerator::endFold ( )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 77 of file docbookgen.h.

{}

endFontClass()

void DocbookCodeGenerator::endFontClass ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 251 of file docbookgen.cpp.

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

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

endSpecialComment()

void DocbookCodeGenerator::endSpecialComment ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 181 of file docbookgen.cpp.

{
  m_hide = false;
}

References m_hide.

finish()

void DocbookCodeGenerator::finish

(

)

Definition at line 296 of file docbookgen.cpp.

{
  endCodeLine();
}

References endCodeLine().

setRelativePath()

void DocbookCodeGenerator::setRelativePath ( const QCString & path )

inline

Definition at line 79 of file docbookgen.h.

{ m_relPath = path; }

References m_relPath.

setSourceFileName()

void DocbookCodeGenerator::setSourceFileName ( const QCString & sourceFileName )

inline

Definition at line 80 of file docbookgen.h.

{ m_sourceFileName = sourceFileName; }

References m_sourceFileName, and sourceFileName().

setStripIndentAmount()

void DocbookCodeGenerator::setStripIndentAmount ( size_t amount )

overridevirtual

Implements OutputCodeIntf.

Definition at line 186 of file docbookgen.cpp.

{
  m_stripIndentAmount = amount;
}

References m_stripIndentAmount.

setTextStream()

void DocbookCodeGenerator::setTextStream ( TextStream * t )

inline

Definition at line 51 of file docbookgen.h.

{ m_t = t; }

References m_t.

sourceFileName()

QCString DocbookCodeGenerator::sourceFileName ( )

inline

Definition at line 81 of file docbookgen.h.

{ return m_sourceFileName; }

References m_sourceFileName.

Referenced by setSourceFileName().

startCodeFragment()

void DocbookCodeGenerator::startCodeFragment ( const QCString & style )

overridevirtual

Implements OutputCodeIntf.

Definition at line 301 of file docbookgen.cpp.

{
DB_GEN_C1(*m_t)
  *m_t << "<programlisting linenumbering=\"unnumbered\">";
}

References DB_GEN_C1, and m_t.

startCodeLine()

void DocbookCodeGenerator::startCodeLine ( int )

overridevirtual

Implements OutputCodeIntf.

Definition at line 224 of file docbookgen.cpp.

{
  if (m_hide) return;
  Docbook_DB(("(startCodeLine)\n"));
  m_insideCodeLine=TRUE;
  m_col=0;
}

References Docbook_DB, m_col, m_hide, m_insideCodeLine, and TRUE.

startFold()

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

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 76 of file docbookgen.h.

{}

startFontClass()

void DocbookCodeGenerator::startFontClass ( const QCString & colorClass )

overridevirtual

Implements OutputCodeIntf.

Definition at line 243 of file docbookgen.cpp.

{
  if (m_hide) return;
  Docbook_DB(("(startFontClass)\n"));
  *m_t << "<emphasis role=\"" << colorClass << "\">";
  m_insideSpecialHL=TRUE;
}

References Docbook_DB, m_hide, m_insideSpecialHL, m_t, and TRUE.

startSpecialComment()

void DocbookCodeGenerator::startSpecialComment ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 176 of file docbookgen.cpp.

{
  m_hide = m_stripCodeComments;
}

References m_hide, and m_stripCodeComments.

stripCodeComments()

void DocbookCodeGenerator::stripCodeComments ( bool b )

overridevirtual

Implements OutputCodeIntf.

Definition at line 171 of file docbookgen.cpp.

{
  m_stripCodeComments = b;
}

References m_stripCodeComments.

type()

OutputType DocbookCodeGenerator::type ( ) const

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 53 of file docbookgen.h.

{ return OutputType::Docbook; }

References Docbook.

writeCodeAnchor()

void DocbookCodeGenerator::writeCodeAnchor ( const QCString & )

overridevirtual

Implements OutputCodeIntf.

Definition at line 259 of file docbookgen.cpp.

{
  Docbook_DB(("(writeCodeAnchor)\n"));
}

References Docbook_DB.

writeCodeLink()

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

overridevirtual

Implements OutputCodeIntf.

Definition at line 191 of file docbookgen.cpp.

{
  if (m_hide) return;
  Docbook_DB(("(writeCodeLink)\n"));
  writeDocbookLink(*m_t,ref,file,anchor,name,tooltip);
  m_col+=name.length();
}

References Docbook_DB, QCString::length(), m_col, m_hide, m_t, and writeDocbookLink().

Referenced by writeLineNumber().

writeCodeLinkLine()

void DocbookCodeGenerator::writeCodeLinkLine ( CodeSymbolType type, const QCString & ref, const QCString & file, const QCString & anchor, const QCString & name, const QCString & tooltip, bool writeLineAnchor )

private

Definition at line 202 of file docbookgen.cpp.

{
  if (m_hide) return;
  Docbook_DB(("(writeCodeLinkLine)\n"));
  if (!writeLineAnchor) return;
  *m_t << "<anchor xml:id=\"_" << stripExtensionGeneral(stripPath(file),".xml");
  *m_t << "_1l";
  writeDocbookString(*m_t,name);
  *m_t << "\"/>";
  m_col+=name.length();
}

References Docbook_DB, QCString::length(), m_col, m_hide, m_t, stripExtensionGeneral(), stripPath(), and writeDocbookString().

Referenced by writeLineNumber().

writeLineNumber()

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

overridevirtual

Implements OutputCodeIntf.

Definition at line 264 of file docbookgen.cpp.

{
  if (m_hide) return;
  Docbook_DB(("(writeLineNumber)\n"));
  m_insideCodeLine = TRUE;
  if (Config_getBool(SOURCE_BROWSER))
  {
    QCString lineNumber;
    lineNumber.sprintf("%05d",l);
 
    if (!m_sourceFileName.isEmpty())
    {
      writeCodeLinkLine(CodeSymbolType::Default,ref,m_sourceFileName,anchor,lineNumber,QCString(),writeLineAnchor);
    }
    if (!fileName.isEmpty())
    {
      writeCodeLink(CodeSymbolType::Default,ref,fileName,anchor,lineNumber,QCString());
    }
    else
    {
      codify(lineNumber);
    }
    *m_t << " ";
  }
  else
  {
    *m_t << l << " ";
  }
  m_col=0;
}

References codify(), Config_getBool, Default, Docbook_DB, QCString::isEmpty(), m_col, m_hide, m_insideCodeLine, m_sourceFileName, m_t, QCString::sprintf(), TRUE, writeCodeLink(), and writeCodeLinkLine().

writeTooltip()

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

overridevirtual

Implements OutputCodeIntf.

Definition at line 217 of file docbookgen.cpp.

{
  Docbook_DB(("(writeToolTip)\n"));
}

References Docbook_DB.

Member Data Documentation

m_col

size_t DocbookCodeGenerator::m_col = 0

private

Definition at line 93 of file docbookgen.h.

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

m_external

QCString DocbookCodeGenerator::m_external

private

Definition at line 91 of file docbookgen.h.

Referenced by endCodeLine().

m_hide

bool DocbookCodeGenerator::m_hide = false

private

Definition at line 99 of file docbookgen.h.

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

m_insideCodeLine

bool DocbookCodeGenerator::m_insideCodeLine = false

private

Definition at line 94 of file docbookgen.h.

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

m_insideSpecialHL

bool DocbookCodeGenerator::m_insideSpecialHL = false

private

Definition at line 95 of file docbookgen.h.

Referenced by endFontClass(), and startFontClass().

m_lineNumber

int DocbookCodeGenerator::m_lineNumber = -1

private

Definition at line 92 of file docbookgen.h.

Referenced by endCodeLine().

m_refId

QCString DocbookCodeGenerator::m_refId

private

Definition at line 90 of file docbookgen.h.

Referenced by endCodeLine().

m_relPath

QCString DocbookCodeGenerator::m_relPath

private

Definition at line 96 of file docbookgen.h.

Referenced by setRelativePath().

m_sourceFileName

QCString DocbookCodeGenerator::m_sourceFileName

private

Definition at line 97 of file docbookgen.h.

Referenced by setSourceFileName(), sourceFileName(), and writeLineNumber().

m_stripCodeComments

bool DocbookCodeGenerator::m_stripCodeComments = false

private

Definition at line 98 of file docbookgen.h.

Referenced by startSpecialComment(), and stripCodeComments().

m_stripIndentAmount

size_t DocbookCodeGenerator::m_stripIndentAmount = 0

private

Definition at line 100 of file docbookgen.h.

Referenced by codify(), and setStripIndentAmount().

m_t

TextStream* DocbookCodeGenerator::m_t

private

Definition at line 89 of file docbookgen.h.

Referenced by clone(), codify(), DocbookCodeGenerator(), endCodeFragment(), endCodeLine(), endFontClass(), setTextStream(), startCodeFragment(), startFontClass(), writeCodeLink(), writeCodeLinkLine(), and writeLineNumber().

---

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

• src/docbookgen.h
• src/docbookgen.cpp