Doxygen
Loading...
Searching...
No Matches
docbookgen.cpp File Reference
#include <stdlib.h>
#include "docbookgen.h"
#include "doxygen.h"
#include "message.h"
#include "config.h"
#include "classlist.h"
#include "classdef.h"
#include "diagram.h"
#include "util.h"
#include "defargs.h"
#include "outputgen.h"
#include "dot.h"
#include "dotcallgraph.h"
#include "dotclassgraph.h"
#include "dotdirdeps.h"
#include "dotgroupcollaboration.h"
#include "dotincldepgraph.h"
#include "pagedef.h"
#include "filename.h"
#include "version.h"
#include "docbookvisitor.h"
#include "docparser.h"
#include "language.h"
#include "parserintf.h"
#include "arguments.h"
#include "memberlist.h"
#include "groupdef.h"
#include "memberdef.h"
#include "namespacedef.h"
#include "membername.h"
#include "membergroup.h"
#include "dirdef.h"
#include "section.h"
#include "dir.h"
#include "outputlist.h"
#include "moduledef.h"
Include dependency graph for docbookgen.cpp:

Go to the source code of this file.

Macros

#define Docbook_DB(x)
#define DB_GEN_C
#define DB_GEN_C1(x)
#define DB_GEN_C2(y)
#define DB_GEN_C2a(x, y)

Functions

void writeDocbookString (TextStream &t, const QCString &s)
void writeDocbookCodeString (bool hide, TextStream &t, const QCString &str, size_t &col, size_t stripIndentAmount)
static void addIndexTerm (TextStream &t, QCString prim, QCString sec="")
void writeDocbookLink (TextStream &t, const QCString &, const QCString &compoundId, const QCString &anchorId, const QCString &text, const QCString &)
static QCString objectLinkToString (const QCString &, const QCString &f, const QCString &anchor, const QCString &text)
QCString convertToDocBook (const QCString &s, const bool retainNewline)

Variables

static constexpr auto hex ="0123456789ABCDEF"

Macro Definition Documentation

◆ DB_GEN_C

#define DB_GEN_C

Definition at line 69 of file docbookgen.cpp.

Referenced by DocbookGenerator::addIndexItem(), DocbookGenerator::addLabel(), DocbookGenerator::DocbookGenerator(), DocbookGenerator::docify(), DocbookGenerator::endBold(), DocbookGenerator::endCallGraph(), DocbookGenerator::endClassDiagram(), DocbookGenerator::endCompoundTemplateParams(), DocbookGenerator::endConstraintDocs(), DocbookGenerator::endConstraintList(), DocbookGenerator::endConstraintParam(), DocbookGenerator::endConstraintType(), DocbookGenerator::endDescTable(), DocbookGenerator::endDescTableData(), DocbookGenerator::endDescTableInit(), DocbookGenerator::endDescTableRow(), DocbookGenerator::endDescTableTitle(), DocbookGenerator::endDirDepGraph(), DocbookGenerator::endDotGraph(), DocbookGenerator::endDoxyAnchor(), DocbookGenerator::endExamples(), DocbookGenerator::endFile(), DocbookGenerator::endGroupCollaboration(), DocbookGenerator::endGroupHeader(), DocbookGenerator::endInclDepGraph(), DocbookGenerator::endInlineMemberDoc(), DocbookGenerator::endInlineMemberName(), DocbookGenerator::endInlineMemberType(), DocbookGenerator::endLabels(), DocbookGenerator::endMemberDoc(), DocbookGenerator::endMemberDocList(), DocbookGenerator::endMemberDocName(), DocbookGenerator::endMemberDocPrefixItem(), DocbookGenerator::endMemberDocSimple(), DocbookGenerator::endMemberGroup(), DocbookGenerator::endMemberGroupHeader(), DocbookGenerator::endMemberHeader(), DocbookGenerator::endMemberItem(), DocbookGenerator::endMemberList(), DocbookGenerator::endMemberTemplateParams(), DocbookGenerator::endParagraph(), DocbookGenerator::endParameterDefVal(), DocbookGenerator::endParameterExtra(), DocbookGenerator::endParameterList(), DocbookGenerator::endParameterName(), DocbookGenerator::endSection(), DocbookGenerator::endTextBlock(), DocbookGenerator::endTitleHead(), DocbookGenerator::endTypewriter(), DocbookGenerator::exceptionEntry(), DocbookGenerator::lineBreak(), objectLinkToString(), DocbookGenerator::startBold(), DocbookGenerator::startCallGraph(), DocbookGenerator::startClassDiagram(), DocbookGenerator::startCompoundTemplateParams(), DocbookGenerator::startConstraintDocs(), DocbookGenerator::startConstraintList(), DocbookGenerator::startConstraintParam(), DocbookGenerator::startConstraintType(), DocbookGenerator::startDescTable(), DocbookGenerator::startDescTableData(), DocbookGenerator::startDescTableInit(), DocbookGenerator::startDescTableRow(), DocbookGenerator::startDescTableTitle(), DocbookGenerator::startDirDepGraph(), DocbookGenerator::startDotGraph(), DocbookGenerator::startDoxyAnchor(), DocbookGenerator::startExamples(), DocbookGenerator::startFile(), DocbookGenerator::startGroupCollaboration(), DocbookGenerator::startInclDepGraph(), DocbookGenerator::startInlineMemberDoc(), DocbookGenerator::startInlineMemberName(), DocbookGenerator::startInlineMemberType(), DocbookGenerator::startLabels(), DocbookGenerator::startMemberDocList(), DocbookGenerator::startMemberDocName(), DocbookGenerator::startMemberDocPrefixItem(), DocbookGenerator::startMemberDocSimple(), DocbookGenerator::startMemberGroup(), DocbookGenerator::startMemberGroupHeader(), DocbookGenerator::startMemberHeader(), DocbookGenerator::startMemberItem(), DocbookGenerator::startMemberList(), DocbookGenerator::startMemberTemplateParams(), DocbookGenerator::startParagraph(), DocbookGenerator::startParameterDefVal(), DocbookGenerator::startParameterExtra(), DocbookGenerator::startParameterList(), DocbookGenerator::startParameterName(), DocbookGenerator::startSection(), DocbookGenerator::startTextBlock(), DocbookGenerator::startTitleHead(), DocbookGenerator::startTypewriter(), DocbookGenerator::writeChar(), DocbookGenerator::writeDoc(), DocbookGenerator::writeInheritedSectionTitle(), DocbookGenerator::writeLabel(), DocbookGenerator::writeNonBreakableSpace(), DocbookGenerator::writeObjectLink(), DocbookGenerator::writePageLink(), and DocbookGenerator::writeString().

