RTFCodeGenerator Class Reference

Generator for RTF code fragments. More...

#include <src/rtfgen.h>

Inheritance diagram for RTFCodeGenerator:

Collaboration diagram for RTFCodeGenerator:

Public Member Functions
	RTFCodeGenerator (TextStream *t)
void	setTextStream (TextStream *t)
OutputType	type () const override
void	codify (const DString &text) override
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 DString &ref, const DString &file, const DString &anchor, const DString &name, const DString &tooltip) override
void	writeTooltip (const DString &, const DocLinkInfo &, const DString &, const DString &, const SourceLinkInfo &, const SourceLinkInfo &) override
void	writeLineNumber (const DString &, const DString &, const DString &, int l, bool) override
void	startCodeLine (int) override
void	endCodeLine () override
void	startFontClass (const DString &) override
void	endFontClass () override
void	writeCodeAnchor (const DString &) override
void	startCodeFragment (const DString &style) override
void	endCodeFragment (const DString &) override
void	startFold (int, const DString &, const DString &) override
void	endFold () override
Public Member Functions inherited from OutputCodeIntf
	OutputCodeIntf ()=default

Private Member Functions
void	setSourceFileName (const DString &name)
void	setIndentLevel (int level)
DString	rtf_Code_DepthStyle ()

Private Attributes
size_t	m_col = 0
TextStream *	m_t
bool	m_doxyCodeLineOpen = false
DString	m_sourceFileName
int	m_indentLevel = 0
bool	m_stripCodeComments = false
bool	m_hide = false
size_t	m_stripIndentAmount = 0

Friends
class	RTFGenerator

Detailed Description

Generator for RTF code fragments.

Definition at line 27 of file rtfgen.h.

Constructor & Destructor Documentation

RTFCodeGenerator()

RTFCodeGenerator::RTFCodeGenerator

(

TextStream *

t

)

Definition at line 114 of file rtfgen.cpp.

                                                : m_t(t)
{
}

References m_t.

Member Function Documentation

clone()

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

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 39 of file rtfgen.h.

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

codify()

void RTFCodeGenerator::codify ( const DString & text )

overridevirtual

Implements OutputCodeIntf.

Definition at line 153 of file rtfgen.cpp.

{
  // note that RTF does not have a "verbatim", so "\n" means
  // nothing... add a "newParagraph()";
  const int tabSize = Config_getInt(TAB_SIZE);
  if (!str.empty())
  {
    char c;
    const char *p=str.data();
    if (m_hide)
    {
      m_col = updateColumnCount(p,m_col);
    }
    else
    {
      while ((c=*p++))
      {
        switch(c)
        {
          case '\t':  {
                        int spacesToNextTabStop = tabSize - (m_col%tabSize);
                        while (spacesToNextTabStop--)
                        {
                          if (m_col>=m_stripIndentAmount) *m_t << " ";
                          m_col++;
                        }
                      }
                      break;
          case ' ':   if (m_col>=m_stripIndentAmount) *m_t << " ";
                      m_col++;
                      break;
          case '\n':  *m_t << "\\par\n";
                      m_col=0;
                      break;
          case '{':   *m_t << "\\{"; m_col++;          break;
          case '}':   *m_t << "\\}"; m_col++;          break;
          case '\\':  *m_t << "\\\\"; m_col++;         break;
          default:    p=writeUTF8Char(*m_t,p-1); m_col++; break;
        }
      }
    }
  }
}

References Config_getInt, DString::data(), DString::empty(), m_col, m_hide, m_stripIndentAmount, m_t, updateColumnCount(), and writeUTF8Char().

Referenced by writeCodeLink().

endCodeFragment()

void RTFCodeGenerator::endCodeFragment ( const DString & )

overridevirtual

Implements OutputCodeIntf.

Definition at line 225 of file rtfgen.cpp.

{
  bool wasHidden = m_hide;
  m_hide = false;
  endCodeLine();
  m_hide = wasHidden;
 
  DBG_RTF(*m_t << "{\\comment (endCodeFragment) }\n")
  *m_t << "}\n";
  //m_omitParagraph = true;
}

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

endCodeLine()

void RTFCodeGenerator::endCodeLine ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 288 of file rtfgen.cpp.

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

References m_doxyCodeLineOpen, m_hide, and m_t.

Referenced by endCodeFragment().

endFold()

void RTFCodeGenerator::endFold ( )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 60 of file rtfgen.h.

{}

endFontClass()

void RTFCodeGenerator::endFontClass ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 320 of file rtfgen.cpp.

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

References m_hide, and m_t.

endSpecialComment()

void RTFCodeGenerator::endSpecialComment ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 207 of file rtfgen.cpp.

