LatexCodeGenerator Class Reference

Generator for LaTeX code fragments. More...

#include <src/latexgen.h>

Inheritance diagram for LatexCodeGenerator:

Collaboration diagram for LatexCodeGenerator:

Public Member Functions
	LatexCodeGenerator (TextStream *t, const QCString &relPath, const QCString &sourceFile)
	LatexCodeGenerator (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	writeLineNumber (const QCString &, const QCString &, const QCString &, int, bool) override
void	startCodeLine (int) override
void	endCodeLine () override
void	startFontClass (const QCString &) override
void	endFontClass () override
void	writeCodeAnchor (const QCString &) 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	incUsedTableLevel ()
void	decUsedTableLevel ()
int	usedTableLevel () const
void	setRelativePath (const QCString &path)
void	setSourceFileName (const QCString &sourceFileName)
void	setInsideTabbing (bool b)
bool	insideTabbing () const
Public Member Functions inherited from OutputCodeIntf
	OutputCodeIntf ()=default

Private Member Functions
void	_writeCodeLink (const QCString &className, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)
void	docify (const QCString &str)

Private Attributes
bool	m_streamSet = false
TextStream *	m_t
QCString	m_relPath
QCString	m_sourceFileName
size_t	m_col = 0
bool	m_doxyCodeLineOpen = false
int	m_usedTableLevel = 0
bool	m_insideTabbing = false
bool	m_stripCodeComments = false
bool	m_hide = false
size_t	m_stripIndentAmount = 0

Detailed Description

Generator for LaTeX code fragments.

Definition at line 27 of file latexgen.h.

Constructor & Destructor Documentation

LatexCodeGenerator() [1/2]

LatexCodeGenerator::LatexCodeGenerator	(	TextStream *	t,
		const QCString &	relPath,
		const QCString &	sourceFile )

Definition at line 58 of file latexgen.cpp.

  : m_t(t), m_relPath(relPath), m_sourceFileName(sourceFileName)
{
}

References m_relPath, m_sourceFileName, and m_t.

LatexCodeGenerator() [2/2]

LatexCodeGenerator::LatexCodeGenerator

(

TextStream *

t

)

Definition at line 63 of file latexgen.cpp.

                                                    : m_t(t)
{
}

References m_t.

Member Function Documentation

_writeCodeLink()

void LatexCodeGenerator::_writeCodeLink ( const QCString & className, const QCString & ref, const QCString & file, const QCString & anchor, const QCString & name, const QCString & tooltip )

private

clone()

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

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 35 of file latexgen.h.

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

codify()

void LatexCodeGenerator::codify ( const QCString & text )

overridevirtual

Implements OutputCodeIntf.

Definition at line 77 of file latexgen.cpp.

{
  if (!str.isEmpty())
  {
    const char *p=str.data();
    char c = 0;
    //char cs[5];
    int tabSize = Config_getInt(TAB_SIZE);
    static THREAD_LOCAL char *result = nullptr;
    static THREAD_LOCAL int lresult = 0;
    if (m_hide) // only update column count
    {
      m_col = updateColumnCount(p,m_col);
    }
    else // actually output content and keep track of m_col
    {
      while ((c=*p))
      {
        switch(c)
        {
          case 0x0c: p++;  // remove ^L
                     break;
          case ' ':  if (m_col>=m_stripIndentAmount)
                     {
                       *m_t << (m_doxyCodeLineOpen ? "\\ " : " ");
                     }
                     m_col++;
                     p++;
                     break;
          case '^':  *m_t <<"\\string^";
                     m_col++;
                     p++;
                     break;
          case '`':  *m_t <<"\\`{}";
                     m_col++;
                     p++;
                     break;
          case '\t': {
                       int spacesToNextTabStop = tabSize - (m_col%tabSize);
                       while (spacesToNextTabStop--)
                       {
                         if (m_col>=m_stripIndentAmount)
                         {
                           *m_t << (m_doxyCodeLineOpen ? "\\ " : " ");
                         }
                         m_col++;
                       }
                       p++;
                     }
                     break;
          case '\n': *m_t << '\n';
                     m_col=0;
                     p++;
                     break;
          default:
                     {
                       int i=0;
 
#undef  COPYCHAR
// helper macro to copy a single utf8 character, dealing with multibyte chars.
#define COPYCHAR() do {                                             \
                       int bytes = getUTF8CharNumBytes(c);          \
                       if (lresult < (i + bytes + 1))               \
                       {                                            \
                         lresult += 512;                            \
                         result = static_cast<char *>(realloc(result, lresult)); \
                       }                                            \
                       for (int j=0; j<bytes && *p; j++)            \
                       {                                            \
                         result[i++]=*p++;                          \
                       }                                            \
                       m_col++;                                     \
                     } while(0)
 
                       // gather characters until we find whitespace or another special character
                       COPYCHAR();
                       while ((c=*p) &&
                              c!=0x0c && c!='\t' && c!='\n' && c!=' ' && c!='^'
                             )
                       {
                         COPYCHAR();
                       }
                       result[i]=0; // add terminator
                       filterLatexString(*m_t,result,
                                         m_insideTabbing, // insideTabbing
                                         true,  // insidePre
                                         false, // insideItem
                                         m_usedTableLevel>0, // insideTable
                                         false  // keepSpaces
                                        );
                     }
                     break;
        }
      }
    }
  }
}