◆ DB_GEN_C1

#define DB_GEN_C1 ( x)

Definition at line 70 of file docbookgen.cpp.

Referenced by DocbookCodeGenerator::endCodeFragment(), and DocbookCodeGenerator::startCodeFragment().

◆ DB_GEN_C2

#define DB_GEN_C2 ( y)

Definition at line 71 of file docbookgen.cpp.

Referenced by DocbookGenerator::endIndexSection(), DocbookGenerator::startGroupHeader(), DocbookGenerator::startIndexSection(), DocbookGenerator::startMemberDoc(), and DocbookGenerator::writeRuler().

◆ DB_GEN_C2a

#define DB_GEN_C2a ( x,
y )

Definition at line 72 of file docbookgen.cpp.

◆ Docbook_DB

#define Docbook_DB ( x)
Value:
do {} while(0)

Definition at line 57 of file docbookgen.cpp.

Referenced by DocbookCodeGenerator::codify(), DocbookCodeGenerator::endCodeLine(), DocbookCodeGenerator::endFontClass(), DocbookCodeGenerator::startCodeLine(), DocbookCodeGenerator::startFontClass(), DocbookCodeGenerator::writeCodeAnchor(), DocbookCodeGenerator::writeCodeLink(), DocbookCodeGenerator::writeCodeLinkLine(), DocbookCodeGenerator::writeLineNumber(), and DocbookCodeGenerator::writeTooltip().

Function Documentation

◆ addIndexTerm()

void addIndexTerm ( TextStream & t,
QCString prim,
QCString sec = "" )
static

Definition at line 137 of file docbookgen.cpp.

138{
139 t << "<indexterm><primary>";
140 t << convertToDocBook(prim);
141 t << "</primary>";
142 if (!sec.isEmpty())
143 {
144 t << "<secondary>";
145 t << convertToDocBook(sec);
146 t << "</secondary>";
147 }
148 t << "</indexterm>\n";
149}
QCString::isEmpty
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:163
convertToDocBook
QCString convertToDocBook(const QCString &s, const bool retainNewline)
Definition docbookgen.cpp:1484

References convertToDocBook().

Referenced by DocbookGenerator::addIndexItem(), DocbookGenerator::endTitleHead(), and DocbookGenerator::startMemberDoc().

◆ convertToDocBook()

