Generator for Man page output. More...

#include <src/mangen.h>

Inheritance diagram for ManGenerator:

Collaboration diagram for ManGenerator:

Public Member Functions
	ManGenerator ()
	ManGenerator (const ManGenerator &)
ManGenerator &	operator= (const ManGenerator &)
	ManGenerator (ManGenerator &&)=delete
ManGenerator &	operator= (ManGenerator &&)=delete
	~ManGenerator ()
void	clearBuffer ()
void	newParagraph ()
OutputType	type () const override
std::unique_ptr< OutputGenIntf >	clone () override
void	addCodeGen (OutputCodeList &list) override
void	cleanup () override
void	writeDoc (const IDocNodeAST ast, const Definition , const MemberDef *, int, int) override
void	startFile (const DString &name, bool isSource, const DString &manName, const DString &title, int id, int hierarchyLevel) override
void	endFile () override
void	writeSearchInfo () override
void	writeFooter (const DString &) override
void	startPageDoc (const DString &) override
void	endPageDoc () override
void	startIndexSection (IndexSection) override
void	endIndexSection (IndexSection) override
void	writePageLink (const DString &, bool) override
void	startProjectNumber () override
void	endProjectNumber () override
void	writeStyleInfo (int) override
void	startTitleHead (const DString &) override
void	endTitleHead (const DString &, const DString &) override
void	startParagraph (const DString &classDef) override
void	endParagraph () override
void	writeString (const DString &text) override
void	startIndexListItem () override
void	endIndexListItem () override
void	startIndexList () override
void	endIndexList () override
void	startIndexKey () override
void	endIndexKey () override
void	startIndexValue (bool) override
void	endIndexValue (const DString &, bool) override
void	startItemList () override
void	endItemList () override
void	startIndexItem (const DString &ref, const DString &file) override
void	endIndexItem (const DString &ref, const DString &file) override
void	docify (const DString &text) override
void	writeObjectLink (const DString &ref, const DString &file, const DString &anchor, const DString &name) override
void	startTextLink (const DString &, const DString &) override
void	endTextLink () override
void	startTypewriter () override
void	endTypewriter () override
void	startGroupHeader (const DString &, int) override
void	endGroupHeader (int) override
void	startMemberSections () override
void	endMemberSections () override
void	startHeaderSection () override
void	endHeaderSection () override
void	startMemberHeader (const DString &, int) override
void	endMemberHeader () override
void	insertMemberAlign (bool) override
void	insertMemberAlignLeft (MemberItemType, bool) override
void	startMemberSubtitle () override
void	endMemberSubtitle () override
void	startItemListItem () override
void	endItemListItem () override
void	startMemberDocList () override
void	endMemberDocList () override
void	startMemberList () override
void	endMemberList () override
void	startInlineHeader () override
void	endInlineHeader () override
void	startAnonTypeScope (int) override
void	endAnonTypeScope (int) override
void	startMemberItem (const DString &, MemberItemType, const DString &) override
void	endMemberItem (MemberItemType) override
void	startMemberTemplateParams () override
void	endMemberTemplateParams (const DString &, const DString &) override
void	startCompoundTemplateParams () override
void	endCompoundTemplateParams () override
void	startMemberGroupHeader (const DString &, bool) override
void	endMemberGroupHeader (bool) override
void	startMemberGroupDocs () override
void	endMemberGroupDocs () override
void	startMemberGroup () override
void	endMemberGroup (bool) override
void	writeRuler () override
void	writeAnchor (const DString &, const DString &) override
void	startEmphasis () override
void	endEmphasis () override
void	startBold () override
void	endBold () override
void	startBoldEmphasis ()
void	endBoldEmphasis ()
void	lineBreak (const DString &) override
void	writeChar (char c) override
void	startMemberDoc (const DString &, const DString &, const DString &, const DString &, int, int, bool) override
void	endMemberDoc (bool) override
void	startDoxyAnchor (const DString &, const DString &, const DString &, const DString &, const DString &) override
void	endDoxyAnchor (const DString &, const DString &) override
void	addLabel (const DString &, const DString &) override
void	writeLatexSpacing () override
void	writeStartAnnoItem (const DString &type, const DString &file, const DString &path, const DString &name) override
void	startCenter () override
void	endCenter () override
void	startSmall () override
void	endSmall () override
void	startMemberDescription (const DString &, const DString &, bool) override
void	endMemberDescription () override
void	startMemberDeclaration () override
void	endMemberDeclaration (const DString &, const DString &) override
void	writeInheritedSectionTitle (const DString &, const DString &, const DString &, const DString &, const DString &, const DString &) override
void	startExamples () override
void	endExamples () override
void	startDescForItem () override
void	endDescForItem () override
void	startSection (const DString &, const DString &, SectionType) override
void	endSection (const DString &, SectionType) override
void	addIndexItem (const DString &, const DString &) override
void	startIndent () override
void	endIndent () override
void	writeSynopsis () override
void	startClassDiagram () override
void	endClassDiagram (const ClassDiagram &, const DString &, const DString &) override
void	startPageRef () override
void	endPageRef (const DString &, const DString &) override
void	startQuickIndices () override
void	endQuickIndices () override
void	writeSplitBar (const DString &, const DString &) override
void	writeNavigationPath (const DString &) override
void	writeLogo () override
void	writeQuickLinks (HighlightedItem, const DString &, bool) override
void	writeSummaryLink (const DString &, const DString &, const DString &, bool) override
void	writePageOutline () override
void	startContents () override
void	endContents () override
void	writeNonBreakableSpace (int n) override
void	startDescTable (const DString &title, const bool hasInits) override
void	endDescTable () override
void	startDescTableTitle () override
void	endDescTableTitle () override
void	startDescTableRow () override
void	endDescTableRow () override
void	startDescTableInit () override
void	endDescTableInit () override
void	startDescTableData () override
void	endDescTableData () override
void	startDotGraph () override
void	endDotGraph (DotClassGraph &) override
void	startInclDepGraph () override
void	endInclDepGraph (DotInclDepGraph &) override
void	startGroupCollaboration () override
void	endGroupCollaboration (DotGroupCollaboration &) override
void	startCallGraph () override
void	endCallGraph (DotCallGraph &) override
void	startDirDepGraph () override
void	endDirDepGraph (DotDirDeps &) override
void	writeGraphicalHierarchy (DotGfxHierarchyTable &) override
void	startTextBlock (bool) override
void	endTextBlock (bool) override
void	lastIndexPage () override
void	startMemberDocPrefixItem () override
void	endMemberDocPrefixItem () override
void	startMemberDocName (bool) override
void	endMemberDocName () override
void	startParameterType (bool, const DString &) override
void	endParameterType () override
void	startParameterName (bool) override
void	endParameterName () override
void	startParameterExtra () override
void	endParameterExtra (bool, bool, bool) override
void	startParameterDefVal (const char *s) override
void	endParameterDefVal () override
void	startParameterList (bool) override
void	endParameterList () override
void	exceptionEntry (const DString &, bool) override
void	startConstraintList (const DString &) override
void	startConstraintParam () override
void	endConstraintParam () override
void	startConstraintType () override
void	endConstraintType () override
void	startConstraintDocs () override
void	endConstraintDocs () override
void	endConstraintList () override
void	startMemberDocSimple (bool) override
void	endMemberDocSimple (bool) override
void	startInlineMemberType () override
void	endInlineMemberType () override
void	startInlineMemberName () override
void	endInlineMemberName () override
void	startInlineMemberDoc () override
void	endInlineMemberDoc () override
void	startLabels () override
void	writeLabel (const DString &l, bool isLast) override
void	endLabels () override
void	startLocalToc (int) override
void	endLocalToc () override
void	startTocEntry (const SectionInfo *) override
void	endTocEntry (const SectionInfo *) override
void	startPlainFile (const DString &name) override
void	endPlainFile () override
void	startEmbeddedDoc (size_t) override
void	endEmbeddedDoc () override
Public Member Functions inherited from OutputGenerator
	OutputGenerator ()
	OutputGenerator (const DString &dir)
