ManCodeGenerator Class Reference

Generator for Man page code fragments. More...

#include <src/mangen.h>

Inheritance diagram for ManCodeGenerator:

Collaboration diagram for ManCodeGenerator:

Public Member Functions
	ManCodeGenerator (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 l, 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 &) override
void	startFold (int, const QCString &, const QCString &) override
void	endFold () override
Public Member Functions inherited from OutputCodeIntf
	OutputCodeIntf ()=default

Private Attributes
size_t	m_col = 0
TextStream *	m_t
bool	m_stripCodeComments = false
bool	m_hide = false
size_t	m_stripIndentAmount = 0

Detailed Description

Generator for Man page code fragments.

Definition at line 24 of file mangen.h.

Constructor & Destructor Documentation

ManCodeGenerator()

ManCodeGenerator::ManCodeGenerator

(

TextStream *

t

)

Definition at line 111 of file mangen.cpp.

                                                : m_t(t)
{
}

References m_t.

Member Function Documentation

clone()

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

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 31 of file mangen.h.

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

codify()

void ManCodeGenerator::codify ( const QCString & text )

overridevirtual

Implements OutputCodeIntf.

Definition at line 162 of file mangen.cpp.

{
  const int tabSize = Config_getInt(TAB_SIZE);
  const size_t stripAmount = m_stripIndentAmount;
  if (!str.isEmpty())
  {
    char c;
    const char *p=str.data();
    if (m_hide)
    {
      m_col = updateColumnCount(p,m_col);
    }
    else
    {
      while ((c=*p++))
      {
        switch(c)
        {
          case '-':  *m_t << "\\-"; break; // see  bug747780
          case '.':   *m_t << "\\&."; break; // see  bug652277
          case '\t':  {
                        int spacesToNextTabStop = tabSize - (m_col%tabSize);
                        while (spacesToNextTabStop--)
                        {
                          if (m_col>=stripAmount) *m_t << " ";
                          m_col++;
                        }
                      }
                      break;
          case ' ':   if (m_col>=stripAmount) *m_t << " ";
                      m_col++;
                      break;
          case '\n':  *m_t << "\n"; m_col=0; break;
          case '\\':  *m_t << "\\\\"; m_col++; break;
          case '\"':  // no break!
          default:    p=writeUTF8Char(*m_t,p-1); m_col++; break;
        }
      }
      //printf("%s",str);fflush(stdout);
    }
  }
}

References Config_getInt, QCString::data(), QCString::isEmpty(), m_col, m_hide, m_stripIndentAmount, m_t, updateColumnCount(), and writeUTF8Char().

Referenced by endCodeLine().

endCodeFragment()

void ManCodeGenerator::endCodeFragment ( const QCString & )

overridevirtual

Implements OutputCodeIntf.

Definition at line 121 of file mangen.cpp.

{
  if (m_col>0) *m_t << "\n";
  *m_t << ".PP\n";
  *m_t << ".fi\n";
  m_col=0;
}

References m_col, and m_t.

endCodeLine()

void ManCodeGenerator::endCodeLine ( )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 50 of file mangen.h.

{ codify("\n"); m_col=0; }

References codify(), and m_col.

endFold()

void ManCodeGenerator::endFold ( )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 57 of file mangen.h.

{}

endFontClass()

void ManCodeGenerator::endFontClass ( )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 52 of file mangen.h.

{}

endSpecialComment()

void ManCodeGenerator::endSpecialComment ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 215 of file mangen.cpp.

{
  m_hide = false;
}

References m_hide.

setStripIndentAmount()

void ManCodeGenerator::setStripIndentAmount ( size_t amount )

overridevirtual

Implements OutputCodeIntf.

Definition at line 220 of file mangen.cpp.

{
  m_stripIndentAmount = amount;
}

References m_stripIndentAmount.

setTextStream()

void ManCodeGenerator::setTextStream ( TextStream * t )

inline

Definition at line 28 of file mangen.h.

{ m_t = t; }

References m_t.

startCodeFragment()

void ManCodeGenerator::startCodeFragment ( const QCString & style )

overridevirtual

Implements OutputCodeIntf.

Definition at line 115 of file mangen.cpp.

{
  *m_t << "\n";
  *m_t << ".nf\n";
}

References m_t.

startCodeLine()

void ManCodeGenerator::startCodeLine ( int )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 49 of file mangen.h.

{}

startFold()

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

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 56 of file mangen.h.

{}

startFontClass()

void ManCodeGenerator::startFontClass ( const QCString & )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 51 of file mangen.h.

{}

startSpecialComment()

void ManCodeGenerator::startSpecialComment ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 210 of file mangen.cpp.

{
  m_hide = m_stripCodeComments;
}

References m_hide, and m_stripCodeComments.

stripCodeComments()

void ManCodeGenerator::stripCodeComments ( bool b )

overridevirtual

Implements OutputCodeIntf.

Definition at line 205 of file mangen.cpp.

{
  m_stripCodeComments = b;
}

References m_stripCodeComments.

type()

OutputType ManCodeGenerator::type ( ) const

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 30 of file mangen.h.

{ return OutputType::Man; }

References Man.

writeCodeAnchor()

void ManCodeGenerator::writeCodeAnchor ( const QCString & )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 53 of file mangen.h.

{}

writeCodeLink()

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

overridevirtual

Implements OutputCodeIntf.

Definition at line 136 of file mangen.cpp.

{
  if (m_hide) return;
  if (!name.isEmpty())
  {
    const char *p=name.data();
    char c=0;
    while ((c=*p++))
    {
      switch(c)
      {
        case '-':  *m_t << "\\-"; break; // see  bug747780
        case '.':  *m_t << "\\&."; break; // see  bug652277
        case '\\': *m_t << "\\\\"; m_col++; break;
        case '\n': *m_t << "\n"; m_col=0; break;
        case '\"':  c = '\''; // no break!
        default: *m_t << c; m_col++; break;
      }
    }
    //printf("%s",str);fflush(stdout);
  }
}

References QCString::data(), QCString::isEmpty(), m_col, m_hide, and m_t.

writeLineNumber()

void ManCodeGenerator::writeLineNumber ( const QCString & , const QCString & , const QCString & , int l, bool  )

overridevirtual

Implements OutputCodeIntf.

Definition at line 129 of file mangen.cpp.

{
  if (m_hide) return;
  *m_t << l << " ";
  m_col=0;
}

References m_col, m_hide, and m_t.

writeTooltip()

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

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 41 of file mangen.h.

                                {}

Member Data Documentation

m_col

size_t ManCodeGenerator::m_col = 0

private

Definition at line 60 of file mangen.h.

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

m_hide

bool ManCodeGenerator::m_hide = false

private

Definition at line 63 of file mangen.h.

Referenced by codify(), endSpecialComment(), startSpecialComment(), writeCodeLink(), and writeLineNumber().

m_stripCodeComments

bool ManCodeGenerator::m_stripCodeComments = false

private

Definition at line 62 of file mangen.h.

Referenced by startSpecialComment(), and stripCodeComments().

m_stripIndentAmount

size_t ManCodeGenerator::m_stripIndentAmount = 0

private

Definition at line 64 of file mangen.h.

Referenced by codify(), and setStripIndentAmount().

m_t

TextStream* ManCodeGenerator::m_t

private

Definition at line 61 of file mangen.h.

Referenced by codify(), endCodeFragment(), ManCodeGenerator(), setTextStream(), startCodeFragment(), writeCodeLink(), and writeLineNumber().

---

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

• src/mangen.h
• src/mangen.cpp