QCString convertToDocBook ( const QCString & s,
const bool retainNewline )

Converts a string to an DocBook-encoded string

Definition at line 1484 of file docbookgen.cpp.

1485{
1486 if (s.isEmpty()) return s;
1487 QCString result;
1488 result.reserve(s.length()+32);
1489 const char *p = s.data();
1490 const char *q = nullptr;
1491 int cnt = 0;
1492 char c = 0;
1493 while ((c=*p++))
1494 {
1495 switch (c)
1496 {
1497 case '\n':
1498 if (retainNewline) result+="<literallayout>&#160;&#xa;</literallayout>";
1499 result+=c;
1500 break;
1501 case '<': result+="&lt;"; break;
1502 case '>': result+="&gt;"; break;
1503 case '&': // possibility to have a special symbol
1504 q = p;
1505 cnt = 2; // we have to count & and ; as well
1506 while ((*q >= 'a' && *q <= 'z') || (*q >= 'A' && *q <= 'Z') || (*q >= '0' && *q <= '9'))
1507 {
1508 cnt++;
1509 q++;
1510 }
1511 if (*q == ';')
1512 {
1513 --p; // we need & as well
1514 HtmlEntityMapper::SymType res = HtmlEntityMapper::instance().name2sym(QCString(p).left(cnt));
1515 if (res == HtmlEntityMapper::Sym_Unknown)
1516 {
1517 p++;
1518 result+="&amp;";
1519 }
1520 else
1521 {
1522 result+=HtmlEntityMapper::instance().docbook(res);
1523 q++;
1524 p = q;
1525 }
1526 }
1527 else
1528 {
1529 result+="&amp;";
1530 }
1531 break;
1532 case '\'': result+="&apos;"; break;
1533 case '"': result+="&quot;"; break;
1534 case 1: case 2: case 3: case 4: case 5: case 6: case 7: case 8:
1535 case 11: case 12: case 14: case 15: case 16: case 17: case 18:
1536 case 19: case 20: case 21: case 22: case 23: case 24: case 25: case 26:
1537 case 27: case 28: case 29: case 30: case 31:
1538 result+="&#x24";
1539 result+=hex[static_cast<uint8_t>(c)>>4];
1540 result+=hex[static_cast<uint8_t>(c)&0xF];
1541 result+=';';
1542 break;
1543 default:
1544 result+=c;
1545 break;
1546 }
1547 }
1548 return result;
1549}
HtmlEntityMapper::instance
static HtmlEntityMapper & instance()
Returns the one and only instance of the HTML entity mapper.
Definition htmlentity.cpp:339
HtmlEntityMapper::docbook
const char * docbook(SymType symb) const
Access routine to the docbook code of the HTML entity.
Definition htmlentity.cpp:402
HtmlEntityMapper::name2sym
SymType name2sym(const QCString &symName) const
Give code of the requested HTML entity name.
Definition htmlentity.cpp:458
QCString
This is an alternative implementation of QCString.
Definition qcstring.h:101
QCString::length
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition qcstring.h:166
QCString::reserve
void reserve(size_t size)
Reserve space for size bytes without changing the string contents.
Definition qcstring.h:185
QCString::data
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string.
Definition qcstring.h:172
hex
static constexpr auto hex
Definition docbookgen.cpp:1481

References QCString::data(), HtmlEntityMapper::docbook(), hex, HtmlEntityMapper::instance(), QCString::isEmpty(), QCString::length(), HtmlEntityMapper::name2sym(), QCString::reserve(), and HtmlEntityMapper::Sym_Unknown.

