#include <xmlgen.h>

类 XMLCodeGenerator 继承关系图:

XMLCodeGenerator 的协作图:

Public 成员函数
	XMLCodeGenerator (TextStream &t)

virtual	~XMLCodeGenerator ()

void	codify (const QCString &text) override
	Generator for producing XML formatted source code. 更多...

void	writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip) override

void	writeTooltip (const QCString &, const DocLinkInfo &, const QCString &, const QCString &, const SourceLinkInfo &, const SourceLinkInfo &) override

void	startCodeLine (bool) override

void	endCodeLine () override

void	startFontClass (const QCString &colorClass) override

void	endFontClass () override

void	writeCodeAnchor (const QCString &) override

void	writeLineNumber (const QCString &extRef, const QCString &compId, const QCString &anchorId, int l, bool writeLineAnchor) override

void	setCurrentDoc (const Definition *, const QCString &, bool) override

void	addWord (const QCString &, bool) override

void	startCodeFragment (const QCString &) override

void	endCodeFragment (const QCString &) override

void	finish ()

Public 成员函数继承自 CodeOutputInterface
virtual	~CodeOutputInterface ()

	CodeOutputInterface ()

	CodeOutputInterface (const CodeOutputInterface &)=delete

CodeOutputInterface &	operator= (const CodeOutputInterface &)=delete

virtual int	id () const
	Identifier for the output file 更多...

Private 属性
TextStream &	m_t

QCString	m_refId

QCString	m_external

int	m_lineNumber

bool	m_isMemberRef

int	m_col

bool	m_insideCodeLine

bool	m_normalHLNeedStartTag

bool	m_insideSpecialHL

详细描述

在文件 xmlgen.h 第 20 行定义.

构造及析构函数说明

◆ XMLCodeGenerator()

XMLCodeGenerator::XMLCodeGenerator ( TextStream & t )

在文件 xmlgen.cpp 第 228 行定义.

                                                 : m_t(t), m_lineNumber(-1), m_isMemberRef(FALSE), m_col(0),
       m_insideCodeLine(FALSE), m_normalHLNeedStartTag(TRUE), m_insideSpecialHL(FALSE)
 {
 }

◆ ~XMLCodeGenerator()

virtual XMLCodeGenerator::~XMLCodeGenerator ( )

inlinevirtual

在文件 xmlgen.h 第 25 行定义.

25 { }

成员函数说明

◆ addWord()

void XMLCodeGenerator::addWord	(	const QCString &	,
		bool
	)

inlineoverridevirtual

实现了 CodeOutputInterface.

在文件 xmlgen.h 第 43 行定义.

43 {}

◆ codify()

void XMLCodeGenerator::codify ( const QCString & text )

overridevirtual

Generator for producing XML formatted source code.

实现了 CodeOutputInterface.

在文件 xmlgen.cpp 第 234 行定义.

 {
   XML_DB(("(codify \"%s\")\n",text));
   if (m_insideCodeLine && !m_insideSpecialHL && m_normalHLNeedStartTag)
   {
     m_t << "<highlight class=\"normal\">";
     m_normalHLNeedStartTag=FALSE;
   }
   writeXMLCodeString(m_t,text,m_col);
 }

引用了 FALSE, m_col, m_insideCodeLine, m_insideSpecialHL, m_normalHLNeedStartTag, m_t, writeXMLCodeString() , 以及 XML_DB.

◆ endCodeFragment()

void XMLCodeGenerator::endCodeFragment ( const QCString & style )

overridevirtual

Ends a block of code

实现了 CodeOutputInterface.

在文件 xmlgen.cpp 第 352 行定义.

 {
   m_t << "    </programlisting>\n";
 }

引用了 m_t.

被这些函数引用 writeXMLCodeBlock().

◆ endCodeLine()

void XMLCodeGenerator::endCodeLine ( )

overridevirtual

Ends a line of code started with startCodeLine()

实现了 CodeOutputInterface.

在文件 xmlgen.cpp 第 292 行定义.

 {
   XML_DB(("(endCodeLine)\n"));
   if (!m_insideSpecialHL && !m_normalHLNeedStartTag)
   {
     m_t << "</highlight>";
     m_normalHLNeedStartTag=TRUE;
   }
   m_t << "</codeline>\n"; // non DocBook
   m_lineNumber = -1;
   m_refId.resize(0);
   m_external.resize(0);
   m_insideCodeLine=FALSE;
 }

引用了 FALSE, m_external, m_insideCodeLine, m_insideSpecialHL, m_lineNumber, m_normalHLNeedStartTag, m_refId, m_t, QCString::resize(), TRUE , 以及 XML_DB.

被这些函数引用 finish().

◆ endFontClass()

void XMLCodeGenerator::endFontClass ( )

overridevirtual

Ends a block started with startFontClass()

实现了 CodeOutputInterface.

