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) override

void	startFile (const QCString &name, const QCString &manName, const QCString &title, int id, int hierarchyLevel) override

void	endFile () override

void	writeSearchInfo () override

void	writeFooter (const QCString &) override

void	startPageDoc (const QCString &) override

void	endPageDoc () override

void	startIndexSection (IndexSection) override

void	endIndexSection (IndexSection) override

void	writePageLink (const QCString &, bool) override

void	startProjectNumber () override

void	endProjectNumber () override

void	writeStyleInfo (int) override

void	startTitleHead (const QCString &) override

void	endTitleHead (const QCString &, const QCString &) override

void	startParagraph (const QCString &classDef) override

void	endParagraph () override

void	writeString (const QCString &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 QCString &, bool) override

void	startItemList () override

void	endItemList () override

void	startIndexItem (const QCString &ref, const QCString &file) override

void	endIndexItem (const QCString &ref, const QCString &file) override

void	docify (const QCString &text) override

void	writeObjectLink (const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name) override

void	startTextLink (const QCString &, const QCString &) override

void	endTextLink () override

void	startTypewriter () override

void	endTypewriter () override

void	startGroupHeader (int) override

void	endGroupHeader (int) override

void	startMemberSections () override

void	endMemberSections () override

void	startHeaderSection () override

void	endHeaderSection () override

void	startMemberHeader (const QCString &, 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 QCString &, MemberItemType, const QCString &) override

void	endMemberItem (MemberItemType) override

void	startMemberTemplateParams () override

void	endMemberTemplateParams (const QCString &, const QCString &) override

void	startCompoundTemplateParams () override

void	endCompoundTemplateParams () override

void	startMemberGroupHeader (bool) override

void	endMemberGroupHeader () override

void	startMemberGroupDocs () override

void	endMemberGroupDocs () override

void	startMemberGroup () override

void	endMemberGroup (bool) override

void	writeRuler () override

void	writeAnchor (const QCString &, const QCString &) override

void	startEmphasis () override

void	endEmphasis () override

void	startBold () override

void	endBold () override

void	lineBreak (const QCString &) override

void	writeChar (char c) override

void	startMemberDoc (const QCString &, const QCString &, const QCString &, const QCString &, int, int, bool) override

void	endMemberDoc (bool) override

void	startDoxyAnchor (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) override

void	endDoxyAnchor (const QCString &, const QCString &) override

void	addLabel (const QCString &, const QCString &) override

void	writeLatexSpacing () override

void	writeStartAnnoItem (const QCString &type, const QCString &file, const QCString &path, const QCString &name) override

void	startCenter () override

void	endCenter () override

void	startSmall () override

void	endSmall () override

void	startMemberDescription (const QCString &, const QCString &, bool) override

void	endMemberDescription () override

void	startMemberDeclaration () override

void	endMemberDeclaration (const QCString &, const QCString &) override

void	writeInheritedSectionTitle (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) override

void	startExamples () override

void	endExamples () override

void	startDescForItem () override

void	endDescForItem () override

void	startSection (const QCString &, const QCString &, SectionType) override

void	endSection (const QCString &, SectionType) override

void	addIndexItem (const QCString &, const QCString &) override

void	startIndent () override

void	endIndent () override

void	writeSynopsis () override

void	startClassDiagram () override

void	endClassDiagram (const ClassDiagram &, const QCString &, const QCString &) override

void	startPageRef () override

void	endPageRef (const QCString &, const QCString &) override

void	startQuickIndices () override

void	endQuickIndices () override

void	writeSplitBar (const QCString &) override

void	writeNavigationPath (const QCString &) override

void	writeLogo () override

void	writeQuickLinks (HighlightedItem, const QCString &) override

void	writeSummaryLink (const QCString &, const QCString &, const QCString &, bool) override

void	startContents () override

void	endContents () override

void	writeNonBreakableSpace (int n) override

void	startDescTable (const QCString &t) override

void	endDescTable () override

void	startDescTableRow () override

void	endDescTableRow () override

void	startDescTableTitle () override

void	endDescTableTitle () 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 QCString &) 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 QCString &, bool) override

void	startConstraintList (const QCString &) 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 QCString &l, bool isLast) override

void	endLabels () override

void	writeLocalToc (const SectionRefs &, const LocalToc &) override

void	startPlainFile (const QCString &name) override

void	endPlainFile () override

Public Member Functions inherited from OutputGenerator
	OutputGenerator ()

	OutputGenerator (const QCString &dir)