Referenced by addIndexTerm(), DocbookGenerator::docify(), DocbookDocVisitor::filter(), objectLinkToString(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookGenerator::startDescTable(), DocbookGenerator::startIndexSection(), DocbookGenerator::startMemberDoc(), DocbookGenerator::startMemberDocSimple(), DocbookGenerator::startTocEntry(), DocbookDocVisitor::visitPreStart(), writeDocbookString(), and DocbookGenerator::writeInheritedSectionTitle().

◆ objectLinkToString()

QCString objectLinkToString ( const QCString & ,
const QCString & f,
const QCString & anchor,
const QCString & text )
static

Definition at line 773 of file docbookgen.cpp.

775{
776DB_GEN_C
777 QCString result;
778 if (!anchor.isEmpty())
779 {
780 if (!f.isEmpty()) result += "<link linkend=\"_" + stripPath(f) + "_1" + anchor + "\">";
781 else result += "<link linkend=\"_" + anchor + "\">";
782 }
783 else
784 {
785 result += "<link linkend=\"_" + stripPath(f) + "\">";
786 }
787 result += convertToDocBook(text);
788 result += "</link>";
789 return result;
790}
DB_GEN_C
#define DB_GEN_C
Definition docbookgen.cpp:69
stripPath
QCString stripPath(const QCString &s)
Definition util.cpp:4890

References convertToDocBook(), DB_GEN_C, QCString::isEmpty(), and stripPath().

Referenced by DocbookGenerator::writeInheritedSectionTitle(), LatexGenerator::writeInheritedSectionTitle(), ManGenerator::writeInheritedSectionTitle(), RTFGenerator::writeInheritedSectionTitle(), DocbookGenerator::writeObjectLink(), LatexGenerator::writeObjectLink(), and RTFGenerator::writeObjectLink().

◆ writeDocbookCodeString()

void writeDocbookCodeString ( bool hide,
TextStream & t,
const QCString & str,
size_t & col,
size_t stripIndentAmount )
inline

Definition at line 82 of file docbookgen.cpp.

83{
84 if (str.isEmpty()) return;
85 const int tabSize = Config_getInt(TAB_SIZE);
86 const char *s = str.data();
87 char c=0;
88 if (hide)
89 {
90 col = updateColumnCount(s,col);
91 }
92 else
93 {
94 while ((c=*s++))
95 {
96 switch(c)
97 {
98 case '\t':
99 {
100 int spacesToNextTabStop = tabSize - (col%tabSize);
101 while (spacesToNextTabStop--)
102 {
103 if (col>=stripIndentAmount) t << "&#32;";
104 col++;
105 }
106 break;
107 }
108 case ' ':
109 if (col>=stripIndentAmount) t << "&#32;";
110 col++;
111 break;
112 case '<': t << "&lt;"; col++; break;
113 case '>': t << "&gt;"; col++; break;
114 case '&': t << "&amp;"; col++; break;
115 case '\'': t << "&apos;"; col++; break;
116 case '"': t << "&quot;"; col++; break;
117 default:
118 {
119 uint8_t uc = static_cast<uint8_t>(c);
120 static const char *hex="0123456789ABCDEF";
121 if (uc<32)
122 {
123 t << "&#x24" << hex[uc>>4] << hex[uc&0xF] << ";";
124 }
125 else
126 {
127 t << c;
128 }
129 col++;
130 }
131 break;
132 }
133 }
134 }
135}
Config_getInt
#define Config_getInt(name)
Definition config.h:34
updateColumnCount
size_t updateColumnCount(const char *s, size_t col)
Definition util.cpp:6830

References Config_getInt, QCString::data(), hex, QCString::isEmpty(), and updateColumnCount().

Referenced by DocbookCodeGenerator::codify().

◆ writeDocbookLink()

void writeDocbookLink ( TextStream & t,
const QCString & ,
const QCString & compoundId,
const QCString & anchorId,
const QCString & text,
const QCString &  )

Definition at line 150 of file docbookgen.cpp.

152{
153 t << "<link linkend=\"_" << stripPath(compoundId);
154 if (!anchorId.isEmpty()) t << "_1" << anchorId;
155 t << "\"";
156 t << ">";
157 writeDocbookString(t,text);
158 t << "</link>";
159}
writeDocbookString
void writeDocbookString(TextStream &t, const QCString &s)
Definition docbookgen.cpp:77

References QCString::isEmpty(), stripPath(), and writeDocbookString().

Referenced by DocbookCodeGenerator::writeCodeLink().

◆ writeDocbookString()

void writeDocbookString ( TextStream & t,
const QCString & s )
inline

Definition at line 77 of file docbookgen.cpp.

78{
79 t << convertToDocBook(s);
80}

References convertToDocBook().

Referenced by DocbookCodeGenerator::writeCodeLinkLine(), and writeDocbookLink().

Variable Documentation

◆ hex

auto hex ="0123456789ABCDEF"
staticconstexpr

Definition at line 1481 of file docbookgen.cpp.

Referenced by HtmlCodeGenerator::codify(), convertIndexWordToAnchor(), convertToDocBook(), convertToHtml(), convertToId(), escapeCharsInString(), HtmlDocVisitor::filter(), HtmlDocVisitor::filterQuotedCdataAttr(), getDirectoryBackgroundColor(), latexFilterURL(), letterToLabel(), replaceColorMarkers(), SearchTerm::termEncoded(), and writeDocbookCodeString().