40#define DB_VIS_C DB_VIS_C1(m_t)
41#define DB_VIS_C1(x) x << "<!-- DB_VIS_C " << __LINE__ << " -->\n";
42#define DB_VIS_C2(y) DB_VIS_C2a(m_t,y)
43#define DB_VIS_C2a(x,y) x << "<!-- DB_VIS_C " << __LINE__ << " " << y << " -->\n";
48#define DB_VIS_C2a(x,y)
56 const char *p=s.
data();
62 case ':': result+=
"_1";
break;
63 default: result+=c;
break;
71 return (name==
"align" ||
74 name==
"cellpadding" ||
75 name==
"cellspacing" ||
91 result=result.
mid(i+1);
99 int i = result.
find(
'.');
102 result=result.
left(i);
110 for (
const auto &n : children)
124 if (hasCaption && !inlineImage)
133 t <<
" <informalfigure>\n";
135 t <<
" <mediaobject>\n";
136 t <<
" <imageobject>\n";
144 if (!height.
isEmpty() && !inlineImage) t <<
" width=\"50%\"";
150 t <<
" align=\"center\" valign=\"middle\" scalefit=\"0\" fileref=\"" << name <<
"\">";
151 t <<
"</imagedata>\n";
152 t <<
" </imageobject>\n";
153 if (hasCaption && !inlineImage)
162 if (hasCaption && !inlineImage)
166 t <<
" </mediaobject>\n";
167 if (hasCaption && !inlineImage)
173 t <<
" </informalfigure>\n";
252 m_t <<
"<link xlink:href=\"";
264 m_t <<
"<?linebreak?>";
273 m_t <<
"<informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>\n";
274 m_t <<
"</entry></row></tbody></tgroup></informaltable>\n";
284 if (s.
enable())
m_t <<
"<emphasis role=\"bold\">";
else m_t <<
"</emphasis>";
287 if (s.
enable())
m_t <<
"<emphasis>";
else m_t <<
"</emphasis>";
292 if (s.
enable())
m_t <<
"<computeroutput>";
else m_t <<
"</computeroutput>";
295 if (s.
enable())
m_t <<
"<subscript>";
else m_t <<
"</subscript>";
298 if (s.
enable())
m_t <<
"<superscript>";
else m_t <<
"</superscript>";
301 if (s.
enable())
m_t <<
"<informaltable frame='none'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>";
302 else m_t <<
"</entry></row></tbody></tgroup></informaltable>";
307 m_t <<
"<literallayout>";
312 m_t <<
"</literallayout>";
343 m_t <<
"<literallayout><computeroutput>";
350 m_t <<
"</computeroutput></literallayout>";
353 m_t <<
"<literallayout><computeroutput>";
355 m_t <<
"</computeroutput></literallayout>";
361 m_t <<
"<computeroutput>";
363 m_t <<
"</computeroutput>";
380 static int dotindex = 1;
385 name.
sprintf(
"%s%d",
"dot_inline_dotgraph_", dotindex);
390 QCString fileName = baseName+
".dot";
394 err(
"Could not open file {} for writing\n",fileName);
405 static int mscindex = 1;
410 name.
sprintf(
"%s%d",
"msc_inline_mscgraph_", mscindex);
415 QCString fileName = baseName+
".msc";
419 err(
"Could not open file {} for writing\n",fileName);
437 for (
const auto &baseName: baseNameVector)
464 m_t <<
"<literallayout><computeroutput>";
473 m_t <<
"</computeroutput></literallayout>";
477 m_t <<
"<literallayout><computeroutput>";
484 m_t <<
"</computeroutput></literallayout>";
498 m_t <<
"<literallayout>";
500 m_t <<
"</literallayout>";
504 m_t <<
"<literallayout><computeroutput>";
513 m_t <<
"</computeroutput></literallayout>";
525 m_t <<
"<programlisting linenumbering=\"unnumbered\">";
538 std::unique_ptr<FileDef> fd;
578 else m_t <<
" <mediaobject>\n";
579 m_t <<
" <imageobject>\n";
580 m_t <<
" <imagedata ";
581 m_t <<
"align=\"center\" valign=\"middle\" scalefit=\"0\" fileref=\"" << f.
relPath() << f.
name() <<
".png\"/>\n";
582 m_t <<
" </imageobject>\n";
584 else m_t <<
" </mediaobject>\n";
591 m_t <<
"<indexterm><primary>";
593 m_t <<
"</primary></indexterm>\n";
617 if (!opt.noPar())
filter(
"[");
619 if (!opt.noPar())
filter(
"]");
635 m_t <<
"<orderedlist>\n";
639 m_t <<
"<itemizedlist>\n";
644 m_t <<
"</orderedlist>\n";
648 m_t <<
"</itemizedlist>\n";
659 m_t <<
"<listitem override=\"unchecked\">";
663 m_t <<
"<listitem override=\"checked\">";
670 m_t <<
"</listitem>";
789 m_t <<
"<formalpara><title>" <<
theTranslator->trPrecondition() <<
"</title>\n";
799 m_t <<
"<formalpara><title>" <<
theTranslator->trPostcondition() <<
"</title>\n";
809 m_t <<
"<formalpara><title>" <<
theTranslator->trCopyright() <<
"</title>\n";
819 m_t <<
"<formalpara><title>" <<
theTranslator->trInvariant() <<
"</title>\n";
850 m_t <<
"<important><title>" <<
theTranslator->trImportant() <<
"</title>\n";
861 m_t <<
"<formalpara>\n";
869 std::visit(*
this,*s.
title());
879 m_t <<
"</formalpara>\n";
887 m_t <<
"</caution>\n";
890 m_t <<
"</important>\n";
893 m_t <<
"</warning>\n";
896 m_t <<
"</formalpara>\n";
914 m_t <<
"<itemizedlist>\n";
916 m_t <<
"</itemizedlist>\n";
928 m_t <<
"</listitem>\n";
940 std::visit(*
this,*s.
title());
943 m_t <<
"</section>\n";
954 m_t <<
"<itemizedlist>\n";
957 m_t <<
"</orderedlist>\n";
959 m_t <<
"</itemizedlist>\n";
969 bool isFirst = &std::get<DocHtmlListItem>(l->
children().
front())==&s;
972 for (
const auto &opt : s.
attribs())
974 if (opt.name==
"value")
977 int val = opt.value.toInt(&ok);
982 if (value>0 || isFirst)
984 for (
const auto &opt : l->
attribs())
986 if (opt.name==
"type")
989 type =
" numeration=\"arabic\"";
990 else if (opt.value==
"a")
991 type =
" numeration=\"loweralpha\"";
992 else if (opt.value==
"A")
993 type =
" numeration=\"upperalpha\"";
994 else if (opt.value==
"i")
995 type =
" numeration=\"lowerroman\"";
996 else if (opt.value==
"I")
997 type =
" numeration=\"upperroman\"";
999 else if (value==0 && opt.name==
"start")
1002 int val = opt.value.toInt(&ok);
1003 if (ok) value = val;
1008 if (value>0 && !isFirst)
1010 m_t <<
"</orderedlist>\n";
1012 if (value>0 || isFirst)
1014 m_t <<
"<orderedlist";
1016 if (value>0)
m_t <<
" startingnumber=\"" << value <<
"\"";
1020 m_t <<
"<listitem>\n";
1022 m_t <<
"</listitem>\n";
1029 m_t <<
"<variablelist>\n";
1031 m_t <<
"</variablelist>\n";
1038 m_t <<
"<varlistentry><term>";
1040 m_t <<
"</term></varlistentry>\n";
1047 m_t <<
"<listitem>";
1049 m_t <<
"</listitem>\n";
1057 m_t <<
"<informaltable frame=\"all\">\n";
1058 m_t <<
" <tgroup cols=\"" << t.
numColumns() <<
"\" align=\"left\" colsep=\"1\" rowsep=\"1\">\n";
1062 m_t <<
" <colspec colname='c" << i+1 <<
"'/>\n";
1066 std::visit(*
this,*t.
caption());
1071 m_t <<
" </tgroup>\n";
1072 m_t <<
"</informaltable>\n";
1095 for (
const auto &opt : tr.
attribs())
1108 m_t <<
"</thead><tbody>\n";
1120 for (
const auto &opt : c.
attribs())
1122 if (opt.name==
"colspan")
1125 int cols = opt.value.toInt();
1129 else if (opt.name==
"rowspan")
1131 int extraRows = opt.value.toInt() - 1;
1132 m_t <<
" morerows='" << extraRows <<
"'";
1134 else if (opt.name==
"class")
1136 if (opt.value.startsWith(
"markdownTable"))
1138 if (opt.value.endsWith(
"Right"))
1140 m_t <<
" align='right'";
1142 else if (opt.value.endsWith(
"Left"))
1144 m_t <<
" align='left'";
1146 else if (opt.value.endsWith(
"Center"))
1148 m_t <<
" align='center'";
1178 m_t <<
"</caption>\n";
1192 if (href.
url().
at(0) !=
'#')
1208 m_t <<
"<para><emphasis role=\"bold\">";
1210 m_t <<
"</emphasis></para>";
1221 std::visit(*
this,*summary);
1233 m_t <<
"<formalpara><title>";
1235 m_t <<
"</title></formalpara>\n";
1335 m_t <<
"<tocentry>";
1337 m_t <<
"</tocentry>\n";
1354 m_t <<
" <formalpara>\n";
1355 m_t <<
" <title>\n";
1365 m_t <<
"</title>\n";
1367 m_t <<
" <table frame=\"all\">\n";
1373 if (hasInOutSpecs && hasTypeSpecs) ncols += 2;
1374 else if (hasInOutSpecs || hasTypeSpecs) ncols += 1;
1376 m_t <<
" <tgroup cols=\"" << ncols <<
"\" align=\"left\" colsep=\"1\" rowsep=\"1\">\n";
1377 for (
int i = 1; i <= ncols; i++)
1379 if (i == ncols)
m_t <<
" <colspec colwidth=\"4*\"/>\n";
1380 else m_t <<
" <colspec colwidth=\"1*\"/>\n";
1382 m_t <<
" <tbody>\n";
1384 m_t <<
" </tbody>\n";
1385 m_t <<
" </tgroup>\n";
1386 m_t <<
" </table>\n";
1387 m_t <<
" </para>\n";
1388 m_t <<
" </formalpara>\n";
1432 std::visit(*
this,type);
1439 m_t <<
"<entry></entry>\n";
1451 std::visit(*
this,param);
1459 std::visit(*
this,par);
1461 m_t <<
"</entry>\n";
1470 m_t <<
"<para><link linkend=\"_";
1502 m_t <<
"<blockquote>";
1504 m_t <<
"</blockquote>";
1583 for (
const auto &bName: baseNameVector)
1590 visitPreStart(
m_t, children, hasCaption, relPath + baseName +
".png", width, height);
1615 baseName.prepend(
"msc_");
1619 visitPreStart(
m_t, children, hasCaption, relPath + baseName +
".png", width, height);
1653 baseName.prepend(
"dia_");
1657 visitPreStart(
m_t, children, hasCaption, relPath + baseName +
".png", width, height);
1691 baseName.prepend(
"dot_");
1696 visitPreStart(
m_t, children, hasCaption, relPath + baseName +
"." + imgExt, width, height);
void parseCodeFragment(OutputCodeList &codeOutList, const QCString &fileName, const QCString &blockId, const QCString &scopeName, bool showLineNumbers, bool trimLeft, bool stripCodeComments)
static CodeFragmentManager & instance()
virtual void parseCode(OutputCodeList &codeOutList, const QCString &scopeName, const QCString &input, SrcLangExt lang, bool stripCodeComments, bool isExampleBlock, const QCString &exampleName=QCString(), const FileDef *fileDef=nullptr, int startLine=-1, int endLine=-1, bool inlineFragment=FALSE, const MemberDef *memberDef=nullptr, bool showLineNumbers=TRUE, const Definition *searchCtx=nullptr, bool collectXRefs=TRUE)=0
Parses a source file or fragment with the goal to produce highlighted and cross-referenced output.
Class representing a directory in the file system.
bool remove(const std::string &path, bool acceptsAbsPath=true) const
Node representing an anchor.
Node representing an auto List.
Node representing an item of a auto list.
Node representing a citation of some bibliographic reference.
CiteInfoOption option() const
Node representing a dia file.
Node representing a dot file.
Node representing an emoji.
Node representing a Hypertext reference.
Node representing a horizontal ruler.
Node representing an HTML blockquote.
Node representing a HTML table caption.
Node representing a HTML table cell.
const HtmlAttribList & attribs() const
Node representing a HTML description data.
Node representing a Html description list.
Node representing a Html description item.
const DocNodeVariant * summary() const
Node representing a Html list.
const HtmlAttribList & attribs() const
Node representing a HTML list item.
const HtmlAttribList & attribs() const
Node representing a HTML table row.
const HtmlAttribList & attribs() const
Node representing a HTML table.
size_t numColumns() const
const DocNodeVariant * caption() const
Node representing an image.
bool isInlineImage() const
Node representing a include/dontinclude operator block.
bool stripCodeComments() const
QCString includeFileName() const
QCString exampleFile() const
Node representing an included text block from file.
QCString extension() const
bool stripCodeComments() const
QCString exampleFile() const
Node representing an entry in the index.
Node representing an internal section of documentation.
Node representing an internal reference to some item.
Node representing a line break.
Node representing a link to some item.
Node representing a word that can be linked to something.
Node representing a msc file.
DocNodeVariant * parent()
Node representing an block of paragraphs.
Node representing a paragraph in the documentation tree.
Node representing a parameter list.
const DocNodeList & parameters() const
const DocNodeList & paramTypes() const
DocParamSect::Direction direction() const
const DocNodeList & paragraphs() const
Node representing a parameter section.
bool hasInOutSpecifier() const
bool hasTypeSpecifier() const
Node representing a uml file.
Node representing a reference to some item.
QCString targetTitle() const
Root node of documentation tree.
Node representing a reference to a section.
Node representing a list of section references.
Node representing a normal section.
const DocNodeVariant * title() const
Node representing a separator.
Node representing a simple list.
Node representing a simple list item.
const DocNodeVariant * paragraph() const
Node representing a simple section.
const DocNodeVariant * title() const
Node representing a separator between two simple sections of the same type.
Node representing a style change.
Node representing a special symbol.
HtmlEntityMapper::SymType symbol() const
Root node of a text fragment.
Node representing a simple section title.
Node representing a URL (or email address).
Node representing a verbatim, unparsed text fragment.
QCString language() const
const DocNodeList & children() const
QCString exampleFile() const
Node representing a VHDL flow chart.
CodeParserInterface & getCodeParser(const QCString &langExt)
void pushHidden(bool hide)
Node representing some amount of white space.
Node representing a word.
Node representing an item of a cross-referenced list.
void writeDotFile(const QCString &fileName, const DocVerbatim &s)
void visitPreStart(TextStream &t, const DocNodeList &children, bool hasCaption, const QCString &name, const QCString &width, const QCString &height, bool inlineImage=FALSE)
void endDiaFile(bool hasCaption)
void operator()(const DocWord &)
void filter(const QCString &str, const bool retainNewLine=false)
void visitChildren(const T &t)
void startLink(const QCString &file, const QCString &anchor)
void writeMscFile(const QCString &fileName, const DocVerbatim &s)
void startDiaFile(const QCString &fileName, const QCString &relPath, const QCString &width, const QCString &height, bool hasCaption, const DocNodeList &children, const QCString &srcFile, int srcLine)
void startMscFile(const QCString &fileName, const QCString &relPath, const QCString &width, const QCString &height, bool hasCaption, const DocNodeList &children, const QCString &srcFile, int srcLine)
void startDotFile(const QCString &fileName, const QCString &relPath, const QCString &width, const QCString &height, bool hasCaption, const DocNodeList &children, const QCString &srcFile, int srcLine)
void endPlantUmlFile(bool hasCaption)
void visitCaption(const DocNodeList &children)
void writeDiaFile(const QCString &fileName, const DocVerbatim &s)
void endDotFile(bool hasCaption)
void visitPostEnd(TextStream &t, bool hasCaption, bool inlineImage=FALSE)
void writePlantUMLFile(const QCString &fileName, const DocVerbatim &s)
void endMscFile(bool hasCaption)
DocbookDocVisitor(TextStream &t, OutputCodeList &ci, const QCString &langExt)
void startPlantUmlFile(const QCString &fileName, const QCString &relPath, const QCString &width, const QCString &height, bool hasCaption, const DocNodeList &children, const QCString &srcFile, int srcLine)
static FileNameLinkedMap * imageNameLinkedMap
const char * unicode(int index) const
Access routine to the unicode sequence for the Emoji entity.
static EmojiEntityMapper & instance()
Returns the one and only instance of the Emoji entity mapper.
A model of a file symbol.
virtual QCString absFilePath() const =0
Minimal replacement for QFileInfo.
std::string fileName() const
std::string dirPath(bool absPath=true) const
bool empty() const
checks whether the container is empty
T & front()
access the first element
static HtmlEntityMapper & instance()
Returns the one and only instance of the HTML entity mapper.
const char * docbook(SymType symb) const
Access routine to the docbook code of the HTML entity.
Class representing a list of different code generators.
StringVector writePlantUMLSource(const QCString &outDirArg, const QCString &fileName, const QCString &content, OutputFormat format, const QCString &engine, const QCString &srcFile, int srcLine, bool inlineCode)
Write a PlantUML compatible file.
static PlantumlManager & instance()
void generatePlantUMLOutput(const QCString &baseName, const QCString &outDir, OutputFormat format)
Convert a PlantUML file to an image.
This is an alternative implementation of QCString.
int find(char c, int index=0, bool cs=TRUE) const
size_t length() const
Returns the length of the string, not counting the 0-terminator.
QCString mid(size_t index, size_t len=static_cast< size_t >(-1)) const
char & at(size_t i)
Returns a reference to the character at index i.
bool isEmpty() const
Returns TRUE iff the string is empty.
const std::string & str() const
void reserve(size_t size)
Reserve space for size bytes without changing the string contents.
QCString & sprintf(const char *format,...)
int findRev(char c, int index=-1, bool cs=TRUE) const
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string.
QCString left(size_t len) const
Text streaming class that buffers data.
#define Config_getBool(name)
#define Config_getString(name)
void writeDiaGraphFromFile(const QCString &inFile, const QCString &outDir, const QCString &outFile, DiaOutputFormat format, const QCString &srcFile, int srcLine)
QCString convertToDocBook(const QCString &s, const bool retainNewline)
static QCString filterId(const QCString &s)
static QCString makeBaseName(const QCString &name)
static QCString makeShortName(const QCString &baseName)
static bool supportedHtmlAttribute(const QCString &name)
void writeDotGraphFromFile(const QCString &inFile, const QCString &outDir, const QCString &outFile, GraphOutputFormat format, const QCString &srcFile, int srcLine)
std::unique_ptr< FileDef > createFileDef(const QCString &p, const QCString &n, const QCString &ref, const QCString &dn)
Translator * theTranslator
void writeMscGraphFromFile(const QCString &inFile, const QCString &outDir, const QCString &outFile, MscOutputFormat format, const QCString &srcFile, int srcLine)
std::ofstream openOutputStream(const QCString &name, bool append=false)
Portable versions of functions that are platform dependent.
const char * qPrint(const char *s)
SrcLangExt getLanguageFromFileName(const QCString &fileName, SrcLangExt defLang)
QCString stripPath(const QCString &s)
bool readInputFile(const QCString &fileName, std::string &contents, bool filter, bool isSourceCode)
read a file name fileName and optionally filter and transcode it
SrcLangExt getLanguageFromCodeLang(QCString &fileName)
Routine to handle the language attribute of the \code command.
QCString getDotImageExtension()
bool copyFile(const QCString &src, const QCString &dest)
Copies the contents of file with name src to the newly created file with name dest.
QCString getFileNameExtension(const QCString &fn)
FileDef * findFileDef(const FileNameLinkedMap *fnMap, const QCString &n, bool &ambig)
A bunch of utility functions.