virtual	~OutputGenerator ()=default
DString	dir () const
DString	fileName () const
void	startPlainFile (const DString &name)
void	endPlainFile ()

Static Public Member Functions
static void	init ()

Private Attributes
bool	m_firstCol = true
int	m_col = 0
bool	m_paragraph = true
bool	m_upperCase = false
bool	m_insideTabbing = false
bool	m_inHeader = false
std::unique_ptr< OutputCodeList >	m_codeList
ManCodeGenerator *	m_codeGen

Additional Inherited Members
Public Types inherited from OutputGenerator
enum class	ParamListTypes { Param , RetVal , Exception }
enum class	MemberItemType { Normal , AnonymousStart , AnonymousEnd , Templated }
Protected Attributes inherited from OutputGenerator
TextStream	m_t
DString	m_dir

Detailed Description

Generator for Man page output.

Definition at line 68 of file mangen.h.

Constructor & Destructor Documentation

◆ ManGenerator() [1/3]

ManGenerator::ManGenerator ( )

Definition at line 228 of file mangen.cpp.

  : OutputGenerator(Config_getString(MAN_OUTPUT)+"/"+getSubdir())
  , m_codeList(std::make_unique<OutputCodeList>())
{
  m_codeGen = m_codeList->add<ManCodeGenerator>(&m_t);
}

References Config_getString, getSubdir(), m_codeGen, m_codeList, OutputGenerator::m_t, and OutputGenerator::OutputGenerator().

Referenced by ManGenerator(), ManGenerator(), operator=(), and operator=().

◆ ManGenerator() [2/3]

ManGenerator::ManGenerator ( const ManGenerator & og )

Definition at line 235 of file mangen.cpp.

                                                 : OutputGenerator(og.m_dir), OutputGenIntf()
{
  m_codeList = std::make_unique<OutputCodeList>(*og.m_codeList);
  m_codeGen      = m_codeList->get<ManCodeGenerator>(OutputType::Man);
  m_codeGen->setTextStream(&m_t);
  m_firstCol      = og.m_firstCol;
  m_col           = og.m_col;
  m_paragraph     = og.m_paragraph;
  m_upperCase     = og.m_upperCase;
  m_insideTabbing = og.m_insideTabbing;
  m_inHeader      = og.m_inHeader;
}

References m_codeGen, m_codeList, m_col, OutputGenerator::m_dir, m_firstCol, m_inHeader, m_insideTabbing, m_paragraph, OutputGenerator::m_t, m_upperCase, Man, ManGenerator(), OutputGenerator::OutputGenerator(), and ManCodeGenerator::setTextStream().

◆ ManGenerator() [3/3]

ManGenerator::ManGenerator ( ManGenerator && )

delete

References ManGenerator().

◆ ~ManGenerator()

ManGenerator::~ManGenerator ( )

default

References init().

Member Function Documentation

◆ addCodeGen()

void ManGenerator::addCodeGen ( OutputCodeList & list )

overridevirtual

Implements OutputGenIntf.

Definition at line 268 of file mangen.cpp.

{
  list.add<ManCodeGeneratorDefer>(m_codeGen);
}

References OutputCodeList::add(), and m_codeGen.

◆ addIndexItem()

void ManGenerator::addIndexItem	(	const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 199 of file mangen.h.

199{}

◆ addLabel()

void ManGenerator::addLabel	(	const DString &	,
		const DString &	)

overridevirtual

Implements OutputGenIntf.

Definition at line 553 of file mangen.cpp.

554{

555}

◆ cleanup()

void ManGenerator::cleanup ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 290 of file mangen.cpp.

{
  DString dname = Config_getString(MAN_OUTPUT);
  Dir d(dname.str());
  clearSubDirs(d);
}

References clearSubDirs(), Config_getString, and DString::str().

◆ clearBuffer()

void ManGenerator::clearBuffer ( )

References newParagraph().

◆ clone()

std::unique_ptr< OutputGenIntf > ManGenerator::clone ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 85 of file mangen.h.

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

◆ docify()

void ManGenerator::docify ( const DString & text )

overridevirtual

Implements OutputGenIntf.

Definition at line 460 of file mangen.cpp.

{
  if (!str.empty())
  {
    const char *p=str.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;
      }
    }
    m_firstCol=(c=='\n');
    //printf("%s",str);fflush(stdout);
  }
  m_paragraph=false;
}

References DString::data(), DString::empty(), m_col, m_firstCol, m_paragraph, and OutputGenerator::m_t.

Referenced by startConstraintList(), startDescTable(), startExamples(), startMemberDocSimple(), startParameterDefVal(), writeObjectLink(), and writeString().

◆ endAnonTypeScope()

void ManGenerator::endAnonTypeScope ( int indentLevel )

overridevirtual

Implements OutputGenIntf.

Definition at line 604 of file mangen.cpp.

{
  if (indentLevel==0)
  {
    m_insideTabbing=false;
  }
}

References m_insideTabbing.

◆ endBold()

void ManGenerator::endBold ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 169 of file mangen.h.

169{ m_t << "\\fP"; m_firstCol=false; }

References m_firstCol, and OutputGenerator::m_t.

Referenced by startConstraintList(), startDescTable(), startExamples(), and writeObjectLink().

◆ endBoldEmphasis()

void ManGenerator::endBoldEmphasis ( )

inline

Definition at line 171 of file mangen.h.

171{ m_t << "\\fP"; m_firstCol=false; }

References m_firstCol, and OutputGenerator::m_t.

Referenced by endDescTableTitle().

◆ endCallGraph()