References Config_getInt, COPYCHAR, QCString::data(), filterLatexString(), QCString::isEmpty(), m_col, m_doxyCodeLineOpen, m_hide, m_insideTabbing, m_stripIndentAmount, m_t, m_usedTableLevel, THREAD_LOCAL, and updateColumnCount().

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

decUsedTableLevel()

void LatexCodeGenerator::decUsedTableLevel ( )

inline

Definition at line 65 of file latexgen.h.

{ m_usedTableLevel--; }

References m_usedTableLevel.

docify()

void LatexCodeGenerator::docify ( const QCString & str )

private

endCodeFragment()

void LatexCodeGenerator::endCodeFragment ( const QCString & style )

overridevirtual

Implements OutputCodeIntf.

Definition at line 307 of file latexgen.cpp.

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

References endCodeLine(), m_hide, and m_t.

endCodeLine()

void LatexCodeGenerator::endCodeLine ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 279 of file latexgen.cpp.

{
  if (m_hide) return;
  if (m_doxyCodeLineOpen)
  {
    *m_t << "}";
    m_doxyCodeLineOpen = FALSE;
  }
  codify("\n");
}

References codify(), FALSE, m_doxyCodeLineOpen, m_hide, and m_t.

Referenced by endCodeFragment().

endFold()

void LatexCodeGenerator::endFold ( )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 61 of file latexgen.h.

{}

endFontClass()

void LatexCodeGenerator::endFontClass ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 296 of file latexgen.cpp.

{
  if (m_hide) return;
  *m_t << "}";
}

References m_hide, and m_t.

endSpecialComment()

void LatexCodeGenerator::endSpecialComment ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 185 of file latexgen.cpp.

{
  m_hide = false;
}

References m_hide.

incUsedTableLevel()

void LatexCodeGenerator::incUsedTableLevel ( )

inline

Definition at line 64 of file latexgen.h.

{ m_usedTableLevel++; }

References m_usedTableLevel.

insideTabbing()

bool LatexCodeGenerator::insideTabbing ( ) const

inline

Definition at line 71 of file latexgen.h.

{ return m_insideTabbing; }

References m_insideTabbing.

setInsideTabbing()

void LatexCodeGenerator::setInsideTabbing ( bool b )

inline

Definition at line 70 of file latexgen.h.

{ m_insideTabbing=b; }

References m_insideTabbing.

setRelativePath()

void LatexCodeGenerator::setRelativePath

(

const QCString &

path

)

Definition at line 67 of file latexgen.cpp.

{
  m_relPath = path;
}

References m_relPath.

setSourceFileName()

void LatexCodeGenerator::setSourceFileName

