The OutputCodeDefer Class Template Reference

Helper template class which defers all methods of OutputCodeIntf to an existing object of the templated type. More...

Declaration

template <class OutputCodeGen> class OutputCodeDefer<OutputCodeGen> { ... }

Included Headers

#include <src/outputlist.h>

Base class

class	OutputCodeIntf
	Base class for code generators. More...

Public Constructors Index

template <class OutputCodeGen>
OutputCodeDefer (OutputCodeGen *codeGen)

Public Member Functions Index

template <class OutputCodeGen>
OutputType	type () const override
template <class OutputCodeGen>
auto	clone () override -> std::unique_ptr< OutputCodeIntf >
template <class OutputCodeGen>
void	codify (const QCString &s) override
template <class OutputCodeGen>
void	stripCodeComments (bool b) override
template <class OutputCodeGen>
void	startSpecialComment () override
template <class OutputCodeGen>
void	endSpecialComment () override
template <class OutputCodeGen>
void	setStripIndentAmount (size_t amount) override
template <class OutputCodeGen>
void	writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip) override
template <class OutputCodeGen>
void	writeLineNumber (const QCString &ref, const QCString &file, const QCString &anchor, int lineNumber, bool writeLineAnchor) override
template <class OutputCodeGen>
void	writeTooltip (const QCString &id, const DocLinkInfo &docInfo, const QCString &decl, const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo) override
template <class OutputCodeGen>
void	startCodeLine (int lineNr) override
template <class OutputCodeGen>
void	endCodeLine () override
template <class OutputCodeGen>
void	startFontClass (const QCString &c) override
template <class OutputCodeGen>
void	endFontClass () override
template <class OutputCodeGen>
void	writeCodeAnchor (const QCString &name) override
template <class OutputCodeGen>
void	startCodeFragment (const QCString &style) override
template <class OutputCodeGen>
void	endCodeFragment (const QCString &style) override
template <class OutputCodeGen>
void	startFold (int lineNr, const QCString &startMarker, const QCString &endMarker) override
template <class OutputCodeGen>
void	endFold () override

Private Member Attributes Index

template <class OutputCodeGen>
OutputCodeGen *	m_codeGen

Description

Helper template class which defers all methods of OutputCodeIntf to an existing object of the templated type.

This allows to add the same generator to multiple lists (one that owns the element, and others that refers to it).

Definition at line 45 of file outputlist.h.

Public Constructors

OutputCodeDefer()

template <class OutputCodeGen>

OutputCodeDefer< OutputCodeGen >::OutputCodeDefer (OutputCodeGen * codeGen)

inline

Definition at line 48 of file outputlist.h.

48 OutputCodeDefer(OutputCodeGen *codeGen) : m_codeGen(codeGen) {}

Public Member Functions

clone()

template <class OutputCodeGen>

std::unique_ptr< OutputCodeIntf > OutputCodeDefer< OutputCodeGen >::clone ()

inline virtual

Definition at line 50 of file outputlist.h.

50 std::unique_ptr<OutputCodeIntf> clone() override { return std::make_unique<OutputCodeDefer>(*this); }

codify()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::codify (const QCString & s)

inline virtual

Definition at line 51 of file outputlist.h.

51 void codify(const QCString &s) override { m_codeGen->codify(s); }

endCodeFragment()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::endCodeFragment (const QCString & style)

inline virtual

Definition at line 88 of file outputlist.h.

88 void endCodeFragment(const QCString &style) override

89 { m_codeGen->endCodeFragment(style); }

endCodeLine()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::endCodeLine ()

inline virtual

Definition at line 73 of file outputlist.h.

73 void endCodeLine() override

74 { m_codeGen->endCodeLine(); }

endFold()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::endFold ()

inline virtual

Definition at line 94 of file outputlist.h.

94 void endFold() override

95 { m_codeGen->endFold(); }

endFontClass()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::endFontClass ()

inline virtual

Definition at line 79 of file outputlist.h.

79 void endFontClass() override

80 { m_codeGen->endFontClass(); }

endSpecialComment()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::endSpecialComment ()