{
  m_hide = false;
}

References m_hide.

rtf_Code_DepthStyle()

DString RTFCodeGenerator::rtf_Code_DepthStyle ( )

private

Definition at line 326 of file rtfgen.cpp.

{
  DString n=makeIndexName("CodeExample",m_indentLevel);
  return rtf_Style[n.str()].reference();
}

References m_indentLevel, makeIndexName(), rtf_Style, and DString::str().

Referenced by startCodeFragment().

setIndentLevel()

void RTFCodeGenerator::setIndentLevel ( int level )

inlineprivate

Definition at line 65 of file rtfgen.h.

{ m_indentLevel=level; }

References m_indentLevel.

Referenced by RTFGenerator::decIndentLevel(), and RTFGenerator::incIndentLevel().

setSourceFileName()

void RTFCodeGenerator::setSourceFileName ( const DString & name )

private

Definition at line 332 of file rtfgen.cpp.

{
  m_sourceFileName = name;
}

References m_sourceFileName.

Referenced by RTFGenerator, and RTFGenerator::setSourceFileName().

setStripIndentAmount()

void RTFCodeGenerator::setStripIndentAmount ( size_t amount )

overridevirtual

Implements OutputCodeIntf.

Definition at line 212 of file rtfgen.cpp.

{
  m_stripIndentAmount = amount;
}

References m_stripIndentAmount.

setTextStream()

void RTFCodeGenerator::setTextStream ( TextStream * t )

inline

Definition at line 31 of file rtfgen.h.

{ m_t = t; }

References m_t.

Referenced by RTFGenerator::operator=(), and RTFGenerator::RTFGenerator().

startCodeFragment()

void RTFCodeGenerator::startCodeFragment ( const DString & style )

overridevirtual

Implements OutputCodeIntf.

Definition at line 217 of file rtfgen.cpp.

{
  DBG_RTF(*m_t << "{\\comment (startCodeFragment) }\n")
  *m_t << "{\n";
  *m_t << "\\par\n";
  *m_t << rtf_Style_Reset << rtf_Code_DepthStyle();
}

References DBG_RTF, m_t, rtf_Code_DepthStyle(), and rtf_Style_Reset.

startCodeLine()

void RTFCodeGenerator::startCodeLine ( int )

overridevirtual

Implements OutputCodeIntf.

Definition at line 281 of file rtfgen.cpp.

{
  if (m_hide) return;
  m_doxyCodeLineOpen = true;
  m_col=0;
}

References m_col, m_doxyCodeLineOpen, and m_hide.

startFold()

void RTFCodeGenerator::startFold ( int , const DString & , const DString &  )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 59 of file rtfgen.h.

{}

startFontClass()

void RTFCodeGenerator::startFontClass ( const DString & name )

overridevirtual

Implements OutputCodeIntf.

Definition at line 295 of file rtfgen.cpp.

{
  if (m_hide) return;
  int cod = 2;
  static const std::unordered_map<std::string,int> map {
   { "keyword",       17 },
   { "keywordtype",   18 },
   { "keywordflow",   19 },
   { "comment",       20 },
   { "preprocessor",  21 },
   { "stringliteral", 22 },
   { "charliteral",   23 },
   { "vhdldigit",     24 },
   { "vhdlchar",      25 },
   { "vhdlkeyword",   26 },
   { "vhdllogic",     27 }
  };
  auto it = map.find(name.str());
  if (it != map.end())
  {
    cod = it->second;
  }
  *m_t << "{\\cf" << cod << " ";
}

References m_hide, m_t, and DString::str().

startSpecialComment()

void RTFCodeGenerator::startSpecialComment ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 202 of file rtfgen.cpp.

{
  m_hide = m_stripCodeComments;
}

References m_hide, and m_stripCodeComments.

stripCodeComments()

void RTFCodeGenerator::stripCodeComments ( bool b )

overridevirtual

Implements OutputCodeIntf.

Definition at line 197 of file rtfgen.cpp.

{
  m_stripCodeComments = b;
}

References m_stripCodeComments.

type()

OutputType RTFCodeGenerator::type ( ) const

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 33 of file rtfgen.h.

{ return OutputType::RTF; }

References RTF.

writeCodeAnchor()

void RTFCodeGenerator::writeCodeAnchor ( const DString & )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 56 of file rtfgen.h.

{}

writeCodeLink()

void RTFCodeGenerator::writeCodeLink ( CodeSymbolType type, const DString & ref, const DString & file, const DString & anchor, const DString & name, const DString & tooltip )

overridevirtual

Implements OutputCodeIntf.

Definition at line 118 of file rtfgen.cpp.