(

const QCString &

sourceFileName

)

Definition at line 72 of file latexgen.cpp.

{
  m_sourceFileName = name;
}

References m_sourceFileName.

setStripIndentAmount()

void LatexCodeGenerator::setStripIndentAmount ( size_t amount )

overridevirtual

Implements OutputCodeIntf.

Definition at line 190 of file latexgen.cpp.

{
  m_stripIndentAmount = amount;
}

References m_stripIndentAmount.

setTextStream()

void LatexCodeGenerator::setTextStream ( TextStream * t )

inline

Definition at line 32 of file latexgen.h.

{ m_t = t; }

References m_t.

startCodeFragment()

void LatexCodeGenerator::startCodeFragment ( const QCString & style )

overridevirtual

Implements OutputCodeIntf.

Definition at line 302 of file latexgen.cpp.

{
  *m_t << "\n\\begin{" << style << "}{" << m_usedTableLevel << "}\n";
}

References m_t, and m_usedTableLevel.

startCodeLine()

void LatexCodeGenerator::startCodeLine ( int )

overridevirtual

Implements OutputCodeIntf.

Definition at line 268 of file latexgen.cpp.

{
  if (m_hide) return;
  m_col=0;
  if (!m_doxyCodeLineOpen)
  {
    *m_t << "\\DoxyCodeLine{";
    m_doxyCodeLineOpen = TRUE;
  }
}

References m_col, m_doxyCodeLineOpen, m_hide, m_t, and TRUE.

startFold()

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

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 60 of file latexgen.h.

{}

startFontClass()

void LatexCodeGenerator::startFontClass ( const QCString & name )

overridevirtual

Implements OutputCodeIntf.

Definition at line 290 of file latexgen.cpp.

{
  if (m_hide) return;
  *m_t << "\\textcolor{" << name << "}{";
}

References m_hide, and m_t.

startSpecialComment()

void LatexCodeGenerator::startSpecialComment ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 180 of file latexgen.cpp.

{
  m_hide = m_stripCodeComments;
}

References m_hide, and m_stripCodeComments.

stripCodeComments()

void LatexCodeGenerator::stripCodeComments ( bool b )

overridevirtual

Implements OutputCodeIntf.

Definition at line 175 of file latexgen.cpp.

{
  m_stripCodeComments = b;
}

References m_stripCodeComments.

type()

OutputType LatexCodeGenerator::type ( ) const

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 34 of file latexgen.h.

{ return OutputType::Latex; }

References Latex.

usedTableLevel()

int LatexCodeGenerator::usedTableLevel ( ) const

inline

Definition at line 66 of file latexgen.h.

{ return m_usedTableLevel; }

References m_usedTableLevel.

writeCodeAnchor()

void LatexCodeGenerator::writeCodeAnchor ( const QCString & )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 57 of file latexgen.h.

{}

writeCodeLink()

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

overridevirtual

Implements OutputCodeIntf.

Definition at line 195 of file latexgen.cpp.

{
  if (m_hide) return;
  bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
  bool usePDFLatex   = Config_getBool(USE_PDFLATEX);
  size_t l = name.length();
  if (ref.isEmpty() && usePDFLatex && pdfHyperlinks)
  {
    *m_t << "\\doxymbox{\\hyperlink{";
    if (!f.isEmpty()) *m_t << stripPath(f);
    if (!f.isEmpty() && !anchor.isEmpty()) *m_t << "_";
    if (!anchor.isEmpty()) *m_t << anchor;
    *m_t << "}{";
    codify(name);
    *m_t << "}}";
  }
  else
  {
    codify(name);
  }
  m_col+=l;
}

References codify(), Config_getBool, QCString::isEmpty(), QCString::length(), m_col, m_hide, m_t, and stripPath().

Referenced by writeLineNumber().

writeLineNumber()

void LatexCodeGenerator::writeLineNumber ( const QCString & ref, const QCString & fileName, const QCString & anchor, int l, bool writeLineAnchor )

overridevirtual