在文件 xmlgen.cpp 第 317 行定义.

 {
   XML_DB(("(endFontClass)\n"));
   m_t << "</highlight>"; // non DocBook
   m_insideSpecialHL=FALSE;
 }

引用了 FALSE, m_insideSpecialHL, m_t , 以及 XML_DB.

◆ finish()

void XMLCodeGenerator::finish ( )

在文件 xmlgen.cpp 第 342 行定义.

 {
   if (m_insideCodeLine) endCodeLine();
 }

引用了 endCodeLine() , 以及 m_insideCodeLine.

被这些函数引用 writeXMLCodeBlock().

◆ setCurrentDoc()

void XMLCodeGenerator::setCurrentDoc	(	const Definition *	,
		const QCString &	,
		bool
	)

inlineoverridevirtual

实现了 CodeOutputInterface.

在文件 xmlgen.h 第 42 行定义.

42 {}

◆ startCodeFragment()

void XMLCodeGenerator::startCodeFragment ( const QCString & style )

overridevirtual

Starts a source code fragment. The fragment will be fed to the code parser (see code.h) for syntax highlighting and cross-referencing. The fragment ends by a call to endCodeFragment()

参数

style The kind of code fragment.

实现了 CodeOutputInterface.

在文件 xmlgen.cpp 第 347 行定义.

 {
   m_t << "    <programlisting>\n";
 }

引用了 m_t.

被这些函数引用 writeXMLCodeBlock().

◆ startCodeLine()

void XMLCodeGenerator::startCodeLine ( bool )

overridevirtual

实现了 CodeOutputInterface.

在文件 xmlgen.cpp 第 264 行定义.

 {
   XML_DB(("(startCodeLine)\n"));
   m_t << "<codeline";
   if (m_lineNumber!=-1)
   {
     m_t << " lineno=\"" << m_lineNumber << "\"";
     if (!m_refId.isEmpty())
     {
       m_t << " refid=\"" << m_refId << "\"";
       if (m_isMemberRef)
       {
         m_t << " refkind=\"member\"";
       }
       else
       {
         m_t << " refkind=\"compound\"";
       }
     }
     if (!m_external.isEmpty())
     {
       m_t << " external=\"" << m_external << "\"";
     }
   }
   m_t << ">";
   m_insideCodeLine=TRUE;
   m_col=0;
 }

引用了 QCString::isEmpty(), m_col, m_external, m_insideCodeLine, m_isMemberRef, m_lineNumber, m_refId, m_t, TRUE , 以及 XML_DB.

◆ startFontClass()

void XMLCodeGenerator::startFontClass ( const QCString & clsName )

overridevirtual

Starts a block with a certain meaning. Used for syntax highlighting, which elements of the same type are rendered using the same 'font class'.

参数

clsName The category name.

实现了 CodeOutputInterface.

在文件 xmlgen.cpp 第 306 行定义.

 {
   XML_DB(("(startFontClass)\n"));
   if (m_insideCodeLine && !m_insideSpecialHL && !m_normalHLNeedStartTag)
   {
     m_t << "</highlight>";
     m_normalHLNeedStartTag=TRUE;
   }
   m_t << "<highlight class=\"" << colorClass << "\">"; // non DocBook
   m_insideSpecialHL=TRUE;
 }

引用了 m_insideCodeLine, m_insideSpecialHL, m_normalHLNeedStartTag, m_t, TRUE , 以及 XML_DB.

◆ writeCodeAnchor()

void XMLCodeGenerator::writeCodeAnchor ( const QCString & name )

overridevirtual

Write an anchor to a source listing.

参数

name	The name of the anchor.

实现了 CodeOutputInterface.

在文件 xmlgen.cpp 第 323 行定义.

 {
   XML_DB(("(writeCodeAnchor)\n"));
 }

引用了 XML_DB.

◆ writeCodeLink()

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

overridevirtual

Writes a link to an object in a code fragment.

参数

type	The type of symbol, used for semantic syntax highlighting, may be Default is no info is available.
ref	If this is non-zero, the object is to be found in an external documentation file.
file	The file in which the object is located.
anchor	The anchor uniquely identifying the object within the file.
name	The text to display as a placeholder for the link.
tooltip	The tooltip to display when the mouse is on the link.

实现了 CodeOutputInterface.

在文件 xmlgen.cpp 第 244 行定义.

 {
   XML_DB(("(writeCodeLink)\n"));
   if (m_insideCodeLine && !m_insideSpecialHL && m_normalHLNeedStartTag)
   {
     m_t << "<highlight class=\"normal\">";
     m_normalHLNeedStartTag=FALSE;
   }
   writeXMLLink(m_t,ref,file,anchor,name,tooltip);
   m_col+=name.length();
 }

引用了 FALSE, QCString::length(), m_col, m_insideCodeLine, m_insideSpecialHL, m_normalHLNeedStartTag, m_t, writeXMLLink() , 以及 XML_DB.

