Doxygen
Loading...
Searching...
No Matches
HtmlCodeGenerator Class Reference

Generator for HTML code fragments. More...

#include <src/htmlgen.h>

Inheritance diagram for HtmlCodeGenerator:
Collaboration diagram for HtmlCodeGenerator:

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< OutputCodeIntfclone () 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

TextStreamm_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

Detailed Description

Generator for HTML code fragments.

Definition at line 25 of file htmlgen.h.

Constructor & Destructor Documentation

◆ HtmlCodeGenerator() [1/2]

HtmlCodeGenerator::HtmlCodeGenerator ( TextStream * t,
const QCString & relPath )

Definition at line 758 of file htmlgen.cpp.

759 : m_t(t), m_relPath(relPath)
760{
761 //printf("%p:HtmlCodeGenerator()\n",(void*)this);
762}
QCString m_relPath
Definition htmlgen.h:74
TextStream * m_t
Definition htmlgen.h:72

References m_relPath, and m_t.

◆ HtmlCodeGenerator() [2/2]

HtmlCodeGenerator::HtmlCodeGenerator ( TextStream * t)

Definition at line 753 of file htmlgen.cpp.

753 : m_t(t)
754{
755 //printf("%p:HtmlCodeGenerator()\n",(void*)this);
756}

References m_t.

Member Function Documentation

◆ _startOpenLine()

void HtmlCodeGenerator::_startOpenLine ( )
private

Definition at line 1116 of file htmlgen.cpp.

1117{
1118 //printf("_startOpenLine open=%d\n",m_lineOpen);
1119 *m_t << "<div class=\"line\">";
1120 bool wasHidden=m_hide;
1121 m_hide = false;
1122 m_lineOpen = true;
1124 m_lastLineInfo.fileName,
1125 m_lastLineInfo.anchor,
1126 m_lastLineInfo.line+1,
1127 m_lastLineInfo.writeAnchor);
1128 m_hide = wasHidden;
1129}
void writeLineNumber(const QCString &, const QCString &, const QCString &, int, bool) override
Definition htmlgen.cpp:876
LineInfo m_lastLineInfo
Definition htmlgen.h:90

References m_hide, m_lastLineInfo, m_lineOpen, m_t, and writeLineNumber().

Referenced by endFold().

◆ _writeCodeLink()

void HtmlCodeGenerator::_writeCodeLink ( const QCString & className,
const QCString & ref,
const QCString & file,
const QCString & anchor,
const QCString & name,
const QCString & tooltip )
private

Definition at line 924 of file htmlgen.cpp.

928{
929 m_col+=name.length();
930 if (m_hide) return;
931 if (!ref.isEmpty())
932 {
933 *m_t << "<a class=\"" << className << "Ref\" ";
935 }
936 else
937 {
938 *m_t << "<a class=\"" << className << "\" ";
939 }
940 *m_t << "href=\"";
941 QCString fn = f;
943 *m_t << createHtmlUrl(m_relPath,ref,true,
944 fileName()==fn,fn,anchor);
945 *m_t << "\"";
946 if (!tooltip.isEmpty()) *m_t << " title=\"" << convertToHtml(tooltip) << "\"";
947 *m_t << ">";
948 codify(name);
949 *m_t << "</a>";
950}
void codify(const QCString &text) override
Definition htmlgen.cpp:769
QCString fileName()
Definition htmlgen.h:33
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition qcstring.h:166
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:163
QCString convertToHtml(const QCString &s, bool keepEntities)
Definition util.cpp:4479
QCString externalLinkTarget(const bool parent)
Definition util.cpp:6228
void addHtmlExtensionIfMissing(QCString &fName)
Definition util.cpp:5418
QCString createHtmlUrl(const QCString &relPath, const QCString &ref, bool href, bool isLocalFile, const QCString &targetFileName, const QCString &anchor)
Definition util.cpp:6239

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().

◆ clone()

std::unique_ptr< OutputCodeIntf > HtmlCodeGenerator::clone ( )
inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 36 of file htmlgen.h.

36{ return std::make_unique<HtmlCodeGenerator>(*this); }

◆ codify()

void HtmlCodeGenerator::codify ( const QCString & text)
overridevirtual

Implements OutputCodeIntf.

Definition at line 769 of file htmlgen.cpp.