virtual	~OutputGenerator ()=default

QCString	dir () const

QCString	fileName () const

void	startPlainFile (const QCString &name)

void	endPlainFile ()

Static Public Member Functions
static void	init ()

Private Member Functions
void	startTitle ()

void	endTitle ()

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

QCString	m_dir

Detailed Description

Generator for Man page output.

Definition at line 61 of file mangen.h.

Constructor & Destructor Documentation

◆ ManGenerator() [1/3]

ManGenerator::ManGenerator ( )

Definition at line 192 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 m_codeGen, m_codeList, and OutputGenerator::m_t.

◆ ManGenerator() [2/3]

ManGenerator::ManGenerator ( const ManGenerator & og )

Definition at line 199 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, m_firstCol, m_inHeader, m_insideTabbing, m_paragraph, OutputGenerator::m_t, m_upperCase, Man, and ManCodeGenerator::setTextStream().

◆ ManGenerator() [3/3]

ManGenerator::ManGenerator ( ManGenerator && )

delete

◆ ~ManGenerator()

ManGenerator::~ManGenerator ( )

default

Member Function Documentation

◆ addCodeGen()

void ManGenerator::addCodeGen ( OutputCodeList & list )

overridevirtual

Implements OutputGenIntf.

Definition at line 232 of file mangen.cpp.

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

References OutputCodeList::add(), and m_codeGen.

◆ addIndexItem()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 189 of file mangen.h.

189{}

◆ addLabel()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 528 of file mangen.cpp.

529{

530}

◆ cleanup()

void ManGenerator::cleanup ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 254 of file mangen.cpp.

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

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

◆ clearBuffer()

void ManGenerator::clearBuffer ( )

◆ clone()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 78 of file mangen.h.

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

◆ docify()

void ManGenerator::docify ( const QCString & text )

overridevirtual

Implements OutputGenIntf.

Definition at line 424 of file mangen.cpp.

