Doxygen
|
Generator for HTML code fragments. More...
#include <src/htmlgen.h>
Classes | |
struct | LineInfo |
Public Member Functions | |
HtmlCodeGenerator (TextStream *t, const QCString &relPath) | |
HtmlCodeGenerator (TextStream *t) | |
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) |
Public Member Functions inherited from OutputCodeIntf | |
OutputCodeIntf ()=default | |
Private Member Functions | |
void | _writeCodeLink (const QCString &className, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip) |
void | _startOpenLine () |
Private Attributes | |
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 |
HtmlCodeGenerator::HtmlCodeGenerator | ( | TextStream * | t, |
const QCString & | relPath ) |
Definition at line 714 of file htmlgen.cpp.
HtmlCodeGenerator::HtmlCodeGenerator | ( | TextStream * | t | ) |
Definition at line 709 of file htmlgen.cpp.
References m_t.
|
private |
Definition at line 1060 of file htmlgen.cpp.
References m_hide, m_lastLineInfo, m_lineOpen, m_t, and writeLineNumber().
Referenced by endFold().
|
private |
Definition at line 875 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().
|
inlineoverridevirtual |
Implements OutputCodeIntf.
Definition at line 35 of file htmlgen.h.
|
overridevirtual |
Implements OutputCodeIntf.
Definition at line 725 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().
|
overridevirtual |
Implements OutputCodeIntf.
Definition at line 1032 of file htmlgen.cpp.
References endCodeLine(), and m_t.
|
overridevirtual |
Implements OutputCodeIntf.
Definition at line 994 of file htmlgen.cpp.
References FALSE, m_col, m_hide, m_lineOpen, and m_t.
Referenced by endCodeFragment().
|
overridevirtual |
Implements OutputCodeIntf.
Definition at line 1074 of file htmlgen.cpp.
References _startOpenLine(), m_lineOpen, and m_t.
|
overridevirtual |
Implements OutputCodeIntf.
Definition at line 1015 of file htmlgen.cpp.
|
overridevirtual |
|
inline |
Definition at line 32 of file htmlgen.h.
References m_fileName.
Referenced by _writeCodeLink(), setFileName(), and writeTooltip().
|
inline |
void HtmlCodeGenerator::setRelativePath | ( | const QCString & | path | ) |
|
overridevirtual |
Implements OutputCodeIntf.
Definition at line 823 of file htmlgen.cpp.
References m_stripIndentAmount.
|
inline |
|
overridevirtual |
|
overridevirtual |
Implements OutputCodeIntf.
Definition at line 983 of file htmlgen.cpp.
References m_col, m_hide, m_lineOpen, m_t, and TRUE.
|
overridevirtual |
Implements OutputCodeIntf.
Definition at line 1040 of file htmlgen.cpp.
References m_hide, m_lineOpen, m_t, and qsnprintf.
|
overridevirtual |
Implements OutputCodeIntf.
Definition at line 1009 of file htmlgen.cpp.
|
overridevirtual |
Implements OutputCodeIntf.
Definition at line 811 of file htmlgen.cpp.
References m_hide, and m_stripCodeComments.
|
overridevirtual |
Implements OutputCodeIntf.
Definition at line 806 of file htmlgen.cpp.
References m_stripCodeComments.
|
inlineoverridevirtual |
Implements OutputCodeIntf.
Definition at line 34 of file htmlgen.h.
References Html.
Referenced by writeCodeLink().
|
overridevirtual |
|
overridevirtual |
Implements OutputCodeIntf.
Definition at line 859 of file htmlgen.cpp.
References _writeCodeLink(), codeSymbolType2Str(), m_hide, and type().
|
overridevirtual |
Implements OutputCodeIntf.
Definition at line 828 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().
|
overridevirtual |
Implements OutputCodeIntf.
Definition at line 903 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, Translator::trDeclaration(), Translator::trDefinition(), DocLinkInfo::url, and SourceLinkInfo::url.
|
private |
Definition at line 72 of file htmlgen.h.
Referenced by _writeCodeLink(), codify(), endCodeLine(), startCodeLine(), and writeLineNumber().
|
private |
Definition at line 74 of file htmlgen.h.
Referenced by fileName(), and setFileName().
|
private |
Definition at line 77 of file htmlgen.h.
Referenced by _startOpenLine(), _writeCodeLink(), codify(), endCodeLine(), endFontClass(), endSpecialComment(), startCodeLine(), startFold(), startFontClass(), startSpecialComment(), writeCodeAnchor(), writeCodeLink(), writeLineNumber(), and writeTooltip().
|
private |
Definition at line 89 of file htmlgen.h.
Referenced by _startOpenLine(), and writeLineNumber().
|
private |
Definition at line 75 of file htmlgen.h.
Referenced by _startOpenLine(), endCodeLine(), endFold(), startCodeLine(), startFold(), and writeLineNumber().
|
private |
Definition at line 73 of file htmlgen.h.
Referenced by _writeCodeLink(), HtmlCodeGenerator(), setRelativePath(), and writeTooltip().
|
private |
Definition at line 76 of file htmlgen.h.
Referenced by startSpecialComment(), and stripCodeComments().
|
private |
Definition at line 90 of file htmlgen.h.
Referenced by codify(), and setStripIndentAmount().
|
private |
Definition at line 71 of file htmlgen.h.
Referenced by _startOpenLine(), _writeCodeLink(), codify(), endCodeFragment(), endCodeLine(), endFold(), endFontClass(), HtmlCodeGenerator(), HtmlCodeGenerator(), setTextStream(), startCodeFragment(), startCodeLine(), startFold(), startFontClass(), writeCodeAnchor(), writeLineNumber(), and writeTooltip().