770{
771 if (!str.isEmpty())
772 {
773 int tabSize = Config_getInt(TAB_SIZE);
774 const char *p=str.data();
775 if (m_hide) // only update column count
776 {
778 }
779 else // actually output content and keep track of m_col
780 {
781 while (*p)
782 {
783 char c=*p++;
784 switch(c)
785 {
786 case '\t': {
787 int spacesToNextTabStop = tabSize - (m_col%tabSize);
788 while (spacesToNextTabStop--)
789 {
790 if (m_col>=m_stripIndentAmount) *m_t << " ";
791 m_col++;
792 }
793 }
794 break;
795 case ' ': if (m_col>=m_stripIndentAmount) *m_t << " ";
796 m_col++;
797 break;
798 case '\n': *m_t << "\n"; m_col=0;
799 break;
800 case '\r': break;
801 case '<': *m_t << "&lt;"; m_col++;
802 break;
803 case '>': *m_t << "&gt;"; m_col++;
804 break;
805 case '&': *m_t << "&amp;"; m_col++;
806 break;
807 case '\'': *m_t << "&#39;"; m_col++; // &apos; is not valid XHTML
808 break;
809 case '"': *m_t << "&quot;"; m_col++;
810 break;
811 case '\\':
812 if (*p=='<')
813 { *m_t << "&lt;"; p++; }
814 else if (*p=='>')
815 { *m_t << "&gt;"; p++; }
816 else if (*p=='[')
817 { *m_t << "\\&zwj;["; m_col++;p++; }
818 else if (*p==']')
819 { *m_t << "\\&zwj;]"; m_col++;p++; }
820 else if (*p=='(')
821 { *m_t << "\\&zwj;("; m_col++;p++; }
822 else if (*p==')')
823 { *m_t << "\\&zwj;)"; m_col++;p++; }
824 else
825 *m_t << "\\";
826 m_col++;
827 break;
828 default:
829 {
830 uint8_t uc = static_cast<uint8_t>(c);
831 if (uc<32)
832 {
833 *m_t << "&#x24" << hex[uc>>4] << hex[uc&0xF] << ";";
834 m_col++;
835 }
836 else if (uc<0x80) // printable ASCII char
837 {
838 *m_t << c;
839 m_col++;
840 }
841 else // multibyte UTF-8 char
842 {
843 p=writeUTF8Char(*m_t,p-1);
844 m_col++;
845 }
846 }
847 break;
848 }
849 }
850 }
851 }
852}
size_t m_stripIndentAmount
Definition htmlgen.h:91
#define Config_getInt(name)
Definition config.h:34
static constexpr auto hex
const char * writeUTF8Char(TextStream &t, const char *s)
Writes the UTF8 character pointed to by s to stream t and returns a pointer to the next character.
Definition utf8.cpp:197
size_t updateColumnCount(const char *s, size_t col)
Definition util.cpp:7397

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

void HtmlCodeGenerator::endCodeFragment ( const QCString & )
overridevirtual

Implements OutputCodeIntf.

Definition at line 1083 of file htmlgen.cpp.

1084{
1085 //printf("endCodeFragment hide=%d open=%d\n",m_hide,m_lineOpen);
1086 bool wasHidden = m_hide;
1087 m_hide = false;
1088 //endCodeLine checks is there is still an open code line, if so closes it.
1089 endCodeLine();
1090 m_hide = wasHidden;
1091
1092 *m_t << "</div><!-- fragment -->";
1093}
void endCodeLine() override
Definition htmlgen.cpp:1044

References endCodeLine(), m_hide, and m_t.

◆ endCodeLine()

void HtmlCodeGenerator::endCodeLine ( )
overridevirtual

Implements OutputCodeIntf.

Definition at line 1044 of file htmlgen.cpp.

1045{
1046 //printf("endCodeLine hide=%d open=%d\n",m_hide,m_lineOpen);
1047 if (m_hide) return;
1048 if (m_col == 0)
1049 {
1050 *m_t << " ";
1051 m_col++;
1052 }
1053 if (m_lineOpen)
1054 {
1055 *m_t << "</div>\n";
1056 m_lineOpen = FALSE;
1057 }
1058}
#define FALSE
Definition qcstring.h:34

References FALSE, m_col, m_hide, m_lineOpen, and m_t.

Referenced by endCodeFragment().

◆ endFold()

void HtmlCodeGenerator::endFold ( )
overridevirtual

Implements OutputCodeIntf.