{
  if (!str.isEmpty())
  {
    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 QCString::data(), FALSE, QCString::isEmpty(), 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 579 of file mangen.cpp.

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

References FALSE, and m_insideTabbing.

◆ endBold()

void ManGenerator::endBold ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 162 of file mangen.h.

162{ m_t << "\\fP"; m_firstCol=FALSE; }

References FALSE, m_firstCol, and OutputGenerator::m_t.

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

◆ endCallGraph()

void ManGenerator::endCallGraph ( DotCallGraph & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 224 of file mangen.h.

224{}

◆ endCenter()

void ManGenerator::endCenter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 174 of file mangen.h.

174{}

◆ endClassDiagram()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 194 of file mangen.h.

194{}

◆ endCompoundTemplateParams()

void ManGenerator::endCompoundTemplateParams ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 545 of file mangen.cpp.

{
  m_t << "\"";
}

References OutputGenerator::m_t.

◆ endConstraintDocs()

void ManGenerator::endConstraintDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 781 of file mangen.cpp.

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

References m_firstCol, OutputGenerator::m_t, and TRUE.

◆ endConstraintList()

void ManGenerator::endConstraintList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 786 of file mangen.cpp.

787{

788}

◆ endConstraintParam()

void ManGenerator::endConstraintParam ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 760 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 772 of file mangen.cpp.

{
  endEmphasis();
}

References endEmphasis().

◆ endContents()

void ManGenerator::endContents ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 205 of file mangen.h.

205{}

◆ endDescForItem()

void ManGenerator::endDescForItem ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 567 of file mangen.cpp.

568{

569}

Referenced by endDescTable().

◆ endDescTable()

void ManGenerator::endDescTable ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 723 of file mangen.cpp.

{
  endDescForItem();
}

References endDescForItem().

◆ endDescTableData()

void ManGenerator::endDescTableData ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 215 of file mangen.h.

215{}

◆ endDescTableRow()

void ManGenerator::endDescTableRow ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 211 of file mangen.h.

211{}

◆ endDescTableTitle()

void ManGenerator::endDescTableTitle ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 213 of file mangen.h.

213{ endEmphasis(); endBold(); }

ManGenerator::endBold

void endBold() override

Definition mangen.h:162

References endBold(), and endEmphasis().

◆ endDirDepGraph()

void ManGenerator::endDirDepGraph ( DotDirDeps & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 226 of file mangen.h.

226{}

◆ endDotGraph()

void ManGenerator::endDotGraph ( DotClassGraph & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 218 of file mangen.h.

218{}

◆ endDoxyAnchor()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 168 of file mangen.h.

168{}

◆ endEmphasis()

void ManGenerator::endEmphasis ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 160 of file mangen.h.

160{ m_t << "\\fP"; m_firstCol=FALSE; }

References FALSE, m_firstCol, and OutputGenerator::m_t.

Referenced by endConstraintParam(), endConstraintType(), and endDescTableTitle().

◆ endExamples()

void ManGenerator::endExamples ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 704 of file mangen.cpp.

705{

706}

◆ endFile()

void ManGenerator::endFile ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 308 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 222 of file mangen.h.

222{}

◆ endGroupHeader()

void ManGenerator::endGroupHeader ( int )

overridevirtual

Implements OutputGenIntf.

Definition at line 403 of file mangen.cpp.

{
  m_t << "\"\n.PP \n";
  m_firstCol=TRUE;
  m_paragraph=TRUE;
  m_upperCase=FALSE;
}

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

Referenced by endSection().

◆ endHeaderSection()

void ManGenerator::endHeaderSection ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 878 of file mangen.cpp.

879{

880}

◆ endInclDepGraph()

void ManGenerator::endInclDepGraph ( DotInclDepGraph & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 220 of file mangen.h.

220{}

◆ endIndent()

void ManGenerator::endIndent ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 191 of file mangen.h.

191{}

◆ endIndexItem()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 380 of file mangen.cpp.

381{

382}

◆ endIndexKey()

void ManGenerator::endIndexKey ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 107 of file mangen.h.

107{}

◆ endIndexList()

void ManGenerator::endIndexList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 105 of file mangen.h.

105{ newParagraph(); }

ManGenerator::newParagraph

void newParagraph()

Definition mangen.cpp:345

References newParagraph().

◆ endIndexListItem()

void ManGenerator::endIndexListItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 103 of file mangen.h.

103{}

◆ endIndexSection()

void ManGenerator::endIndexSection ( IndexSection )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 91 of file mangen.h.

91{}

◆ endIndexValue()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 109 of file mangen.h.

109{}

◆ endInlineHeader()

void ManGenerator::endInlineHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 800 of file mangen.cpp.

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

References FALSE, m_firstCol, and OutputGenerator::m_t.

◆ endInlineMemberDoc()

void ManGenerator::endInlineMemberDoc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 856 of file mangen.cpp.

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

References m_firstCol, OutputGenerator::m_t, and TRUE.

◆ endInlineMemberName()

void ManGenerator::endInlineMemberName ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 847 of file mangen.cpp.

{
  m_t << "\\fP ";
}

References OutputGenerator::m_t.

◆ endInlineMemberType()

void ManGenerator::endInlineMemberType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 837 of file mangen.cpp.

{
  m_t << " ";
}

References OutputGenerator::m_t.

◆ endItemList()

void ManGenerator::endItemList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 111 of file mangen.h.

111{ newParagraph(); }

References newParagraph().

◆ endItemListItem()

void ManGenerator::endItemListItem ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 484 of file mangen.cpp.

485{

486}

Referenced by endConstraintParam(), and startDescTableTitle().

◆ endLabels()

void ManGenerator::endLabels ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 874 of file mangen.cpp.

875{

876}

◆ endMemberDeclaration()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 180 of file mangen.h.

180{}

◆ endMemberDescription()

void ManGenerator::endMemberDescription ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 178 of file mangen.h.

178{ m_t << "\""; m_firstCol=FALSE; }

References FALSE, m_firstCol, and OutputGenerator::m_t.

◆ endMemberDoc()

void ManGenerator::endMemberDoc ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 532 of file mangen.cpp.

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

References OutputGenerator::m_t.

◆ endMemberDocList()

void ManGenerator::endMemberDocList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 136 of file mangen.h.

136{}

◆ endMemberDocName()

void ManGenerator::endMemberDocName ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 236 of file mangen.h.

236{}

◆ endMemberDocPrefixItem()

void ManGenerator::endMemberDocPrefixItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 234 of file mangen.h.

234{}

◆ endMemberDocSimple()

void ManGenerator::endMemberDocSimple ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 825 of file mangen.cpp.

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

References m_firstCol, OutputGenerator::m_t, and TRUE.

◆ endMemberGroup()

void ManGenerator::endMemberGroup ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 641 of file mangen.cpp.

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

References FALSE, m_firstCol, and OutputGenerator::m_t.

◆ endMemberGroupDocs()

void ManGenerator::endMemberGroupDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 631 of file mangen.cpp.

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

References OutputGenerator::m_t.

◆ endMemberGroupHeader()

void ManGenerator::endMemberGroupHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 621 of file mangen.cpp.

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

References m_firstCol, OutputGenerator::m_t, and TRUE.

◆ endMemberHeader()

void ManGenerator::endMemberHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 417 of file mangen.cpp.

{
  m_t << "\"\n";
  m_firstCol=TRUE;
  m_paragraph=FALSE;
}

References FALSE, m_firstCol, m_paragraph, OutputGenerator::m_t, and TRUE.

Referenced by endSection().

◆ endMemberItem()

void ManGenerator::endMemberItem ( MemberItemType )

overridevirtual

Implements OutputGenIntf.

Definition at line 595 of file mangen.cpp.

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

References OutputGenerator::m_t.

◆ endMemberList()

void ManGenerator::endMemberList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 608 of file mangen.cpp.

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

References FALSE, m_firstCol, m_insideTabbing, and OutputGenerator::m_t.

◆ endMemberSections()

void ManGenerator::endMemberSections ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 124 of file mangen.h.

124{}

◆ endMemberSubtitle()

void ManGenerator::endMemberSubtitle ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 132 of file mangen.h.

132{}

◆ endMemberTemplateParams()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 146 of file mangen.h.

146{}

◆ endPageDoc()

void ManGenerator::endPageDoc ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 89 of file mangen.h.

89{}

◆ endPageRef()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 196 of file mangen.h.

196{}

◆ endParagraph()

void ManGenerator::endParagraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 367 of file mangen.cpp.

368{

369}

◆ endParameterDefVal()

void ManGenerator::endParameterDefVal ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 244 of file mangen.h.

244{ endTypewriter(); }

ManGenerator::endTypewriter

void endTypewriter() override

Definition mangen.h:120

References endTypewriter().

◆ endParameterExtra()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 897 of file mangen.cpp.

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

References OutputGenerator::m_t.

◆ endParameterList()

void ManGenerator::endParameterList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 246 of file mangen.h.

246{}

◆ endParameterName()

void ManGenerator::endParameterName ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 240 of file mangen.h.

240{}

◆ endParameterType()

void ManGenerator::endParameterType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 904 of file mangen.cpp.

{
  m_t << " ";
}

References OutputGenerator::m_t.

◆ endPlainFile()

void ManGenerator::endPlainFile ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 274 of file mangen.h.

274{ OutputGenerator::endPlainFile(); }

OutputGenerator::endPlainFile

void endPlainFile()

Definition outputgen.cpp:44

References OutputGenerator::endPlainFile().

Referenced by endFile().

◆ endProjectNumber()

void ManGenerator::endProjectNumber ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 94 of file mangen.h.

94{}

◆ endQuickIndices()

void ManGenerator::endQuickIndices ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 198 of file mangen.h.

198{}

◆ endSection()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 665 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(), FALSE, m_firstCol, m_inHeader, m_paragraph, OutputGenerator::m_t, SectionType::Page, SectionType::Paragraph, SectionType::Section, SectionType::Subparagraph, SectionType::Subsection, SectionType::Subsubparagraph, SectionType::Subsubsection, TRUE, and type().

◆ endSmall()

void ManGenerator::endSmall ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 176 of file mangen.h.

176{}

◆ endTextBlock()

void ManGenerator::endTextBlock ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 230 of file mangen.h.

230{}

◆ endTextLink()

void ManGenerator::endTextLink ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 118 of file mangen.h.

118{}

◆ endTitle()

void ManGenerator::endTitle ( )

private

Definition at line 470 of file mangen.cpp.

{
    m_t << "\"";
}

References OutputGenerator::m_t.

◆ endTitleHead()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 314 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).isEmpty())
    m_t << "Version " << Config_getString(PROJECT_NUMBER) << "\" \"";
  if (Config_getString(PROJECT_NAME).isEmpty())
    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(), FALSE, getExtension(), m_firstCol, m_inHeader, m_paragraph, OutputGenerator::m_t, and TRUE.

◆ endTypewriter()

void ManGenerator::endTypewriter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 120 of file mangen.h.

120{ m_t << "\\fP"; m_firstCol=FALSE; }

References FALSE, m_firstCol, and OutputGenerator::m_t.

Referenced by endParameterDefVal().

◆ exceptionEntry()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 247 of file mangen.h.

247{}

◆ init()

void ManGenerator::init ( )

static

Definition at line 237 of file mangen.cpp.

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

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

Referenced by generateOutput().

◆ insertMemberAlign()

void ManGenerator::insertMemberAlign ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 129 of file mangen.h.

129{}

◆ insertMemberAlignLeft()

void ManGenerator::insertMemberAlignLeft	(	MemberItemType	,
		bool	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 130 of file mangen.h.

130{}

◆ lastIndexPage()

void ManGenerator::lastIndexPage ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 231 of file mangen.h.

231{}

◆ lineBreak()

void ManGenerator::lineBreak ( const QCString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 163 of file mangen.h.

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

References OutputGenerator::m_t.

◆ newParagraph()

void ManGenerator::newParagraph ( )

Definition at line 345 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, OutputGenerator::m_t, and TRUE.

Referenced by endIndexList(), and endItemList().

◆ operator=() [1/2]

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

Definition at line 212 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, and ManCodeGenerator::setTextStream().

◆ operator=() [2/2]

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

delete

◆ startAnonTypeScope()

void ManGenerator::startAnonTypeScope ( int indentLevel )

overridevirtual

Implements OutputGenIntf.

Definition at line 571 of file mangen.cpp.

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

References m_insideTabbing, and TRUE.

◆ startBold()

void ManGenerator::startBold ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 161 of file mangen.h.

161{ m_t << "\\fB"; m_firstCol=FALSE; }

References FALSE, m_firstCol, and OutputGenerator::m_t.

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

◆ startCallGraph()

void ManGenerator::startCallGraph ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 223 of file mangen.h.

223{}

◆ startCenter()

void ManGenerator::startCenter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 173 of file mangen.h.

173{}

◆ startClassDiagram()

void ManGenerator::startClassDiagram ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 193 of file mangen.h.

193{}

◆ startCompoundTemplateParams()

void ManGenerator::startCompoundTemplateParams ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 537 of file mangen.cpp.

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

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

◆ startConstraintDocs()

void ManGenerator::startConstraintDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 777 of file mangen.cpp.

778{

779}

◆ startConstraintList()

void ManGenerator::startConstraintList ( const QCString & header )

overridevirtual

Implements OutputGenIntf.

Definition at line 740 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(), FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t, startBold(), and TRUE.

◆ startConstraintParam()

void ManGenerator::startConstraintParam ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 754 of file mangen.cpp.

{
  startItemListItem();
  startEmphasis();
}

References startEmphasis(), and startItemListItem().

◆ startConstraintType()

void ManGenerator::startConstraintType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 767 of file mangen.cpp.

{
  startEmphasis();
}

References startEmphasis().

◆ startContents()

void ManGenerator::startContents ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 204 of file mangen.h.

204{}

◆ startDescForItem()

void ManGenerator::startDescForItem ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 557 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 FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t, and TRUE.

Referenced by startDescTable().

◆ startDescTable()

void ManGenerator::startDescTable ( const QCString & t )

overridevirtual

Implements OutputGenIntf.

Definition at line 708 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(), FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t, startBold(), startDescForItem(), and TRUE.

◆ startDescTableData()

void ManGenerator::startDescTableData ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 214 of file mangen.h.

214{ m_t << "\n"; m_firstCol=TRUE; }

References m_firstCol, OutputGenerator::m_t, and TRUE.

◆ startDescTableRow()

void ManGenerator::startDescTableRow ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 210 of file mangen.h.

210{}

◆ startDescTableTitle()

void ManGenerator::startDescTableTitle ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 212 of file mangen.h.

212{ startItemListItem(); startBold(); startEmphasis(); endItemListItem(); }

References endItemListItem(), startBold(), startEmphasis(), and startItemListItem().

◆ startDirDepGraph()

void ManGenerator::startDirDepGraph ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 225 of file mangen.h.

225{}

◆ startDotGraph()

void ManGenerator::startDotGraph ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 217 of file mangen.h.

217{}

◆ startDoxyAnchor()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 496 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) ::
    QCString baseName = name;
    int i=baseName.findRev("::");
    if (i!=-1) baseName=baseName.right(baseName.length()-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
    QCString 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(), QCString::findRev(), getSubdir(), QCString::length(), Portable::openOutputStream(), QCString::right(), and QCString::str().

◆ startEmphasis()

void ManGenerator::startEmphasis ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 159 of file mangen.h.

159{ m_t << "\\fI"; m_firstCol=FALSE; }

References FALSE, m_firstCol, and OutputGenerator::m_t.

Referenced by startConstraintParam(), startConstraintType(), and startDescTableTitle().

◆ startExamples()

void ManGenerator::startExamples ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 690 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(), FALSE, m_col, m_firstCol, m_paragraph, OutputGenerator::m_t, startBold(), theTranslator, Translator::trExamples(), and TRUE.

◆ startFile()

void ManGenerator::startFile	(	const QCString &	name,
		const QCString &	manName,
		const QCString &	title,
		int	id,
		int	hierarchyLevel )

overridevirtual

Implements OutputGenIntf.

Definition at line 302 of file mangen.cpp.

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

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

◆ startGroupCollaboration()

void ManGenerator::startGroupCollaboration ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 221 of file mangen.h.

221{}

◆ startGroupHeader()

void ManGenerator::startGroupHeader ( int )

overridevirtual

Implements OutputGenIntf.

Definition at line 395 of file mangen.cpp.

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

References FALSE, m_firstCol, OutputGenerator::m_t, m_upperCase, and TRUE.

Referenced by startSection().

◆ startHeaderSection()

void ManGenerator::startHeaderSection ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 125 of file mangen.h.

125{}

◆ startInclDepGraph()

void ManGenerator::startInclDepGraph ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 219 of file mangen.h.

219{}

◆ startIndent()

void ManGenerator::startIndent ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 190 of file mangen.h.

190{}

◆ startIndexItem()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 376 of file mangen.cpp.

377{

378}

◆ startIndexKey()

void ManGenerator::startIndexKey ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 106 of file mangen.h.

106{}

◆ startIndexList()

void ManGenerator::startIndexList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 104 of file mangen.h.

104{}

◆ startIndexListItem()

void ManGenerator::startIndexListItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 102 of file mangen.h.

102{}

◆ startIndexSection()

void ManGenerator::startIndexSection ( IndexSection )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 90 of file mangen.h.

90{}

◆ startIndexValue()

void ManGenerator::startIndexValue ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 108 of file mangen.h.

108{}

◆ startInlineHeader()

void ManGenerator::startInlineHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 791 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 852 of file mangen.cpp.

853{

854}

◆ startInlineMemberName()

void ManGenerator::startInlineMemberName ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 842 of file mangen.cpp.

{
  m_t << "\\fI";
}

References OutputGenerator::m_t.

◆ startInlineMemberType()

void ManGenerator::startInlineMemberType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 833 of file mangen.cpp.

834{

835}

◆ startItemList()

void ManGenerator::startItemList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 110 of file mangen.h.

110{}

◆ startItemListItem()

void ManGenerator::startItemListItem ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 475 of file mangen.cpp.

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

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

Referenced by startConstraintParam(), and startDescTableTitle().

◆ startLabels()

void ManGenerator::startLabels ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 864 of file mangen.cpp.

865{

866}

◆ startMemberDeclaration()

void ManGenerator::startMemberDeclaration ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 179 of file mangen.h.

179{}

◆ startMemberDescription()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 177 of file mangen.h.

177{ m_t << "\n.RI \""; m_firstCol=FALSE; }

References FALSE, m_firstCol, and OutputGenerator::m_t.

◆ startMemberDoc()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 488 of file mangen.cpp.

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

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

◆ startMemberDocList()

void ManGenerator::startMemberDocList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 135 of file mangen.h.

135{}

◆ startMemberDocName()

void ManGenerator::startMemberDocName ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 235 of file mangen.h.

235{}

◆ startMemberDocPrefixItem()

void ManGenerator::startMemberDocPrefixItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 233 of file mangen.h.

233{}

◆ startMemberDocSimple()

void ManGenerator::startMemberDocSimple ( bool isEnum )

overridevirtual

Implements OutputGenIntf.

Definition at line 806 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 636 of file mangen.cpp.

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

References OutputGenerator::m_t.

◆ startMemberGroupDocs()

void ManGenerator::startMemberGroupDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 627 of file mangen.cpp.

628{

629}

◆ startMemberGroupHeader()

void ManGenerator::startMemberGroupHeader ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 616 of file mangen.cpp.

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

References OutputGenerator::m_t.

◆ startMemberHeader()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 411 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 QCString &	,
		MemberItemType	,
		const QCString &	)

overridevirtual

Implements OutputGenIntf.

Definition at line 588 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 FALSE, m_firstCol, m_insideTabbing, and OutputGenerator::m_t.

◆ startMemberList()

void ManGenerator::startMemberList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 600 of file mangen.cpp.

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

References FALSE, m_firstCol, m_insideTabbing, and OutputGenerator::m_t.

◆ startMemberSections()

void ManGenerator::startMemberSections ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 123 of file mangen.h.

123{}

◆ startMemberSubtitle()

void ManGenerator::startMemberSubtitle ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 131 of file mangen.h.

131{}

◆ startMemberTemplateParams()

void ManGenerator::startMemberTemplateParams ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 145 of file mangen.h.

145{}

◆ startPageDoc()

void ManGenerator::startPageDoc ( const QCString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 88 of file mangen.h.

88{}

◆ startPageRef()

void ManGenerator::startPageRef ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 195 of file mangen.h.

195{}

◆ startParagraph()

void ManGenerator::startParagraph ( const QCString & classDef )

overridevirtual

Implements OutputGenIntf.

Definition at line 356 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, OutputGenerator::m_t, and TRUE.

◆ startParameterDefVal()

void ManGenerator::startParameterDefVal ( const char * s )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 243 of file mangen.h.

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

ManGenerator::startTypewriter

void startTypewriter() override

Definition mangen.h:119

References docify(), and startTypewriter().

◆ startParameterExtra()

void ManGenerator::startParameterExtra ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 241 of file mangen.h.

241{}

◆ startParameterList()

void ManGenerator::startParameterList ( bool openBracket )

overridevirtual

Implements OutputGenIntf.

Definition at line 892 of file mangen.cpp.

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

References OutputGenerator::m_t.

◆ startParameterName()

void ManGenerator::startParameterName ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 239 of file mangen.h.

239{}

◆ startParameterType()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 237 of file mangen.h.

237{}

◆ startPlainFile()

void ManGenerator::startPlainFile ( const QCString & name )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 273 of file mangen.h.

273{ OutputGenerator::startPlainFile(name); }

OutputGenerator::startPlainFile

void startPlainFile(const QCString &name)

Definition outputgen.cpp:32

References OutputGenerator::startPlainFile().

Referenced by startFile().

◆ startProjectNumber()

void ManGenerator::startProjectNumber ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 93 of file mangen.h.

93{}

◆ startQuickIndices()

void ManGenerator::startQuickIndices ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 197 of file mangen.h.

197{}

◆ startSection()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 647 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(QCString(), -1); break;
      default: ASSERT(0); break;
    }
  }
}

References ASSERT, 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 175 of file mangen.h.

175{}

◆ startTextBlock()

void ManGenerator::startTextBlock ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 229 of file mangen.h.

229{}

◆ startTextLink()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 117 of file mangen.h.

117{}

◆ startTitle()

void ManGenerator::startTitle ( )

private

Definition at line 462 of file mangen.cpp.

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

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

◆ startTitleHead()

void ManGenerator::startTitleHead ( const QCString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 96 of file mangen.h.

96{}

◆ startTypewriter()

void ManGenerator::startTypewriter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 119 of file mangen.h.

119{ m_t << "\\fR"; m_firstCol=FALSE; }

References FALSE, m_firstCol, and OutputGenerator::m_t.

Referenced by startParameterDefVal().

◆ type()

OutputType ManGenerator::type ( ) const

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 77 of file mangen.h.

77{ return OutputType::Man; }

References Man.

Referenced by endSection(), and startSection().

◆ writeAnchor()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 158 of file mangen.h.

158{}

◆ writeChar()

void ManGenerator::writeChar ( char c )

overridevirtual

Implements OutputGenIntf.

Definition at line 448 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 FALSE, m_col, m_firstCol, m_paragraph, and OutputGenerator::m_t.

◆ writeDoc()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 728 of file mangen.cpp.

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

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

◆ writeFooter()

void ManGenerator::writeFooter ( const QCString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 86 of file mangen.h.

86{}

◆ writeGraphicalHierarchy()

void ManGenerator::writeGraphicalHierarchy ( DotGfxHierarchyTable & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 227 of file mangen.h.

227{}

◆ writeInheritedSectionTitle()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 882 of file mangen.cpp.

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

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

◆ writeLabel()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 868 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 170 of file mangen.h.

170{}

◆ writeLocalToc()

void ManGenerator::writeLocalToc	(	const SectionRefs &	,
		const LocalToc &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 271 of file mangen.h.

271{}

◆ writeLogo()

void ManGenerator::writeLogo ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 201 of file mangen.h.

201{}

◆ writeNavigationPath()

void ManGenerator::writeNavigationPath ( const QCString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 200 of file mangen.h.

200{}

◆ writeNonBreakableSpace()

void ManGenerator::writeNonBreakableSpace ( int n )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 206 of file mangen.h.

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

References OutputGenerator::m_t.

◆ writeObjectLink()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 389 of file mangen.cpp.

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

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

◆ writePageLink()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 92 of file mangen.h.

92{}

◆ writeQuickLinks()

void ManGenerator::writeQuickLinks	(	HighlightedItem	,
		const QCString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 202 of file mangen.h.

202{}

◆ writeRuler()

void ManGenerator::writeRuler ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 157 of file mangen.h.

157{}

◆ writeSearchInfo()

void ManGenerator::writeSearchInfo ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 85 of file mangen.h.

85{}

◆ writeSplitBar()

void ManGenerator::writeSplitBar ( const QCString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 199 of file mangen.h.

199{}

◆ writeStartAnnoItem()

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

overridevirtual

Implements OutputGenIntf.

Definition at line 384 of file mangen.cpp.

386{

387}

◆ writeString()

void ManGenerator::writeString ( const QCString & text )

overridevirtual

Implements OutputGenIntf.

Definition at line 371 of file mangen.cpp.

{
  docify(text);
}

References docify().

◆ writeStyleInfo()

void ManGenerator::writeStyleInfo ( int )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 95 of file mangen.h.

95{}

◆ writeSummaryLink()

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

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 203 of file mangen.h.

203{}

◆ writeSynopsis()

void ManGenerator::writeSynopsis ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 549 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 FALSE, m_firstCol, m_paragraph, OutputGenerator::m_t, and TRUE.

Member Data Documentation

◆ m_codeGen

ManCodeGenerator* ManGenerator::m_codeGen

private

Definition at line 287 of file mangen.h.

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

◆ m_codeList

std::unique_ptr<OutputCodeList> ManGenerator::m_codeList

private

Definition at line 286 of file mangen.h.

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

◆ m_col

int ManGenerator::m_col = 0

private

Definition at line 281 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 280 of file mangen.h.

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

◆ m_inHeader

bool ManGenerator::m_inHeader = false

private

Definition at line 285 of file mangen.h.

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

◆ m_insideTabbing

bool ManGenerator::m_insideTabbing = false

private

Definition at line 284 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 282 of file mangen.h.

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

◆ m_upperCase

bool ManGenerator::m_upperCase = false

private

Definition at line 283 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 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()

◆ endCallGraph()

◆ endCenter()

◆ endClassDiagram()

◆ endCompoundTemplateParams()

◆ endConstraintDocs()

◆ endConstraintList()

◆ endConstraintParam()

◆ endConstraintType()

◆ endContents()

◆ endDescForItem()

◆ endDescTable()

◆ endDescTableData()

◆ endDescTableRow()

◆ endDescTableTitle()

◆ endDirDepGraph()

◆ endDotGraph()

◆ endDoxyAnchor()

◆ endEmphasis()

◆ endExamples()

◆ endFile()

◆ endGroupCollaboration()

◆ endGroupHeader()

◆ endHeaderSection()

◆ endInclDepGraph()

◆ endIndent()

◆ endIndexItem()

◆ endIndexKey()

◆ endIndexList()

◆ endIndexListItem()

◆ endIndexSection()

◆ endIndexValue()

◆ endInlineHeader()

◆ endInlineMemberDoc()

◆ endInlineMemberName()

◆ endInlineMemberType()

◆ endItemList()

◆ endItemListItem()

◆ endLabels()

◆ endMemberDeclaration()

◆ endMemberDescription()

◆ endMemberDoc()

◆ endMemberDocList()

◆ endMemberDocName()

◆ endMemberDocPrefixItem()

◆ endMemberDocSimple()

◆ endMemberGroup()

◆ endMemberGroupDocs()

◆ endMemberGroupHeader()

◆ endMemberHeader()

◆ endMemberItem()

◆ endMemberList()

◆ endMemberSections()

◆ endMemberSubtitle()

◆ endMemberTemplateParams()

◆ endPageDoc()

◆ endPageRef()

◆ endParagraph()

◆ endParameterDefVal()

◆ endParameterExtra()