◆ writeLineNumber()

void XMLCodeGenerator::writeLineNumber	(	const QCString &	ref,
		const QCString &	file,
		const QCString &	anchor,
		int	lineNumber,
		bool	writeLineAnchor
	)

overridevirtual

Writes the line number of a source listing

参数

ref	External reference (when imported from a tag file)
file	The file part of the URL pointing to the docs.
anchor	The anchor part of the URL pointing to the docs.
lineNumber	The line number to write
writeLineAnchor	Indicates if an anchor for the line number needs to be written

实现了 CodeOutputInterface.

在文件 xmlgen.cpp 第 327 行定义.

 {
   XML_DB(("(writeLineNumber)\n"));
   // we remember the information provided here to use it
   // at the <codeline> start tag.
   m_lineNumber = l;
   if (!compId.isEmpty())
   {
     m_refId=compId;
     if (!anchorId.isEmpty()) m_refId+=(QCString)"_1"+anchorId;
     m_isMemberRef = anchorId!=0;
     if (!extRef.isEmpty()) m_external=extRef;
   }
 }

引用了 QCString::isEmpty(), m_external, m_isMemberRef, m_lineNumber, m_refId , 以及 XML_DB.

◆ writeTooltip()

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

overridevirtual

Writes a tool tip definition

参数

id	unique identifier for the tooltip
docInfo	Info about the symbol's documentation.
decl	full declaration of the symbol (for functions)
desc	brief description for the symbol
defInfo	Info about the symbol's definition in the source code
declInfo	Info about the symbol's declaration in the source code

实现了 CodeOutputInterface.

在文件 xmlgen.cpp 第 258 行定义.

 {
   XML_DB(("(writeToolTip)\n"));
 }

引用了 XML_DB.

类成员变量说明

◆ m_col

int XMLCodeGenerator::m_col

private

在文件 xmlgen.h 第 55 行定义.

被这些函数引用 codify(), startCodeLine() , 以及 writeCodeLink().

◆ m_external

QCString XMLCodeGenerator::m_external

private

在文件 xmlgen.h 第 52 行定义.

被这些函数引用 endCodeLine(), startCodeLine() , 以及 writeLineNumber().

◆ m_insideCodeLine

bool XMLCodeGenerator::m_insideCodeLine

private

在文件 xmlgen.h 第 57 行定义.

被这些函数引用 codify(), endCodeLine(), finish(), startCodeLine(), startFontClass() , 以及 writeCodeLink().

◆ m_insideSpecialHL

bool XMLCodeGenerator::m_insideSpecialHL

private

在文件 xmlgen.h 第 59 行定义.

被这些函数引用 codify(), endCodeLine(), endFontClass(), startFontClass() , 以及 writeCodeLink().

◆ m_isMemberRef

bool XMLCodeGenerator::m_isMemberRef

private

在文件 xmlgen.h 第 54 行定义.

被这些函数引用 startCodeLine() , 以及 writeLineNumber().

◆ m_lineNumber

int XMLCodeGenerator::m_lineNumber

private

在文件 xmlgen.h 第 53 行定义.

被这些函数引用 endCodeLine(), startCodeLine() , 以及 writeLineNumber().

◆ m_normalHLNeedStartTag

bool XMLCodeGenerator::m_normalHLNeedStartTag

private

在文件 xmlgen.h 第 58 行定义.

被这些函数引用 codify(), endCodeLine(), startFontClass() , 以及 writeCodeLink().

◆ m_refId

QCString XMLCodeGenerator::m_refId

private

在文件 xmlgen.h 第 51 行定义.

被这些函数引用 endCodeLine(), startCodeLine() , 以及 writeLineNumber().

◆ m_t

TextStream& XMLCodeGenerator::m_t

private

在文件 xmlgen.h 第 50 行定义.

被这些函数引用 codify(), endCodeFragment(), endCodeLine(), endFontClass(), startCodeFragment(), startCodeLine(), startFontClass() , 以及 writeCodeLink().

该类的文档由以下文件生成:

src/xmlgen.h
src/xmlgen.cpp

Public 成员函数

Private 属性

详细描述

构造及析构函数说明

◆ XMLCodeGenerator()

◆ ~XMLCodeGenerator()

成员函数说明

◆ addWord()

◆ codify()

◆ endCodeFragment()

◆ endCodeLine()

◆ endFontClass()

◆ finish()

◆ setCurrentDoc()

◆ startCodeFragment()

◆ startCodeLine()

◆ startFontClass()

◆ writeCodeAnchor()

◆ writeCodeLink()

◆ writeLineNumber()

◆ writeTooltip()

类成员变量说明

◆ m_col

◆ m_external

◆ m_insideCodeLine

◆ m_insideSpecialHL

◆ m_isMemberRef

◆ m_lineNumber

◆ m_normalHLNeedStartTag

◆ m_refId

◆ m_t