Definition at line 1131 of file htmlgen.cpp.

1132{
1133 //printf("endFold open=%d\n",m_lineOpen);
1134 if (m_lineOpen) // if we have a hidden comment in a code fold, we need to end the line
1135 {
1136 *m_t << "</div>\n";
1137 }
1138 *m_t << "</div>\n";
1139 if (m_lineOpen)
1140 {
1142 }
1143}

References _startOpenLine(), m_lineOpen, and m_t.

◆ endFontClass()

void HtmlCodeGenerator::endFontClass ( )
overridevirtual

Implements OutputCodeIntf.

Definition at line 1066 of file htmlgen.cpp.

1067{
1068 if (m_hide) return;
1069 *m_t << "</span>";
1070}

References m_hide, and m_t.

◆ endSpecialComment()

void HtmlCodeGenerator::endSpecialComment ( )
overridevirtual

Implements OutputCodeIntf.

Definition at line 865 of file htmlgen.cpp.

866{
867 //*m_t << "[END]";
868 m_hide = false;
869}

References m_hide.

◆ fileName()

QCString HtmlCodeGenerator::fileName ( )
inline

Definition at line 33 of file htmlgen.h.

33{ return m_fileName; }
QCString m_fileName
Definition htmlgen.h:75

References m_fileName.

Referenced by _writeCodeLink(), setFileName(), and writeTooltip().

◆ setFileName()

void HtmlCodeGenerator::setFileName ( const QCString fileName)
inline

Definition at line 32 of file htmlgen.h.

References fileName(), and m_fileName.

◆ setRelativePath()

void HtmlCodeGenerator::setRelativePath ( const QCString & path)

Definition at line 764 of file htmlgen.cpp.

765{
766 m_relPath = path;
767}

References m_relPath.

◆ setStripIndentAmount()

void HtmlCodeGenerator::setStripIndentAmount ( size_t amount)
overridevirtual

Implements OutputCodeIntf.

Definition at line 871 of file htmlgen.cpp.

872{
873 m_stripIndentAmount = amount;
874}

References m_stripIndentAmount.

◆ setTextStream()

void HtmlCodeGenerator::setTextStream ( TextStream * t)
inline

Definition at line 31 of file htmlgen.h.

31{ m_t = t; }

References m_t.

◆ startCodeFragment()

void HtmlCodeGenerator::startCodeFragment ( const QCString & style)
overridevirtual

Implements OutputCodeIntf.

Definition at line 1078 of file htmlgen.cpp.

1079{
1080 *m_t << "<div class=\"fragment\">";
1081}

References m_t.

◆ startCodeLine()

void HtmlCodeGenerator::startCodeLine ( int )
overridevirtual

Implements OutputCodeIntf.

Definition at line 1032 of file htmlgen.cpp.

1033{
1034 //printf("startCodeLine open=%d\n",m_lineOpen);
1035 m_col=0;
1036 if (m_hide) return;
1037 if (!m_lineOpen)
1038 {
1039 *m_t << "<div class=\"line\">";
1040 m_lineOpen = TRUE;
1041 }
1042}
#define TRUE
Definition qcstring.h:37

References m_col, m_hide, m_lineOpen, m_t, and TRUE.

◆ startFold()

void HtmlCodeGenerator::startFold ( int lineNr,
const QCString & startMarker,
const QCString & endMarker )
overridevirtual

Implements OutputCodeIntf.

Definition at line 1095 of file htmlgen.cpp.

1096{
1097 //printf("startFold open=%d\n",m_lineOpen);
1098 if (m_lineOpen) // if we have a hidden comment in a code fold, we need to end the line
1099 {
1100 *m_t << "</div>\n";
1101 }
1102 const int maxLineNrStr = 10;
1103 char lineNumber[maxLineNrStr];
1104 qsnprintf(lineNumber,maxLineNrStr,"%05d",lineNr);
1105 *m_t << "<div class=\"foldopen\" id=\"foldopen" << lineNumber <<
1106 "\" data-start=\"" << startMarker <<
1107 "\" data-end=\"" << endMarker <<
1108 "\">\n";
1109 if (m_lineOpen) // if we have a hidden comment in a code fold, we need to restart the line
1110 {
1111 *m_t << "<div class=\"line\">";
1112 }
1113 m_hide=false;
1114}
#define qsnprintf
Definition qcstring.h:49