inline virtual

Definition at line 54 of file outputlist.h.

54 void endSpecialComment() override { m_codeGen->endSpecialComment(); }

setStripIndentAmount()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::setStripIndentAmount (size_t amount)

inline virtual

Definition at line 55 of file outputlist.h.

55 void setStripIndentAmount(size_t amount) override { m_codeGen->setStripIndentAmount(amount); }

startCodeFragment()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::startCodeFragment (const QCString & style)

inline virtual

Definition at line 85 of file outputlist.h.

85 void startCodeFragment(const QCString &style) override

86 { m_codeGen->startCodeFragment(style); }

startCodeLine()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::startCodeLine (int lineNr)

inline virtual

Definition at line 70 of file outputlist.h.

70 void startCodeLine(int lineNr) override

71 { m_codeGen->startCodeLine(lineNr); }

startFold()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::startFold (int lineNr, const QCString & startMarker, const QCString & endMarker)

inline virtual

Definition at line 91 of file outputlist.h.

91 void startFold(int lineNr,const QCString &startMarker,const QCString &endMarker) override

92 { m_codeGen->startFold(lineNr,startMarker,endMarker); }

startFontClass()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::startFontClass (const QCString & c)

inline virtual

Definition at line 76 of file outputlist.h.

76 void startFontClass(const QCString &c) override

77 { m_codeGen->startFontClass(c); }

startSpecialComment()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::startSpecialComment ()

inline virtual

Definition at line 53 of file outputlist.h.

53 void startSpecialComment() override { m_codeGen->startSpecialComment(); }

stripCodeComments()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::stripCodeComments (bool b)

inline virtual

Definition at line 52 of file outputlist.h.

52 void stripCodeComments(bool b) override { m_codeGen->stripCodeComments(b); }

type()

template <class OutputCodeGen>

OutputType OutputCodeDefer< OutputCodeGen >::type ()

inline virtual

Definition at line 49 of file outputlist.h.

49 OutputType type() const override { return m_codeGen->type(); }

writeCodeAnchor()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::writeCodeAnchor (const QCString & name)

inline virtual

Definition at line 82 of file outputlist.h.

82 void writeCodeAnchor(const QCString &name) override

83 { m_codeGen->writeCodeAnchor(name); }

writeCodeLink()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::writeCodeLink (CodeSymbolType type, const QCString & ref, const QCString & file, const QCString & anchor, const QCString & name, const QCString & tooltip)

inline virtual

Definition at line 56 of file outputlist.h.

56 void writeCodeLink(CodeSymbolType type,

57 const QCString &ref,const QCString &file,

58 const QCString &anchor,const QCString &name,

59 const QCString &tooltip) override

60 { m_codeGen->writeCodeLink(type,ref,file,anchor,name,tooltip); }

writeLineNumber()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::writeLineNumber (const QCString & ref, const QCString & file, const QCString & anchor, int lineNumber, bool writeLineAnchor)

inline virtual

Definition at line 62 of file outputlist.h.

62 void writeLineNumber(const QCString &ref,const QCString &file,const QCString &anchor,

63 int lineNumber, bool writeLineAnchor) override

64 { m_codeGen->writeLineNumber(ref,file,anchor,lineNumber,writeLineAnchor); }

writeTooltip()

template <class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::writeTooltip (const QCString & id, const DocLinkInfo & docInfo, const QCString & decl, const QCString & desc, const SourceLinkInfo & defInfo, const SourceLinkInfo & declInfo)

inline virtual

Definition at line 66 of file outputlist.h.

66 void writeTooltip(const QCString &id, const DocLinkInfo &docInfo, const QCString &decl,

67 const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo) override

68 { m_codeGen->writeTooltip(id,docInfo,decl,desc,defInfo,declInfo); }

Private Member Attributes

m_codeGen

template <class OutputCodeGen>

OutputCodeGen* OutputCodeDefer< OutputCodeGen >::m_codeGen

Definition at line 98 of file outputlist.h.

98 OutputCodeGen *m_codeGen;

---

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

• outputlist.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.