void ManGenerator::endCallGraph ( DotCallGraph & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 237 of file mangen.h.

237{}

◆ endCenter()

void ManGenerator::endCenter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 184 of file mangen.h.

184{}

◆ endClassDiagram()

void ManGenerator::endClassDiagram	(	const ClassDiagram &	,
		const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 204 of file mangen.h.

204{}

◆ endCompoundTemplateParams()

void ManGenerator::endCompoundTemplateParams ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 570 of file mangen.cpp.

{
  m_t << "\"";
}

References OutputGenerator::m_t.

◆ endConstraintDocs()

void ManGenerator::endConstraintDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 806 of file mangen.cpp.

{
  m_t << "\n"; m_firstCol=true;
}

References m_firstCol, and OutputGenerator::m_t.

◆ endConstraintList()

void ManGenerator::endConstraintList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 811 of file mangen.cpp.

812{

813}

◆ endConstraintParam()

void ManGenerator::endConstraintParam ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 785 of file mangen.cpp.

{
  endEmphasis();
  endItemListItem();
  m_t << " : ";
}

References endEmphasis(), endItemListItem(), and OutputGenerator::m_t.

◆ endConstraintType()

void ManGenerator::endConstraintType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 797 of file mangen.cpp.

{
  endEmphasis();
}

References endEmphasis().

◆ endContents()

void ManGenerator::endContents ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 216 of file mangen.h.

216{}

◆ endDescForItem()

void ManGenerator::endDescForItem ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 592 of file mangen.cpp.

593{

594}

Referenced by endDescTable().

◆ endDescTable()

void ManGenerator::endDescTable ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 748 of file mangen.cpp.

{
  endDescForItem();
}

References endDescForItem().

◆ endDescTableData()

void ManGenerator::endDescTableData ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 228 of file mangen.h.

228{}

◆ endDescTableInit()

void ManGenerator::endDescTableInit ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 226 of file mangen.h.

226{}

◆ endDescTableRow()

void ManGenerator::endDescTableRow ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 224 of file mangen.h.

224{}

◆ endDescTableTitle()

void ManGenerator::endDescTableTitle ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 222 of file mangen.h.

222{ endBoldEmphasis(); }

ManGenerator::endBoldEmphasis

void endBoldEmphasis()

Definition mangen.h:171

References endBoldEmphasis().

◆ endDirDepGraph()

void ManGenerator::endDirDepGraph ( DotDirDeps & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 239 of file mangen.h.

239{}

◆ endDotGraph()

void ManGenerator::endDotGraph ( DotClassGraph & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 231 of file mangen.h.

231{}

◆ endDoxyAnchor()

void ManGenerator::endDoxyAnchor	(	const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 177 of file mangen.h.

177{}

◆ endEmbeddedDoc()

void ManGenerator::endEmbeddedDoc ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 293 of file mangen.h.

293{}

◆ endEmphasis()

void ManGenerator::endEmphasis ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 167 of file mangen.h.

167{ m_t << "\\fP"; m_firstCol=false; }

References m_firstCol, and OutputGenerator::m_t.

Referenced by endConstraintParam(), and endConstraintType().

◆ endExamples()

void ManGenerator::endExamples ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 729 of file mangen.cpp.

730{

731}

◆ endFile()

void ManGenerator::endFile ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 344 of file mangen.cpp.

{
  m_t << "\n";
  endPlainFile();
}

References endPlainFile(), and OutputGenerator::m_t.

◆ endGroupCollaboration()

void ManGenerator::endGroupCollaboration ( DotGroupCollaboration & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 235 of file mangen.h.

235{}

◆ endGroupHeader()

void ManGenerator::endGroupHeader ( int )

overridevirtual

Implements OutputGenIntf.

Definition at line 439 of file mangen.cpp.

{
  m_t << "\"\n.PP \n";
  m_firstCol=true;
  m_paragraph=true;
  m_upperCase=false;
}

References m_firstCol, m_paragraph, OutputGenerator::m_t, and m_upperCase.

Referenced by endSection().

◆ endHeaderSection()

void ManGenerator::endHeaderSection ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 903 of file mangen.cpp.

904{

905}

◆ endInclDepGraph()

void ManGenerator::endInclDepGraph ( DotInclDepGraph & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 233 of file mangen.h.

233{}

◆ endIndent()

void ManGenerator::endIndent ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 201 of file mangen.h.

201{}

◆ endIndexItem()

void ManGenerator::endIndexItem	(	const DString &	ref,
		const DString &	file )

overridevirtual

Implements OutputGenIntf.

Definition at line 416 of file mangen.cpp.

417{

418}

◆ endIndexKey()

void ManGenerator::endIndexKey ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 114 of file mangen.h.

114{}

◆ endIndexList()

void ManGenerator::endIndexList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 112 of file mangen.h.

112{ newParagraph(); }

ManGenerator::newParagraph

void newParagraph()

Definition mangen.cpp:381

References newParagraph().

◆ endIndexListItem()

void ManGenerator::endIndexListItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 110 of file mangen.h.

110{}

◆ endIndexSection()

void ManGenerator::endIndexSection ( IndexSection )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 98 of file mangen.h.

98{}

◆ endIndexValue()

void ManGenerator::endIndexValue	(	const DString &	,
		bool	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 116 of file mangen.h.

116{}

◆ endInlineHeader()

void ManGenerator::endInlineHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 825 of file mangen.cpp.

{
  m_t << "\\fP\"\n" << ".in +1c\n";
  m_firstCol = false;
}

References m_firstCol, and OutputGenerator::m_t.

◆ endInlineMemberDoc()

void ManGenerator::endInlineMemberDoc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 881 of file mangen.cpp.

{
  if (!m_firstCol) m_t << "\n";
  m_t << ".br\n";
  m_t << ".PP\n";
  m_firstCol=true;
}

References m_firstCol, and OutputGenerator::m_t.

◆ endInlineMemberName()

void ManGenerator::endInlineMemberName ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 872 of file mangen.cpp.

{
  m_t << "\\fP ";
}

References OutputGenerator::m_t.

◆ endInlineMemberType()

void ManGenerator::endInlineMemberType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 862 of file mangen.cpp.

{
  m_t << " ";
}

References OutputGenerator::m_t.

◆ endItemList()

void ManGenerator::endItemList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 118 of file mangen.h.

118{ newParagraph(); }

References newParagraph().

◆ endItemListItem()

void ManGenerator::endItemListItem ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 507 of file mangen.cpp.

508{

509}

Referenced by endConstraintParam(), and startDescTableTitle().

◆ endLabels()

void ManGenerator::endLabels ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 899 of file mangen.cpp.

900{

901}

◆ endLocalToc()

void ManGenerator::endLocalToc ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 285 of file mangen.h.

285{}

◆ endMemberDeclaration()

void ManGenerator::endMemberDeclaration	(	const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 190 of file mangen.h.

190{}

◆ endMemberDescription()

void ManGenerator::endMemberDescription ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 188 of file mangen.h.

188{ m_t << "\""; m_firstCol=false; }

References m_firstCol, and OutputGenerator::m_t.

◆ endMemberDoc()

void ManGenerator::endMemberDoc ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 557 of file mangen.cpp.

{
    m_t << "\"\n";
}

References OutputGenerator::m_t.

◆ endMemberDocList()

void ManGenerator::endMemberDocList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 143 of file mangen.h.

143{}

◆ endMemberDocName()

void ManGenerator::endMemberDocName ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 249 of file mangen.h.

249{}

◆ endMemberDocPrefixItem()

void ManGenerator::endMemberDocPrefixItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 247 of file mangen.h.

247{}

◆ endMemberDocSimple()

void ManGenerator::endMemberDocSimple ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 850 of file mangen.cpp.

{
  if (!m_firstCol) m_t << "\n";
  m_t << ".RE\n";
  m_t << ".PP\n";
  m_firstCol=true;
}

References m_firstCol, and OutputGenerator::m_t.

◆ endMemberGroup()

void ManGenerator::endMemberGroup ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 666 of file mangen.cpp.

{
  m_t << "\n.in -1c";
  m_firstCol=false;
}

References m_firstCol, and OutputGenerator::m_t.

◆ endMemberGroupDocs()

void ManGenerator::endMemberGroupDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 656 of file mangen.cpp.

{
  m_t << "\n.PP";
}

References OutputGenerator::m_t.

◆ endMemberGroupHeader()

void ManGenerator::endMemberGroupHeader ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 646 of file mangen.cpp.

{
  m_t << "\\fP\"\n.br\n";
  m_firstCol=true;
}

References m_firstCol, and OutputGenerator::m_t.

◆ endMemberHeader()

void ManGenerator::endMemberHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 453 of file mangen.cpp.

{
  m_t << "\"\n";
  m_firstCol=true;
  m_paragraph=false;
}

References m_firstCol, m_paragraph, and OutputGenerator::m_t.

Referenced by endSection().

◆ endMemberItem()

void ManGenerator::endMemberItem ( MemberItemType )

overridevirtual

Implements OutputGenIntf.

Definition at line 620 of file mangen.cpp.

{
  m_t << "\"\n.br";
}

References OutputGenerator::m_t.

◆ endMemberList()

void ManGenerator::endMemberList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 633 of file mangen.cpp.

{
  if (!m_insideTabbing)
  {
    m_t << "\n.in -1c"; m_firstCol=false;
  }
}

References m_firstCol, m_insideTabbing, and OutputGenerator::m_t.

◆ endMemberSections()

void ManGenerator::endMemberSections ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 131 of file mangen.h.

131{}

◆ endMemberSubtitle()

void ManGenerator::endMemberSubtitle ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 139 of file mangen.h.

139{}

◆ endMemberTemplateParams()

void ManGenerator::endMemberTemplateParams	(	const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 153 of file mangen.h.

153{}

◆ endPageDoc()

void ManGenerator::endPageDoc ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 96 of file mangen.h.

96{}

◆ endPageRef()

void ManGenerator::endPageRef	(	const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 206 of file mangen.h.

206{}

◆ endParagraph()

void ManGenerator::endParagraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 403 of file mangen.cpp.

404{

405}

◆ endParameterDefVal()

void ManGenerator::endParameterDefVal ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 257 of file mangen.h.

257{ endTypewriter(); }

ManGenerator::endTypewriter

void endTypewriter() override

Definition mangen.h:127

References endTypewriter().

◆ endParameterExtra()

void ManGenerator::endParameterExtra	(	bool	last,
		bool	,
		bool	closeBracket )

overridevirtual

Implements OutputGenIntf.

Definition at line 922 of file mangen.cpp.

{
  if (last && closeBracket)
  {
    m_t << ")";
  }
}

References OutputGenerator::m_t.

◆ endParameterList()

void ManGenerator::endParameterList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 259 of file mangen.h.

259{}

◆ endParameterName()

void ManGenerator::endParameterName ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 253 of file mangen.h.

253{}

◆ endParameterType()

void ManGenerator::endParameterType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 929 of file mangen.cpp.

{
  m_t << " ";
}

References OutputGenerator::m_t.

◆ endPlainFile()

void ManGenerator::endPlainFile ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 290 of file mangen.h.

290{ OutputGenerator::endPlainFile(); }

OutputGenerator::endPlainFile

void endPlainFile()

Definition outputgen.cpp:42

References OutputGenerator::endPlainFile().

Referenced by endFile().

◆ endProjectNumber()

void ManGenerator::endProjectNumber ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 101 of file mangen.h.

101{}

◆ endQuickIndices()

void ManGenerator::endQuickIndices ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 208 of file mangen.h.

208{}

◆ endSection()

void ManGenerator::endSection	(	const DString &	,
		SectionType	type )

overridevirtual

Implements OutputGenIntf.

Definition at line 690 of file mangen.cpp.

{
  if( !m_inHeader )
  {
    switch(type.level())
    {
      case SectionType::Page:            // fall through
      case SectionType::Section:         endGroupHeader(0); break;
      case SectionType::Subsection:      // fall through
      case SectionType::Subsubsection:   // fall through
      case SectionType::Paragraph:       // fall through
      case SectionType::Subparagraph:    // fall through
      case SectionType::Subsubparagraph: endMemberHeader(); break;
      default: ASSERT(0); break;
    }
  }
  else
  {
    m_t << "\n.PP\n";
    m_firstCol=true;
    m_paragraph=false;
    m_inHeader=false;
  }
}

References ASSERT, endGroupHeader(), endMemberHeader(), SectionType::level(), m_firstCol, m_inHeader, m_paragraph, OutputGenerator::m_t, SectionType::Page, SectionType::Paragraph, SectionType::Section, SectionType::Subparagraph, SectionType::Subsection, SectionType::Subsubparagraph, SectionType::Subsubsection, and type().

◆ endSmall()

void ManGenerator::endSmall ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 186 of file mangen.h.

186{}

◆ endTextBlock()

void ManGenerator::endTextBlock ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 243 of file mangen.h.

243{}

◆ endTextLink()

void ManGenerator::endTextLink ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 125 of file mangen.h.

125{}

◆ endTitleHead()

void ManGenerator::endTitleHead	(	const DString &	,
		const DString &	name )

overridevirtual

Implements OutputGenIntf.

Definition at line 350 of file mangen.cpp.

{
  m_t << ".TH \"" << name << "\" " << getExtension() << " \"";
  switch (Config_getEnum(TIMESTAMP))
  {
    case TIMESTAMP_t::YES:
    case TIMESTAMP_t::DATETIME:
      m_t << dateToString(DateTimeType::DateTime) << "\" \"";
      break;
    case TIMESTAMP_t::DATE:
      m_t << dateToString(DateTimeType::Date) << "\" \"";
      break;
    case TIMESTAMP_t::NO:
      break;
  }
  if (!Config_getString(PROJECT_NUMBER).empty())
    m_t << "Version " << Config_getString(PROJECT_NUMBER) << "\" \"";
  if (Config_getString(PROJECT_NAME).empty())
    m_t << "Doxygen";
  else
    m_t << Config_getString(PROJECT_NAME);
  m_t << "\" \\\" -*- nroff -*-\n";
  m_t << ".ad l\n";
  m_t << ".nh\n";
  m_t << ".SH NAME\n";
  m_t << name;
  m_firstCol=false;
  m_paragraph=true;
  m_inHeader=true;
}

References Config_getEnum, Config_getString, Date, DateTime, dateToString(), getExtension(), m_firstCol, m_inHeader, m_paragraph, and OutputGenerator::m_t.

◆ endTocEntry()

void ManGenerator::endTocEntry ( const SectionInfo * )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 287 of file mangen.h.

287{}

◆ endTypewriter()

void ManGenerator::endTypewriter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 127 of file mangen.h.

127{ m_t << "\\fP"; m_firstCol=false; }

References m_firstCol, and OutputGenerator::m_t.

Referenced by endParameterDefVal().

◆ exceptionEntry()

void ManGenerator::exceptionEntry	(	const DString &	,
		bool	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 260 of file mangen.h.

260{}

◆ init()

void ManGenerator::init ( )

static

Definition at line 273 of file mangen.cpp.

{
  DString manOutput = Config_getString(MAN_OUTPUT);
 
  Dir d(manOutput.str());
  if (!d.exists() && !d.mkdir(manOutput.str()))
  {
    term("Could not create output directory {}\n",manOutput);
  }
  std::string manDir = manOutput.str()+"/"+getSubdir().str();
  if (!d.exists(manDir) && !d.mkdir(manDir))
  {
    term("Could not create output directory {}/{}\n",manOutput,getSubdir());
  }
  createSubDirs(d);
}

References Config_getString, createSubDirs(), Dir::exists(), getSubdir(), Dir::mkdir(), DString::str(), and term.

Referenced by generateOutput(), and ~ManGenerator().

◆ insertMemberAlign()

void ManGenerator::insertMemberAlign ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 136 of file mangen.h.

136{}

◆ insertMemberAlignLeft()

void ManGenerator::insertMemberAlignLeft	(	MemberItemType	,
		bool	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 137 of file mangen.h.

137{}

◆ lastIndexPage()

void ManGenerator::lastIndexPage ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 244 of file mangen.h.

244{}

◆ lineBreak()

void ManGenerator::lineBreak ( const DString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 172 of file mangen.h.

172{ m_t << "\n.br\n"; }

References OutputGenerator::m_t.

◆ newParagraph()

void ManGenerator::newParagraph ( )

Definition at line 381 of file mangen.cpp.

{
  if (!m_paragraph)
  {
    if (!m_firstCol) m_t << "\n";
    m_t << ".PP\n";
    m_firstCol=true;
  }
  m_paragraph=true;
}

References m_firstCol, m_paragraph, and OutputGenerator::m_t.

Referenced by clearBuffer(), endIndexList(), and endItemList().

◆ operator=() [1/2]

ManGenerator & ManGenerator::operator= ( const ManGenerator & og )

Definition at line 248 of file mangen.cpp.

{
  if (this!=&og)
  {
    m_dir           = og.m_dir;
    m_codeList = std::make_unique<OutputCodeList>(*og.m_codeList);
    m_codeGen       = m_codeList->get<ManCodeGenerator>(OutputType::Man);
    m_codeGen->setTextStream(&m_t);
    m_firstCol      = og.m_firstCol;
    m_col           = og.m_col;
    m_paragraph     = og.m_paragraph;
    m_upperCase     = og.m_upperCase;
    m_insideTabbing = og.m_insideTabbing;
    m_inHeader      = og.m_inHeader;
  }
  return *this;
}

References m_codeGen, m_codeList, m_col, OutputGenerator::m_dir, m_firstCol, m_inHeader, m_insideTabbing, m_paragraph, OutputGenerator::m_t, m_upperCase, Man, ManGenerator(), and ManCodeGenerator::setTextStream().

◆ operator=() [2/2]

ManGenerator & ManGenerator::operator= ( ManGenerator && )

delete

References ManGenerator().

◆ startAnonTypeScope()

void ManGenerator::startAnonTypeScope ( int indentLevel )

overridevirtual

Implements OutputGenIntf.

Definition at line 596 of file mangen.cpp.

{
  if (indentLevel==0)
  {
    m_insideTabbing=true;
  }
}

References m_insideTabbing.

◆ startBold()

void ManGenerator::startBold ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 168 of file mangen.h.

168{ m_t << "\\fB"; m_firstCol=false; }

References m_firstCol, and OutputGenerator::m_t.

Referenced by startConstraintList(), startDescTable(), startExamples(), and writeObjectLink().

◆ startBoldEmphasis()

void ManGenerator::startBoldEmphasis ( )

inline

Definition at line 170 of file mangen.h.

170{ m_t << "\\f(BI"; m_firstCol=false; }

References m_firstCol, and OutputGenerator::m_t.

Referenced by startDescTableTitle().

◆ startCallGraph()

void ManGenerator::startCallGraph ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 236 of file mangen.h.

236{}

◆ startCenter()

void ManGenerator::startCenter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 183 of file mangen.h.

183{}

◆ startClassDiagram()

void ManGenerator::startClassDiagram ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 203 of file mangen.h.

203{}

◆ startCompoundTemplateParams()

void ManGenerator::startCompoundTemplateParams ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 562 of file mangen.cpp.

{
  if (!m_firstCol) m_t << "\n";
  m_t << "\n.SS \"";
  m_firstCol=false;
  m_paragraph=false;
}

References m_firstCol, m_paragraph, and OutputGenerator::m_t.

◆ startConstraintDocs()

void ManGenerator::startConstraintDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 802 of file mangen.cpp.

803{

804}

◆ startConstraintList()

void ManGenerator::startConstraintList ( const DString & header )

overridevirtual

Implements OutputGenIntf.

Definition at line 765 of file mangen.cpp.

{
  if (!m_firstCol)
  { m_t << "\n.PP\n";
    m_firstCol=true; m_paragraph=true;
    m_col=0;
  }
  m_paragraph=false;
  startBold();
  docify(header);
  endBold();
  m_paragraph=true;
}

References docify(), endBold(), m_col, m_firstCol, m_paragraph, OutputGenerator::m_t, and startBold().

◆ startConstraintParam()

void ManGenerator::startConstraintParam ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 779 of file mangen.cpp.

{
  startItemListItem();
  startEmphasis();
}

References startEmphasis(), and startItemListItem().

◆ startConstraintType()

void ManGenerator::startConstraintType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 792 of file mangen.cpp.

{
  startEmphasis();
}

References startEmphasis().

◆ startContents()

void ManGenerator::startContents ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 215 of file mangen.h.

215{}

◆ startDescForItem()

void ManGenerator::startDescForItem ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 582 of file mangen.cpp.

{
  if (!m_firstCol) m_t << "\n";
  if (!m_paragraph) m_t << ".in -1c\n";
  m_t << ".in +1c\n";
  m_firstCol=true;
  m_paragraph=false;
  m_col=0;
}

References m_col, m_firstCol, m_paragraph, and OutputGenerator::m_t.

Referenced by startDescTable().

◆ startDescTable()

void ManGenerator::startDescTable	(	const DString &	title,
		const bool	hasInits )

overridevirtual

Implements OutputGenIntf.

Definition at line 733 of file mangen.cpp.

{
  if (!m_firstCol)
  { m_t << "\n.PP\n";
    m_firstCol=true; m_paragraph=true;
    m_col=0;
  }
  m_paragraph=false;
  startBold();
  docify(title);
  endBold();
  m_paragraph=true;
  startDescForItem();
}

References docify(), endBold(), m_col, m_firstCol, m_paragraph, OutputGenerator::m_t, startBold(), and startDescForItem().

◆ startDescTableData()

void ManGenerator::startDescTableData ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 227 of file mangen.h.

227{ m_t << "\n"; m_firstCol=true; }

References m_firstCol, and OutputGenerator::m_t.

◆ startDescTableInit()

void ManGenerator::startDescTableInit ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 225 of file mangen.h.

225{}

◆ startDescTableRow()

void ManGenerator::startDescTableRow ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 223 of file mangen.h.

223{}

◆ startDescTableTitle()

void ManGenerator::startDescTableTitle ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 221 of file mangen.h.

221{ startItemListItem(); startBoldEmphasis(); endItemListItem(); }

ManGenerator::startBoldEmphasis

void startBoldEmphasis()

Definition mangen.h:170

References endItemListItem(), startBoldEmphasis(), and startItemListItem().

◆ startDirDepGraph()

void ManGenerator::startDirDepGraph ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 238 of file mangen.h.

238{}

◆ startDotGraph()

void ManGenerator::startDotGraph ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 230 of file mangen.h.

230{}

◆ startDoxyAnchor()

void ManGenerator::startDoxyAnchor	(	const DString &	,
		const DString &	manName,
		const DString &	,
		const DString &	name,
		const DString &	)

overridevirtual

Implements OutputGenIntf.

Definition at line 519 of file mangen.cpp.

{
    // something to be done?
    if( !Config_getBool(MAN_LINKS) )
    {
      return; // no
    }
 
    // the name of the link file is derived from the name of the anchor:
    // - truncate after an (optional) ::
    DString baseName = name;
    if (size_t i=baseName.rfind("::"); i!=DString::npos)
    {
      baseName=baseName.mid(i+2);
    }
 
    //printf("Converting man link '%s'->'%s'->'%s'\n",
    //       name,qPrint(baseName),qPrint(buildFileName(baseName)));
 
    // - remove dangerous characters and append suffix, then add dir prefix
    DString fileName=dir()+"/"+buildFileName( baseName );
    FileInfo fi(fileName.str());
    if (!fi.exists())
    {
      std::ofstream linkStream = Portable::openOutputStream(fileName);
      if (linkStream.is_open())
      {
        linkStream << ".so " << getSubdir() << "/" << buildFileName( manName ) << "\n";
      }
    }
}

References buildFileName(), Config_getBool, OutputGenerator::dir(), FileInfo::exists(), OutputGenerator::fileName(), getSubdir(), DString::mid(), DString::npos, Portable::openOutputStream(), DString::rfind(), and DString::str().

◆ startEmbeddedDoc()

void ManGenerator::startEmbeddedDoc ( size_t )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 292 of file mangen.h.

292{}

◆ startEmphasis()

void ManGenerator::startEmphasis ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 166 of file mangen.h.

166{ m_t << "\\fI"; m_firstCol=false; }

References m_firstCol, and OutputGenerator::m_t.

Referenced by startConstraintParam(), and startConstraintType().

◆ startExamples()

void ManGenerator::startExamples ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 715 of file mangen.cpp.

{
  if (!m_firstCol)
  { m_t << "\n" << ".PP\n";
    m_firstCol=true; m_paragraph=true;
    m_col=0;
  }
  m_paragraph=false;
  startBold();
  docify(theTranslator->trExamples());
  endBold();
  m_paragraph=true;
}

References docify(), endBold(), m_col, m_firstCol, m_paragraph, OutputGenerator::m_t, startBold(), theTranslator, and Translator::trExamples().

◆ startFile()

void ManGenerator::startFile	(	const DString &	name,
		bool	isSource,
		const DString &	manName,
		const DString &	title,
		int	id,
		int	hierarchyLevel )

overridevirtual

Implements OutputGenIntf.

Definition at line 338 of file mangen.cpp.

{
  startPlainFile( buildFileName( manName ) );
  m_firstCol=true;
}

References buildFileName(), m_firstCol, and startPlainFile().

◆ startGroupCollaboration()

void ManGenerator::startGroupCollaboration ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 234 of file mangen.h.

234{}

◆ startGroupHeader()

void ManGenerator::startGroupHeader	(	const DString &	,
		int	)

overridevirtual

Implements OutputGenIntf.

Definition at line 431 of file mangen.cpp.

{
  if (!m_firstCol) m_t << "\n";
  m_t << ".SH \"";
  m_upperCase=true;
  m_firstCol=false;
}

References m_firstCol, OutputGenerator::m_t, and m_upperCase.

Referenced by startSection().

◆ startHeaderSection()

void ManGenerator::startHeaderSection ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 132 of file mangen.h.

132{}

◆ startInclDepGraph()

void ManGenerator::startInclDepGraph ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 232 of file mangen.h.

232{}

◆ startIndent()

void ManGenerator::startIndent ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 200 of file mangen.h.

200{}

◆ startIndexItem()

void ManGenerator::startIndexItem	(	const DString &	ref,
		const DString &	file )

overridevirtual

Implements OutputGenIntf.

Definition at line 412 of file mangen.cpp.

413{

414}

◆ startIndexKey()

void ManGenerator::startIndexKey ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 113 of file mangen.h.

113{}

◆ startIndexList()

void ManGenerator::startIndexList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 111 of file mangen.h.

111{}

◆ startIndexListItem()

void ManGenerator::startIndexListItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 109 of file mangen.h.

109{}

◆ startIndexSection()

void ManGenerator::startIndexSection ( IndexSection )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 97 of file mangen.h.

97{}

◆ startIndexValue()

void ManGenerator::startIndexValue ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 115 of file mangen.h.

115{}

◆ startInlineHeader()

void ManGenerator::startInlineHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 816 of file mangen.cpp.

{
  if (!m_firstCol)
  {
    m_t << "\n.PP\n" << ".in -1c\n";
  }
  m_t << ".RI \"\\fB";
}

References m_firstCol, and OutputGenerator::m_t.

◆ startInlineMemberDoc()

void ManGenerator::startInlineMemberDoc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 877 of file mangen.cpp.

878{

879}

◆ startInlineMemberName()

void ManGenerator::startInlineMemberName ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 867 of file mangen.cpp.

{
  m_t << "\\fI";
}

References OutputGenerator::m_t.

◆ startInlineMemberType()

void ManGenerator::startInlineMemberType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 858 of file mangen.cpp.

859{

860}

◆ startItemList()

void ManGenerator::startItemList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 117 of file mangen.h.

117{}

◆ startItemListItem()

void ManGenerator::startItemListItem ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 498 of file mangen.cpp.

{
  if (!m_firstCol) m_t << "\n";
  m_t << ".TP\n";
  m_firstCol=true;
  m_paragraph=false;
  m_col=0;
}

References m_col, m_firstCol, m_paragraph, and OutputGenerator::m_t.

Referenced by startConstraintParam(), and startDescTableTitle().

◆ startLabels()

void ManGenerator::startLabels ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 889 of file mangen.cpp.

890{

891}

◆ startLocalToc()

void ManGenerator::startLocalToc ( int )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 284 of file mangen.h.

284{}

◆ startMemberDeclaration()

void ManGenerator::startMemberDeclaration ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 189 of file mangen.h.

189{}

◆ startMemberDescription()

void ManGenerator::startMemberDescription	(	const DString &	,
		const DString &	,
		bool	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 187 of file mangen.h.

187{ m_t << "\n.RI \""; m_firstCol=false; }

References m_firstCol, and OutputGenerator::m_t.

◆ startMemberDoc()

void ManGenerator::startMemberDoc	(	const DString &	,
		const DString &	,
		const DString &	,
		const DString &	,
		int	,
		int	,
		bool	)

overridevirtual

Implements OutputGenIntf.

Definition at line 511 of file mangen.cpp.

{
  if (!m_firstCol) m_t << "\n";
  m_t << ".SS \"";
  m_firstCol=false;
  m_paragraph=false;
}

References m_firstCol, m_paragraph, and OutputGenerator::m_t.

◆ startMemberDocList()

void ManGenerator::startMemberDocList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 142 of file mangen.h.

142{}

◆ startMemberDocName()

void ManGenerator::startMemberDocName ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 248 of file mangen.h.

248{}

◆ startMemberDocPrefixItem()

void ManGenerator::startMemberDocPrefixItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 246 of file mangen.h.

246{}

◆ startMemberDocSimple()

void ManGenerator::startMemberDocSimple ( bool isEnum )

overridevirtual

Implements OutputGenIntf.

Definition at line 831 of file mangen.cpp.

{
  if (!m_firstCol)
  {
    m_t << "\n.PP\n";
  }
  m_t << "\\fB";
  if (isEnum)
  {
    docify(theTranslator->trEnumerationValues());
  }
  else
  {
    docify(theTranslator->trCompoundMembers());
  }
  m_t << ":\\fP\n";
  m_t << ".RS 4\n";
}

References docify(), m_firstCol, OutputGenerator::m_t, theTranslator, Translator::trCompoundMembers(), and Translator::trEnumerationValues().

◆ startMemberGroup()

void ManGenerator::startMemberGroup ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 661 of file mangen.cpp.

{
  m_t << "\n.in +1c";
}

References OutputGenerator::m_t.

◆ startMemberGroupDocs()

void ManGenerator::startMemberGroupDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 652 of file mangen.cpp.

653{

654}

◆ startMemberGroupHeader()

void ManGenerator::startMemberGroupHeader	(	const DString &	,
		bool	)

overridevirtual

Implements OutputGenIntf.

Definition at line 641 of file mangen.cpp.

{
  m_t << "\n.PP\n.RI \"\\fB";
}

References OutputGenerator::m_t.

◆ startMemberHeader()

void ManGenerator::startMemberHeader	(	const DString &	,
		int	)

overridevirtual

Implements OutputGenIntf.

Definition at line 447 of file mangen.cpp.

{
  if (!m_firstCol) m_t << "\n";
  m_t << ".SS \"";
}

References m_firstCol, and OutputGenerator::m_t.

Referenced by startSection().

◆ startMemberItem()

void ManGenerator::startMemberItem	(	const DString &	,
		MemberItemType	,
		const DString &	)

overridevirtual

Implements OutputGenIntf.

Definition at line 613 of file mangen.cpp.

{
  if (m_firstCol && !m_insideTabbing) m_t << ".in +1c\n";
  m_t << "\n.ti -1c\n.RI \"";
  m_firstCol=false;
}

References m_firstCol, m_insideTabbing, and OutputGenerator::m_t.

◆ startMemberList()

void ManGenerator::startMemberList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 625 of file mangen.cpp.

{
  if (!m_insideTabbing)
  {
    m_t << "\n.in +1c"; m_firstCol=false;
  }
}

References m_firstCol, m_insideTabbing, and OutputGenerator::m_t.

◆ startMemberSections()

void ManGenerator::startMemberSections ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 130 of file mangen.h.

130{}

◆ startMemberSubtitle()

void ManGenerator::startMemberSubtitle ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 138 of file mangen.h.

138{}

◆ startMemberTemplateParams()

void ManGenerator::startMemberTemplateParams ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 152 of file mangen.h.

152{}

◆ startPageDoc()

void ManGenerator::startPageDoc ( const DString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 95 of file mangen.h.

95{}

◆ startPageRef()

void ManGenerator::startPageRef ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 205 of file mangen.h.

205{}

◆ startParagraph()

void ManGenerator::startParagraph ( const DString & classDef )

overridevirtual

Implements OutputGenIntf.

Definition at line 392 of file mangen.cpp.

{
  if (!m_paragraph)
  {
    if (!m_firstCol) m_t << "\n";
    m_t << ".PP\n";
    m_firstCol=true;
  }
  m_paragraph=true;
}

References m_firstCol, m_paragraph, and OutputGenerator::m_t.

◆ startParameterDefVal()

void ManGenerator::startParameterDefVal ( const char * s )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 256 of file mangen.h.

256{ docify(s); startTypewriter(); }

ManGenerator::startTypewriter

void startTypewriter() override

Definition mangen.h:126

References docify(), and startTypewriter().

◆ startParameterExtra()

void ManGenerator::startParameterExtra ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 254 of file mangen.h.

254{}

◆ startParameterList()

void ManGenerator::startParameterList ( bool openBracket )

overridevirtual

Implements OutputGenIntf.

Definition at line 917 of file mangen.cpp.

{
  if (openBracket) m_t << "(";
}

References OutputGenerator::m_t.

◆ startParameterName()

void ManGenerator::startParameterName ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 252 of file mangen.h.

252{}

◆ startParameterType()

void ManGenerator::startParameterType	(	bool	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 250 of file mangen.h.

250{}

◆ startPlainFile()

void ManGenerator::startPlainFile ( const DString & name )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 289 of file mangen.h.

289{ OutputGenerator::startPlainFile(name); }

OutputGenerator::startPlainFile

void startPlainFile(const DString &name)

Definition outputgen.cpp:30

References OutputGenerator::startPlainFile().

Referenced by startFile().

◆ startProjectNumber()

void ManGenerator::startProjectNumber ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 100 of file mangen.h.

100{}

◆ startQuickIndices()

void ManGenerator::startQuickIndices ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 207 of file mangen.h.

207{}

◆ startSection()

void ManGenerator::startSection	(	const DString &	,
		const DString &	,
		SectionType	type )

overridevirtual

Implements OutputGenIntf.

Definition at line 672 of file mangen.cpp.

{
  if( !m_inHeader )
  {
    switch(type.level())
    {
      case SectionType::Page:             // fall through
      case SectionType::Section:          startGroupHeader("",0); break;
      case SectionType::Subsection:       // fall through
      case SectionType::Subsubsection:    // fall through
      case SectionType::Paragraph:        // fall through
      case SectionType::Subparagraph:     // fall through
      case SectionType::Subsubparagraph:  startMemberHeader(DString(), -1); break;
      default: ASSERT(0); break;
    }
  }
}

References ASSERT, DString::DString(), SectionType::level(), m_inHeader, SectionType::Page, SectionType::Paragraph, SectionType::Section, startGroupHeader(), startMemberHeader(), SectionType::Subparagraph, SectionType::Subsection, SectionType::Subsubparagraph, SectionType::Subsubsection, and type().

◆ startSmall()

void ManGenerator::startSmall ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 185 of file mangen.h.

185{}

◆ startTextBlock()

void ManGenerator::startTextBlock ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 242 of file mangen.h.

242{}

◆ startTextLink()

void ManGenerator::startTextLink	(	const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 124 of file mangen.h.

124{}

◆ startTitleHead()

void ManGenerator::startTitleHead ( const DString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 103 of file mangen.h.

103{}

◆ startTocEntry()

void ManGenerator::startTocEntry ( const SectionInfo * )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 286 of file mangen.h.

286{}

◆ startTypewriter()

void ManGenerator::startTypewriter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 126 of file mangen.h.

126{ m_t << "\\fR"; m_firstCol=false; }

References m_firstCol, and OutputGenerator::m_t.

Referenced by startParameterDefVal().

◆ type()

OutputType ManGenerator::type ( ) const

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 84 of file mangen.h.

84{ return OutputType::Man; }

References Man.

Referenced by endSection(), and startSection().

◆ writeAnchor()

void ManGenerator::writeAnchor	(	const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 165 of file mangen.h.

165{}

◆ writeChar()

void ManGenerator::writeChar ( char c )

overridevirtual

Implements OutputGenIntf.

Definition at line 484 of file mangen.cpp.

{
  m_firstCol=(c=='\n');
  if (m_firstCol) m_col=0; else m_col++;
  switch (c)
  {
    case '\\': m_t << "\\\\"; break;
  case '\"': c = '\''; // no break!
    default:   m_t << c; break;
  }
  //printf("%c",c);fflush(stdout);
  m_paragraph=false;
}

References m_col, m_firstCol, m_paragraph, and OutputGenerator::m_t.

◆ writeDoc()

void ManGenerator::writeDoc	(	const IDocNodeAST *	ast,
		const Definition *	ctx,
		const MemberDef *	,
		int	,
		int	)

overridevirtual

Implements OutputGenIntf.

Definition at line 753 of file mangen.cpp.

{
  const DocNodeAST *astImpl = dynamic_cast<const DocNodeAST *>(ast);
  if (astImpl)
  {
    ManDocVisitor visitor(m_t,*m_codeList,ctx?ctx->getDefFileExtension():DString(""));
    std::visit(visitor,astImpl->root);
  }
  m_firstCol=false;
  m_paragraph = false;
}

References Definition::getDefFileExtension(), m_codeList, m_firstCol, m_paragraph, OutputGenerator::m_t, and DocNodeAST::root.

◆ writeFooter()

void ManGenerator::writeFooter ( const DString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 93 of file mangen.h.

93{}

◆ writeGraphicalHierarchy()

void ManGenerator::writeGraphicalHierarchy ( DotGfxHierarchyTable & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 240 of file mangen.h.

240{}

◆ writeInheritedSectionTitle()

void ManGenerator::writeInheritedSectionTitle	(	const DString &	,
		const DString &	,
		const DString &	,
		const DString &	,
		const DString &	title,
		const DString &	name )

overridevirtual

Implements OutputGenIntf.

Definition at line 907 of file mangen.cpp.

{
  m_t << "\n\n";
  m_t << theTranslator->trInheritedFrom(docifyToString(title), objectLinkToString(name));
  m_firstCol = false;
}

References docifyToString(), m_firstCol, OutputGenerator::m_t, objectLinkToString(), theTranslator, and Translator::trInheritedFrom().

◆ writeLabel()

void ManGenerator::writeLabel	(	const DString &	l,
		bool	isLast )

overridevirtual

Implements OutputGenIntf.

Definition at line 893 of file mangen.cpp.

{
  m_t << "\\fR [" << l << "]\\fP";
  if (!isLast) m_t << ", ";
}

References OutputGenerator::m_t.

◆ writeLatexSpacing()

void ManGenerator::writeLatexSpacing ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 179 of file mangen.h.

179{}

◆ writeLogo()

void ManGenerator::writeLogo ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 211 of file mangen.h.

211{}

◆ writeNavigationPath()

void ManGenerator::writeNavigationPath ( const DString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 210 of file mangen.h.

210{}

◆ writeNonBreakableSpace()

void ManGenerator::writeNonBreakableSpace ( int n )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 217 of file mangen.h.

217{ for (int i=0;i<n;i++) m_t << " "; }

References OutputGenerator::m_t.

◆ writeObjectLink()

void ManGenerator::writeObjectLink	(	const DString &	ref,
		const DString &	file,
		const DString &	anchor,
		const DString &	name )

overridevirtual

Implements OutputGenIntf.

Definition at line 425 of file mangen.cpp.

{
  startBold(); docify(name); endBold();
}

References docify(), endBold(), and startBold().

◆ writePageLink()

void ManGenerator::writePageLink	(	const DString &	,
		bool	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 99 of file mangen.h.

99{}

◆ writePageOutline()

void ManGenerator::writePageOutline ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 214 of file mangen.h.

214{}

◆ writeQuickLinks()

void ManGenerator::writeQuickLinks	(	HighlightedItem	,
		const DString &	,
		bool	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 212 of file mangen.h.

212{}

◆ writeRuler()

void ManGenerator::writeRuler ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 164 of file mangen.h.

164{}

◆ writeSearchInfo()

void ManGenerator::writeSearchInfo ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 92 of file mangen.h.

92{}

◆ writeSplitBar()

void ManGenerator::writeSplitBar	(	const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 209 of file mangen.h.

209{}

◆ writeStartAnnoItem()

void ManGenerator::writeStartAnnoItem	(	const DString &	type,
		const DString &	file,
		const DString &	path,
		const DString &	name )

overridevirtual

Implements OutputGenIntf.

Definition at line 420 of file mangen.cpp.

422{

423}

◆ writeString()

void ManGenerator::writeString ( const DString & text )

overridevirtual

Implements OutputGenIntf.

Definition at line 407 of file mangen.cpp.

{
  docify(text);
}

References docify().

◆ writeStyleInfo()

void ManGenerator::writeStyleInfo ( int )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 102 of file mangen.h.

102{}

◆ writeSummaryLink()

void ManGenerator::writeSummaryLink	(	const DString &	,
		const DString &	,
		const DString &	,
		bool	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 213 of file mangen.h.

213{}

◆ writeSynopsis()

void ManGenerator::writeSynopsis ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 574 of file mangen.cpp.

{
  if (!m_firstCol) m_t << "\n";
  m_t << ".SH SYNOPSIS\n.br\n.PP\n";
  m_firstCol=true;
  m_paragraph=false;
}

References m_firstCol, m_paragraph, and OutputGenerator::m_t.

Member Data Documentation

◆ m_codeGen

ManCodeGenerator* ManGenerator::m_codeGen

private

Definition at line 303 of file mangen.h.

Referenced by addCodeGen(), ManGenerator(), ManGenerator(), and operator=().

◆ m_codeList

std::unique_ptr<OutputCodeList> ManGenerator::m_codeList

private

Definition at line 302 of file mangen.h.

Referenced by ManGenerator(), ManGenerator(), operator=(), and writeDoc().

◆ m_col

int ManGenerator::m_col = 0

private

Definition at line 297 of file mangen.h.

Referenced by docify(), ManGenerator(), operator=(), startConstraintList(), startDescForItem(), startDescTable(), startExamples(), startItemListItem(), and writeChar().

◆ m_firstCol

bool ManGenerator::m_firstCol = true

private

Definition at line 296 of file mangen.h.

Referenced by docify(), endBold(), endBoldEmphasis(), endConstraintDocs(), endEmphasis(), endGroupHeader(), endInlineHeader(), endInlineMemberDoc(), endMemberDescription(), endMemberDocSimple(), endMemberGroup(), endMemberGroupHeader(), endMemberHeader(), endMemberList(), endSection(), endTitleHead(), endTypewriter(), ManGenerator(), newParagraph(), operator=(), startBold(), startBoldEmphasis(), startCompoundTemplateParams(), startConstraintList(), startDescForItem(), startDescTable(), startDescTableData(), startEmphasis(), startExamples(), startFile(), startGroupHeader(), startInlineHeader(), startItemListItem(), startMemberDescription(), startMemberDoc(), startMemberDocSimple(), startMemberHeader(), startMemberItem(), startMemberList(), startParagraph(), startTypewriter(), writeChar(), writeDoc(), writeInheritedSectionTitle(), and writeSynopsis().

◆ m_inHeader

bool ManGenerator::m_inHeader = false

private

Definition at line 301 of file mangen.h.

Referenced by endSection(), endTitleHead(), ManGenerator(), operator=(), and startSection().

◆ m_insideTabbing

bool ManGenerator::m_insideTabbing = false

private

Definition at line 300 of file mangen.h.

Referenced by endAnonTypeScope(), endMemberList(), ManGenerator(), operator=(), startAnonTypeScope(), startMemberItem(), and startMemberList().

◆ m_paragraph

bool ManGenerator::m_paragraph = true

private

Definition at line 298 of file mangen.h.

Referenced by docify(), endGroupHeader(), endMemberHeader(), endSection(), endTitleHead(), ManGenerator(), newParagraph(), operator=(), startCompoundTemplateParams(), startConstraintList(), startDescForItem(), startDescTable(), startExamples(), startItemListItem(), startMemberDoc(), startParagraph(), writeChar(), writeDoc(), and writeSynopsis().

◆ m_upperCase

bool ManGenerator::m_upperCase = false

private

Definition at line 299 of file mangen.h.

Referenced by endGroupHeader(), ManGenerator(), operator=(), and startGroupHeader().

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

src/mangen.h
src/mangen.cpp

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ManGenerator() [1/3]

◆ ManGenerator() [2/3]

◆ ManGenerator() [3/3]

◆ ~ManGenerator()

Member Function Documentation

◆ addCodeGen()

◆ addIndexItem()

◆ addLabel()

◆ cleanup()

◆ clearBuffer()

◆ clone()

◆ docify()

◆ endAnonTypeScope()

◆ endBold()

◆ endBoldEmphasis()

◆ endCallGraph()

◆ endCenter()

◆ endClassDiagram()

◆ endCompoundTemplateParams()

◆ endConstraintDocs()

◆ endConstraintList()

◆ endConstraintParam()

◆ endConstraintType()

◆ endContents()

◆ endDescForItem()

◆ endDescTable()

◆ endDescTableData()

◆ endDescTableInit()

◆ endDescTableRow()

◆ endDescTableTitle()

◆ endDirDepGraph()

◆ endDotGraph()

◆ endDoxyAnchor()

◆ endEmbeddedDoc()

◆ endEmphasis()

◆ endExamples()

◆ endFile()

◆ endGroupCollaboration()

◆ endGroupHeader()

◆ endHeaderSection()

◆ endInclDepGraph()

◆ endIndent()

◆ endIndexItem()

◆ endIndexKey()

◆ endIndexList()

◆ endIndexListItem()

◆ endIndexSection()

◆ endIndexValue()

◆ endInlineHeader()

◆ endInlineMemberDoc()

◆ endInlineMemberName()

◆ endInlineMemberType()

◆ endItemList()

◆ endItemListItem()

◆ endLabels()

◆ endLocalToc()

◆ endMemberDeclaration()

◆ endMemberDescription()

◆ endMemberDoc()

◆ endMemberDocList()

◆ endMemberDocName()

◆ endMemberDocPrefixItem()

◆ endMemberDocSimple()

◆ endMemberGroup()

◆ endMemberGroupDocs()

◆ endMemberGroupHeader()

◆ endMemberHeader()

◆ endMemberItem()

◆ endMemberList()

◆ endMemberSections()

◆ endMemberSubtitle()

◆ endMemberTemplateParams()

◆ endPageDoc()

◆ endPageRef()