References m_hide, m_lineOpen, m_t, and qsnprintf.

◆ startFontClass()

void HtmlCodeGenerator::startFontClass ( const QCString & s)
overridevirtual

Implements OutputCodeIntf.

Definition at line 1060 of file htmlgen.cpp.

1061{
1062 if (m_hide) return;
1063 *m_t << "<span class=\"" << s << "\">";
1064}

References m_hide, and m_t.

◆ startSpecialComment()

void HtmlCodeGenerator::startSpecialComment ( )
overridevirtual

Implements OutputCodeIntf.

Definition at line 859 of file htmlgen.cpp.

860{
862 //*m_t << "[START]";
863}
bool m_stripCodeComments
Definition htmlgen.h:77

References m_hide, and m_stripCodeComments.

◆ stripCodeComments()

void HtmlCodeGenerator::stripCodeComments ( bool b)
overridevirtual

Implements OutputCodeIntf.

Definition at line 854 of file htmlgen.cpp.

855{
857}

References m_stripCodeComments.

◆ type()

OutputType HtmlCodeGenerator::type ( ) const
inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 35 of file htmlgen.h.

35{ return OutputType::Html; }

References Html.

Referenced by writeCodeLink().

◆ writeCodeAnchor()

void HtmlCodeGenerator::writeCodeAnchor ( const QCString & anchor)
overridevirtual

Implements OutputCodeIntf.

Definition at line 1072 of file htmlgen.cpp.

1073{
1074 if (m_hide) return;
1075 *m_t << "<a id=\"" << anchor << "\" name=\"" << anchor << "\"></a>";
1076}

References m_hide, and m_t.

◆ writeCodeLink()

void HtmlCodeGenerator::writeCodeLink ( CodeSymbolType type,
const QCString & ref,
const QCString & file,
const QCString & anchor,
const QCString & name,
const QCString & tooltip )
overridevirtual

Implements OutputCodeIntf.

Definition at line 908 of file htmlgen.cpp.

912{
913 if (m_hide) return;
914 const char *hl = codeSymbolType2Str(type);
915 QCString hlClass = "code";
916 if (hl)
917 {
918 hlClass+=" hl_";
919 hlClass+=hl;
920 }
921 _writeCodeLink(hlClass,ref,f,anchor,name,tooltip);
922}
void _writeCodeLink(const QCString &className, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)
Definition htmlgen.cpp:924
OutputType type() const override
Definition htmlgen.h:35
constexpr const char * codeSymbolType2Str(CodeSymbolType type)
Definition types.h:515

References _writeCodeLink(), codeSymbolType2Str(), m_hide, and type().

◆ writeLineNumber()

void HtmlCodeGenerator::writeLineNumber ( const QCString & ref,
const QCString & filename,
const QCString & anchor,
int l,
bool writeLineAnchor )
overridevirtual

Implements OutputCodeIntf.

Definition at line 876 of file htmlgen.cpp.

878{
879 m_lastLineInfo = LineInfo(ref,filename,anchor,l,writeLineAnchor);
880 if (m_hide) return;
881 const int maxLineNrStr = 10;
882 char lineNumber[maxLineNrStr];
883 char lineAnchor[maxLineNrStr];
884 qsnprintf(lineNumber,maxLineNrStr,"%5d",l);
885 qsnprintf(lineAnchor,maxLineNrStr,"l%05d",l);
886
887 //printf("writeLineNumber open=%d\n",m_lineOpen);
888 if (!m_lineOpen)
889 {
890 *m_t << "<div class=\"line\">";
892 }
893
894 if (writeLineAnchor) *m_t << "<a id=\"" << lineAnchor << "\" name=\"" << lineAnchor << "\"></a>";
895 *m_t << "<span class=\"lineno\">";
896 if (!filename.isEmpty())
897 {
898 _writeCodeLink("line",ref,filename,anchor,lineNumber,QCString());
899 }
900 else
901 {
902 codify(lineNumber);
903 }
904 *m_t << "</span>";
905 m_col=0;
906}

References _writeCodeLink(), codify(), QCString::isEmpty(), m_col, m_hide, m_lastLineInfo, m_lineOpen, m_t, qsnprintf, and TRUE.

Referenced by _startOpenLine().

◆ writeTooltip()

