The HtmlCodeGenerator
Class Reference
Generator for HTML code fragments. More...
Declaration
Included Headers
Base class
class | OutputCodeIntf |
Base class for code generators. More... | |
Public Constructors Index
HtmlCodeGenerator (TextStream *t, const QCString &relPath) | |
HtmlCodeGenerator (TextStream *t) | |
Public Member Functions Index
void | setTextStream (TextStream *t) |
void | setFileName (const QCString fileName) |
QCString | fileName () |
OutputType | type () const override |
std::unique_ptr< OutputCodeIntf > | clone () override |
void | codify (const QCString &text) override |
void | stripCodeComments (bool b) override |
void | startSpecialComment () override |
void | endSpecialComment () override |
void | setStripIndentAmount (size_t amount) override |
void | writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip) override |
void | writeTooltip (const QCString &id, const DocLinkInfo &docInfo, const QCString &decl, const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo) override |
void | writeLineNumber (const QCString &, const QCString &, const QCString &, int, bool) override |
void | startCodeLine (int) override |
void | endCodeLine () override |
void | startFontClass (const QCString &s) override |
void | endFontClass () override |
void | writeCodeAnchor (const QCString &anchor) override |
void | startCodeFragment (const QCString &style) override |
void | endCodeFragment (const QCString &) override |
void | startFold (int, const QCString &, const QCString &) override |
void | endFold () override |
void | setRelativePath (const QCString &path) |
Private Member Functions Index
void | _writeCodeLink (const QCString &className, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip) |
void | _startOpenLine () |
Private Member Attributes Index
TextStream * | m_t |
size_t | m_col = 0 |
QCString | m_relPath |
QCString | m_fileName |
bool | m_lineOpen = false |
bool | m_stripCodeComments = false |
bool | m_hide = false |
LineInfo | m_lastLineInfo |
size_t | m_stripIndentAmount = 0 |
Description
Generator for HTML code fragments.
Definition at line 25 of file htmlgen.h.
Public Constructors
HtmlCodeGenerator()
|
Declaration at line 28 of file htmlgen.h, definition at line 715 of file htmlgen.cpp.
HtmlCodeGenerator()
|
Declaration at line 29 of file htmlgen.h, definition at line 710 of file htmlgen.cpp.
Reference m_t.
Public Member Functions
clone()
| inline virtual |
codify()
| virtual |
Declaration at line 37 of file htmlgen.h, definition at line 726 of file htmlgen.cpp.
References Config_getInt, QCString::data, hex, QCString::isEmpty, m_col, m_hide, m_stripIndentAmount, m_t, updateColumnCount and writeUTF8Char.
Referenced by _writeCodeLink, writeLineNumber and writeTooltip.
endCodeFragment()
| virtual |
Declaration at line 60 of file htmlgen.h, definition at line 1033 of file htmlgen.cpp.
References endCodeLine and m_t.
endCodeLine()
| virtual |
Declaration at line 55 of file htmlgen.h, definition at line 995 of file htmlgen.cpp.
References FALSE, m_col, m_hide, m_lineOpen and m_t.
Referenced by endCodeFragment.
endFold()
| virtual |
Declaration at line 62 of file htmlgen.h, definition at line 1075 of file htmlgen.cpp.
References _startOpenLine, m_lineOpen and m_t.
endFontClass()
| virtual |
Declaration at line 57 of file htmlgen.h, definition at line 1016 of file htmlgen.cpp.
endSpecialComment()
| virtual |
Declaration at line 40 of file htmlgen.h, definition at line 818 of file htmlgen.cpp.
Reference m_hide.
fileName()
| inline |
Definition at line 33 of file htmlgen.h.
Reference m_fileName.
Referenced by _writeCodeLink, setFileName and writeTooltip.
setFileName()
| inline |
Definition at line 32 of file htmlgen.h.
References fileName and m_fileName.
setRelativePath()
|
Declaration at line 64 of file htmlgen.h, definition at line 721 of file htmlgen.cpp.
Reference m_relPath.
setStripIndentAmount()
| virtual |
Declaration at line 41 of file htmlgen.h, definition at line 824 of file htmlgen.cpp.
Reference m_stripIndentAmount.
setTextStream()
| inline |
Definition at line 31 of file htmlgen.h.
Reference m_t.
startCodeFragment()
| virtual |
Declaration at line 59 of file htmlgen.h, definition at line 1028 of file htmlgen.cpp.
Reference m_t.
startCodeLine()
| virtual |
Declaration at line 54 of file htmlgen.h, definition at line 984 of file htmlgen.cpp.
References m_col, m_hide, m_lineOpen, m_t and TRUE.
startFold()
| virtual |
Declaration at line 61 of file htmlgen.h, definition at line 1041 of file htmlgen.cpp.
References m_hide, m_lineOpen, m_t and qsnprintf.
startFontClass()
| virtual |
Declaration at line 56 of file htmlgen.h, definition at line 1010 of file htmlgen.cpp.
startSpecialComment()
| virtual |
Declaration at line 39 of file htmlgen.h, definition at line 812 of file htmlgen.cpp.
References m_hide and m_stripCodeComments.
stripCodeComments()
| virtual |
Declaration at line 38 of file htmlgen.h, definition at line 807 of file htmlgen.cpp.
Reference m_stripCodeComments.
type()
| inline virtual |
Definition at line 35 of file htmlgen.h.
Reference Html.
Referenced by writeCodeLink.
writeCodeAnchor()
| virtual |
Declaration at line 58 of file htmlgen.h, definition at line 1022 of file htmlgen.cpp.
writeCodeLink()
| virtual |
Declaration at line 42 of file htmlgen.h, definition at line 860 of file htmlgen.cpp.
References _writeCodeLink, codeSymbolType2Str, m_hide and type.
writeLineNumber()
| virtual |
Declaration at line 53 of file htmlgen.h, definition at line 829 of file htmlgen.cpp.
References _writeCodeLink, codify, QCString::isEmpty, m_col, m_hide, m_lastLineInfo, m_lineOpen, m_t, qsnprintf and TRUE.
Referenced by _startOpenLine.
writeTooltip()
| virtual |
Declaration at line 46 of file htmlgen.h, definition at line 904 of file htmlgen.cpp.
References addHtmlExtensionIfMissing, DocLinkInfo::anchor, SourceLinkInfo::anchor, codify, createHtmlUrl, SourceLinkInfo::file, fileName, QCString::isEmpty, SourceLinkInfo::line, m_hide, m_relPath, m_t, DocLinkInfo::name, DocLinkInfo::ref, SourceLinkInfo::ref, theTranslator, DocLinkInfo::url and SourceLinkInfo::url.
Private Member Functions
_startOpenLine()
|
Declaration at line 70 of file htmlgen.h, definition at line 1061 of file htmlgen.cpp.
References m_hide, m_lastLineInfo, m_lineOpen, m_t and writeLineNumber.
Referenced by endFold.
_writeCodeLink()
|
Declaration at line 66 of file htmlgen.h, definition at line 876 of file htmlgen.cpp.
References addHtmlExtensionIfMissing, codify, convertToHtml, createHtmlUrl, externalLinkTarget, fileName, QCString::isEmpty, QCString::length, m_col, m_hide, m_relPath and m_t.
Referenced by writeCodeLink and writeLineNumber.
Private Member Attributes
m_col
|
Definition at line 73 of file htmlgen.h.
Referenced by _writeCodeLink, codify, endCodeLine, startCodeLine and writeLineNumber.
m_fileName
|
Definition at line 75 of file htmlgen.h.
Referenced by fileName and setFileName.
m_hide
|
Definition at line 78 of file htmlgen.h.
Referenced by _startOpenLine, _writeCodeLink, codify, endCodeLine, endFontClass, endSpecialComment, startCodeLine, startFold, startFontClass, startSpecialComment, writeCodeAnchor, writeCodeLink, writeLineNumber and writeTooltip.
m_lastLineInfo
|
Definition at line 90 of file htmlgen.h.
Referenced by _startOpenLine and writeLineNumber.
m_lineOpen
|
Definition at line 76 of file htmlgen.h.
Referenced by _startOpenLine, endCodeLine, endFold, startCodeLine, startFold and writeLineNumber.
m_relPath
|
Definition at line 74 of file htmlgen.h.
Referenced by _writeCodeLink, HtmlCodeGenerator, setRelativePath and writeTooltip.
m_stripCodeComments
|
Definition at line 77 of file htmlgen.h.
Referenced by startSpecialComment and stripCodeComments.
m_stripIndentAmount
|
Definition at line 91 of file htmlgen.h.
Referenced by codify and setStripIndentAmount.
m_t
|
Definition at line 72 of file htmlgen.h.
Referenced by _startOpenLine, _writeCodeLink, codify, endCodeFragment, endCodeLine, endFold, endFontClass, HtmlCodeGenerator, HtmlCodeGenerator, setTextStream, startCodeFragment, startCodeLine, startFold, startFontClass, writeCodeAnchor, writeLineNumber and writeTooltip.
The documentation for this class was generated from the following files:
Generated via doxygen2docusaurus by Doxygen 1.14.0.