{
  m_col+=name.length();
  if (m_hide) return;
  if (ref.empty() && Config_getBool(RTF_HYPERLINKS))
  {
    DString refName;
    if (!f.empty())
    {
      refName+=stripPath(f);
    }
    if (!anchor.empty())
    {
      refName+='_';
      refName+=anchor;
    }
 
    *m_t << "{\\field {\\*\\fldinst { HYPERLINK  \\\\l \"";
    *m_t << rtfFormatBmkStr(refName);
    *m_t << "\" }{}";
    *m_t << "}{\\fldrslt {\\cs37\\ul\\cf2 ";
 
    codify(name);
 
    *m_t << "}}}\n";
  }
  else
  {
    codify(name);
  }
}

References codify(), Config_getBool, DString::empty(), DString::length(), m_col, m_hide, m_t, rtfFormatBmkStr(), and stripPath().

Referenced by writeLineNumber().

writeLineNumber()

void RTFCodeGenerator::writeLineNumber ( const DString & ref, const DString & fileName, const DString & anchor, int l, bool writeLineAnchor )

overridevirtual

Implements OutputCodeIntf.

Definition at line 237 of file rtfgen.cpp.

{
  if (m_hide) return;
  bool rtfHyperlinks = Config_getBool(RTF_HYPERLINKS);
 
  m_doxyCodeLineOpen = true;
  if (Config_getBool(SOURCE_BROWSER))
  {
    DString lineNumber;
    lineNumber.sprintf("%05d",l);
 
    DString lineAnchor;
    if (!m_sourceFileName.empty())
    {
      lineAnchor.sprintf("_l%05d",l);
      lineAnchor.prepend(stripExtensionGeneral(stripPath(m_sourceFileName), ".rtf"));
    }
    bool showTarget = rtfHyperlinks && !lineAnchor.empty() && writeLineAnchor;
    if (showTarget)
    {
        *m_t << "{\\bkmkstart ";
        *m_t << rtfFormatBmkStr(lineAnchor);
        *m_t << "}";
        *m_t << "{\\bkmkend ";
        *m_t << rtfFormatBmkStr(lineAnchor);
        *m_t << "}\n";
    }
    if (!fileName.empty())
    {
      writeCodeLink(CodeSymbolType::Default,ref,fileName,anchor,lineNumber,DString());
    }
    else
    {
      *m_t << lineNumber;
    }
    *m_t << " ";
  }
  else
  {
    *m_t << l << " ";
  }
  m_col=0;
}

References Config_getBool, Default, DString::DString(), DString::empty(), m_col, m_doxyCodeLineOpen, m_hide, m_sourceFileName, m_t, DString::prepend(), rtfFormatBmkStr(), DString::sprintf(), stripExtensionGeneral(), stripPath(), and writeCodeLink().

writeTooltip()

void RTFCodeGenerator::writeTooltip ( const DString & , const DocLinkInfo & , const DString & , const DString & , const SourceLinkInfo & , const SourceLinkInfo &  )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 44 of file rtfgen.h.

                                {}

Friends And Related Symbol Documentation

RTFGenerator

friend class RTFGenerator

friend

Definition at line 63 of file rtfgen.h.

References RTFGenerator, and setSourceFileName().

Referenced by RTFGenerator.

Member Data Documentation

m_col

size_t RTFCodeGenerator::m_col = 0

private

Definition at line 67 of file rtfgen.h.

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

m_doxyCodeLineOpen

bool RTFCodeGenerator::m_doxyCodeLineOpen = false

private

Definition at line 69 of file rtfgen.h.

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

m_hide

bool RTFCodeGenerator::m_hide = false

private

Definition at line 73 of file rtfgen.h.

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

m_indentLevel

int RTFCodeGenerator::m_indentLevel = 0

private

Definition at line 71 of file rtfgen.h.

Referenced by rtf_Code_DepthStyle(), and setIndentLevel().

m_sourceFileName

DString RTFCodeGenerator::m_sourceFileName

private

Definition at line 70 of file rtfgen.h.

Referenced by setSourceFileName(), and writeLineNumber().

m_stripCodeComments

bool RTFCodeGenerator::m_stripCodeComments = false

private

Definition at line 72 of file rtfgen.h.

Referenced by startSpecialComment(), and stripCodeComments().

m_stripIndentAmount

size_t RTFCodeGenerator::m_stripIndentAmount = 0

private

Definition at line 74 of file rtfgen.h.

Referenced by codify(), and setStripIndentAmount().

m_t

TextStream* RTFCodeGenerator::m_t

private

Definition at line 68 of file rtfgen.h.

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

---

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

• src/rtfgen.h
• src/rtfgen.cpp