void HtmlCodeGenerator::writeTooltip ( const QCString & id,
const DocLinkInfo & docInfo,
const QCString & decl,
const QCString & desc,
const SourceLinkInfo & defInfo,
const SourceLinkInfo & declInfo )
overridevirtual

Implements OutputCodeIntf.

Definition at line 952 of file htmlgen.cpp.

956{
957 if (m_hide) return;
958 *m_t << "<div class=\"ttc\" id=\"" << id << "\">";
959 *m_t << "<div class=\"ttname\">";
960 if (!docInfo.url.isEmpty())
961 {
962 *m_t << "<a href=\"";
963 QCString fn = docInfo.url;
965 *m_t << createHtmlUrl(m_relPath,docInfo.ref,true,
966 fileName()==fn,fn,docInfo.anchor);
967 *m_t << "\">";
968 }
969 codify(docInfo.name);
970 if (!docInfo.url.isEmpty())
971 {
972 *m_t << "</a>";
973 }
974 *m_t << "</div>";
975
976 if (!decl.isEmpty())
977 {
978 *m_t << "<div class=\"ttdeci\">";
979 codify(decl);
980 *m_t << "</div>";
981 }
982
983 if (!desc.isEmpty())
984 {
985 *m_t << "<div class=\"ttdoc\">";
986 codify(desc);
987 *m_t << "</div>";
988 }
989
990 if (!defInfo.file.isEmpty())
991 {
992 *m_t << "<div class=\"ttdef\"><b>" << theTranslator->trDefinition() << "</b> ";
993 if (!defInfo.url.isEmpty())
994 {
995 *m_t << "<a href=\"";
996 QCString fn = defInfo.url;
998 *m_t << createHtmlUrl(m_relPath,defInfo.ref,true,
999 fileName()==fn,fn,defInfo.anchor);
1000 *m_t << "\">";
1001 }
1002 *m_t << defInfo.file << ":" << defInfo.line;
1003 if (!defInfo.url.isEmpty())
1004 {
1005 *m_t << "</a>";
1006 }
1007 *m_t << "</div>";
1008 }
1009 if (!declInfo.file.isEmpty())
1010 {
1011 *m_t << "<div class=\"ttdecl\"><b>" << theTranslator->trDeclaration() << "</b> ";
1012 if (!declInfo.url.isEmpty())
1013 {
1014 *m_t << "<a href=\"";
1015 QCString fn = declInfo.url;
1017 *m_t << createHtmlUrl(m_relPath,declInfo.ref,true,
1018 fileName()==fn,fn,declInfo.anchor);
1019 *m_t << "\">";
1020 }
1021 *m_t << declInfo.file << ":" << declInfo.line;
1022 if (!declInfo.url.isEmpty())
1023 {
1024 *m_t << "</a>";
1025 }
1026 *m_t << "</div>";
1027 }
1028 *m_t << "</div>\n";
1029}
virtual QCString trDeclaration()=0
virtual QCString trDefinition()=0
Translator * theTranslator
Definition language.cpp:71

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.

Member Data Documentation

◆ m_col

size_t HtmlCodeGenerator::m_col = 0
private

Definition at line 73 of file htmlgen.h.

Referenced by _writeCodeLink(), codify(), endCodeLine(), startCodeLine(), and writeLineNumber().

◆ m_fileName

QCString HtmlCodeGenerator::m_fileName
private

Definition at line 75 of file htmlgen.h.

Referenced by fileName(), and setFileName().

◆ m_hide

◆ m_lastLineInfo

LineInfo HtmlCodeGenerator::m_lastLineInfo
private

Definition at line 90 of file htmlgen.h.

Referenced by _startOpenLine(), and writeLineNumber().

◆ m_lineOpen

bool HtmlCodeGenerator::m_lineOpen = false
private

◆ m_relPath

QCString HtmlCodeGenerator::m_relPath
private

Definition at line 74 of file htmlgen.h.

Referenced by _writeCodeLink(), HtmlCodeGenerator(), setRelativePath(), and writeTooltip().

◆ m_stripCodeComments

bool HtmlCodeGenerator::m_stripCodeComments = false
private

Definition at line 77 of file htmlgen.h.

Referenced by startSpecialComment(), and stripCodeComments().

◆ m_stripIndentAmount

size_t HtmlCodeGenerator::m_stripIndentAmount = 0
private

Definition at line 91 of file htmlgen.h.

Referenced by codify(), and setStripIndentAmount().

◆ m_t


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