Implements OutputCodeIntf.

Definition at line 221 of file latexgen.cpp.

{
  if (m_hide) return;
  bool usePDFLatex = Config_getBool(USE_PDFLATEX);
  bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
  if (!m_doxyCodeLineOpen)
  {
    *m_t << "\\DoxyCodeLine{";
    m_doxyCodeLineOpen = TRUE;
  }
  if (Config_getBool(SOURCE_BROWSER))
  {
    QCString lineNumber;
    lineNumber.sprintf("%05d",l);
 
    QCString lineAnchor;
    if (!m_sourceFileName.isEmpty())
    {
      lineAnchor.sprintf("_l%05d",l);
      lineAnchor.prepend(stripExtensionGeneral(m_sourceFileName, ".tex"));
    }
    bool showTarget = usePDFLatex && pdfHyperlinks && !lineAnchor.isEmpty() && writeLineAnchor;
    if (showTarget)
    {
      *m_t << "\\Hypertarget{" << stripPath(lineAnchor) << "}";
    }
    if (!fileName.isEmpty())
    {
      writeCodeLink(CodeSymbolType::Default,ref,fileName,anchor,lineNumber,QCString());
    }
    else
    {
      codify(lineNumber);
    }
    *m_t << "\\ ";
  }
  else
  {
    QCString lineNumber;
    lineNumber.sprintf("%05d",l);
    codify(lineNumber);
    *m_t << "\\ ";
  }
  m_col=0;
}

References codify(), Config_getBool, Default, QCString::isEmpty(), m_col, m_doxyCodeLineOpen, m_hide, m_sourceFileName, m_t, QCString::prepend(), QCString::sprintf(), stripExtensionGeneral(), stripPath(), TRUE, and writeCodeLink().

writeTooltip()

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

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 45 of file latexgen.h.

                                 {}

Member Data Documentation

m_col

size_t LatexCodeGenerator::m_col = 0

private

Definition at line 83 of file latexgen.h.

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

m_doxyCodeLineOpen

bool LatexCodeGenerator::m_doxyCodeLineOpen = false

private

Definition at line 84 of file latexgen.h.

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

m_hide

bool LatexCodeGenerator::m_hide = false

private

Definition at line 88 of file latexgen.h.

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

m_insideTabbing

bool LatexCodeGenerator::m_insideTabbing = false

private

Definition at line 86 of file latexgen.h.

Referenced by codify(), insideTabbing(), and setInsideTabbing().

m_relPath

QCString LatexCodeGenerator::m_relPath

private

Definition at line 81 of file latexgen.h.

Referenced by LatexCodeGenerator(), and setRelativePath().

m_sourceFileName

QCString LatexCodeGenerator::m_sourceFileName

private

Definition at line 82 of file latexgen.h.

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

m_streamSet

bool LatexCodeGenerator::m_streamSet = false

private

Definition at line 79 of file latexgen.h.

m_stripCodeComments

bool LatexCodeGenerator::m_stripCodeComments = false

private

Definition at line 87 of file latexgen.h.

Referenced by startSpecialComment(), and stripCodeComments().

m_stripIndentAmount

size_t LatexCodeGenerator::m_stripIndentAmount = 0

private

Definition at line 89 of file latexgen.h.

Referenced by codify(), and setStripIndentAmount().

m_t

TextStream* LatexCodeGenerator::m_t

private

Definition at line 80 of file latexgen.h.

Referenced by codify(), endCodeFragment(), endCodeLine(), endFontClass(), LatexCodeGenerator(), LatexCodeGenerator(), setTextStream(), startCodeFragment(), startCodeLine(), startFontClass(), writeCodeLink(), and writeLineNumber().

m_usedTableLevel

int LatexCodeGenerator::m_usedTableLevel = 0

private

Definition at line 85 of file latexgen.h.

Referenced by codify(), decUsedTableLevel(), incUsedTableLevel(), startCodeFragment(), and usedTableLevel().

---

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

• src/latexgen.h
• src/latexgen.cpp