#include <docbookgen.h>

类 DocbookCodeGenerator 继承关系图:

DocbookCodeGenerator 的协作图:

Public 成员函数
	DocbookCodeGenerator (TextStream &t)

virtual	~DocbookCodeGenerator ()

void	setRelativePath (const QCString &path)

void	setSourceFileName (const QCString &sourceFileName)

QCString	sourceFileName ()

void	codify (const QCString &text)

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

void	writeCodeLinkLine (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip, bool)

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

void	startCodeLine (bool)

void	endCodeLine ()

void	startFontClass (const QCString &colorClass)

void	endFontClass ()

void	writeCodeAnchor (const QCString &)

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

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

void	addWord (const QCString &, bool)

void	finish ()

void	startCodeFragment (const QCString &style)

void	endCodeFragment (const QCString &style)

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 = -1

int	m_col = 0

bool	m_insideCodeLine = false

bool	m_insideSpecialHL = false

QCString	m_relPath

QCString	m_sourceFileName

详细描述

在文件 docbookgen.h 第 23 行定义.

构造及析构函数说明

◆ DocbookCodeGenerator()

DocbookCodeGenerator::DocbookCodeGenerator ( TextStream & t )

在文件 docbookgen.cpp 第 146 行定义.

                                                         : m_t(t)
 {
 }

◆ ~DocbookCodeGenerator()

DocbookCodeGenerator::~DocbookCodeGenerator ( )

virtual

在文件 docbookgen.cpp 第 150 行定义.

150 {}

成员函数说明

◆ addWord()

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

virtual

实现了 CodeOutputInterface.

在文件 docbookgen.cpp 第 260 行定义.

261 {

262 }

◆ codify()

void DocbookCodeGenerator::codify ( const QCString & s )

virtual

Writes an code fragment to the output. This function should keep spaces visible, should break lines at a newline and should convert tabs to the right number of spaces.

实现了 CodeOutputInterface.

在文件 docbookgen.cpp 第 152 行定义.

 {
   Docbook_DB(("(codify \"%s\")\n",text));
   writeDocbookCodeString(m_t,text,m_col);
 }

引用了 Docbook_DB, m_col, m_t , 以及 writeDocbookCodeString().

被这些函数引用 DocbookGenerator::codify() , 以及 writeLineNumber().

◆ endCodeFragment()

void DocbookCodeGenerator::endCodeFragment ( const QCString & style )

virtual

Ends a block of code

实现了 CodeOutputInterface.

在文件 docbookgen.cpp 第 275 行定义.

 {
 DB_GEN_C1(m_t)
   //endCodeLine checks is there is still an open code line, if so closes it.
   endCodeLine();
  
   m_t << "</programlisting>";
 }

引用了 DB_GEN_C1, endCodeLine() , 以及 m_t.

被这些函数引用 DocbookGenerator::endCodeFragment().

◆ endCodeLine()

void DocbookCodeGenerator::endCodeLine ( )

virtual

Ends a line of code started with startCodeLine()

实现了 CodeOutputInterface.

在文件 docbookgen.cpp 第 196 行定义.

 {
   if (m_insideCodeLine) m_t << "\n";
   Docbook_DB(("(endCodeLine)\n"));
   m_lineNumber = -1;
   m_refId.resize(0);
   m_external.resize(0);
   m_insideCodeLine=FALSE;
 }

引用了 Docbook_DB, FALSE, m_external, m_insideCodeLine, m_lineNumber, m_refId, m_t , 以及 QCString::resize().

被这些函数引用 endCodeFragment(), DocbookGenerator::endCodeLine() , 以及 finish().

◆ endFontClass()

void DocbookCodeGenerator::endFontClass ( )

virtual

Ends a block started with startFontClass()

实现了 CodeOutputInterface.

在文件 docbookgen.cpp 第 213 行定义.

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

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

被这些函数引用 DocbookGenerator::endFontClass().

◆ finish()

void DocbookCodeGenerator::finish ( )

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

 {
   endCodeLine();
 }

引用了 endCodeLine().

◆ setCurrentDoc()

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

virtual

实现了 CodeOutputInterface.

在文件 docbookgen.cpp 第 256 行定义.

257 {

258 }

◆ setRelativePath()

void DocbookCodeGenerator::setRelativePath ( const QCString & path )

inline

在文件 docbookgen.h 第 40 行定义.

57 :

58 TextStream &m_t;

被这些函数引用 DocbookGenerator::startFile().

◆ setSourceFileName()

void DocbookCodeGenerator::setSourceFileName ( const QCString & sourceFileName )

inline

在文件 docbookgen.h 第 41 行定义.

57 :

58 TextStream &m_t;

被这些函数引用 DocbookGenerator::endFile() , 以及 DocbookGenerator::startFile().

◆ sourceFileName()

QCString DocbookCodeGenerator::sourceFileName ( )

inline

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

57 :

58 TextStream &m_t;

被这些函数引用 DocbookGenerator::endFile().

◆ startCodeFragment()

void DocbookCodeGenerator::startCodeFragment ( const QCString & style )

virtual

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.

在文件 docbookgen.cpp 第 269 行定义.

 {
 DB_GEN_C1(m_t)
   m_t << "<programlisting linenumbering=\"unnumbered\">";
 }

引用了 DB_GEN_C1 , 以及 m_t.

被这些函数引用 DocbookGenerator::startCodeFragment().

◆ startCodeLine()

void DocbookCodeGenerator::startCodeLine ( bool )

virtual

实现了 CodeOutputInterface.

在文件 docbookgen.cpp 第 189 行定义.

 {
   Docbook_DB(("(startCodeLine)\n"));
   m_insideCodeLine=TRUE;
   m_col=0;
 }

引用了 Docbook_DB, m_col, m_insideCodeLine , 以及 TRUE.

被这些函数引用 DocbookGenerator::startCodeLine().

◆ startFontClass()

void DocbookCodeGenerator::startFontClass ( const QCString & clsName )

virtual

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.

在文件 docbookgen.cpp 第 206 行定义.

 {
   Docbook_DB(("(startFontClass)\n"));
   m_t << "<emphasis role=\"" << colorClass << "\">";
   m_insideSpecialHL=TRUE;
 }

引用了 Docbook_DB, m_insideSpecialHL, m_t , 以及 TRUE.

被这些函数引用 DocbookGenerator::startFontClass().

◆ writeCodeAnchor()

void DocbookCodeGenerator::writeCodeAnchor ( const QCString & name )

virtual

Write an anchor to a source listing.

参数

name	The name of the anchor.

实现了 CodeOutputInterface.

在文件 docbookgen.cpp 第 220 行定义.

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

引用了 Docbook_DB.

被这些函数引用 DocbookGenerator::writeCodeAnchor().

◆ writeCodeLink()

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

virtual

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.

在文件 docbookgen.cpp 第 158 行定义.

 {
   Docbook_DB(("(writeCodeLink)\n"));
   writeDocbookLink(m_t,ref,file,anchor,name,tooltip);
   m_col+=name.length();
 }

引用了 Docbook_DB, QCString::length(), m_col, m_t , 以及 writeDocbookLink().

被这些函数引用 DocbookGenerator::writeCodeLink() , 以及 writeLineNumber().

◆ writeCodeLinkLine()

void DocbookCodeGenerator::writeCodeLinkLine	(	CodeSymbolType	type,
		const QCString &	ref,
		const QCString &	file,
		const QCString &	anchor,
		const QCString &	name,
		const QCString &	tooltip,
		bool	writeLineAnchor
	)

在文件 docbookgen.cpp 第 168 行定义.

 {
   Docbook_DB(("(writeCodeLinkLine)\n"));
   if (!writeLineAnchor) return;
   m_t << "<anchor xml:id=\"_" << stripExtensionGeneral(stripPath(file),".xml");
   m_t << "_1l";
   writeDocbookString(m_t,name);
   m_t << "\"/>";
   m_col+=name.length();
 }

引用了 Docbook_DB, QCString::length(), m_col, m_t, stripExtensionGeneral(), stripPath() , 以及 writeDocbookString().

被这些函数引用 writeLineNumber().

◆ writeLineNumber()

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

virtual

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.

在文件 docbookgen.cpp 第 225 行定义.

 {
   Docbook_DB(("(writeLineNumber)\n"));
   m_insideCodeLine = TRUE;
   if (Config_getBool(SOURCE_BROWSER))
   {
     QCString lineNumber;
     lineNumber.sprintf("%05d",l);
  
     if (!m_sourceFileName.isEmpty())
     {
       writeCodeLinkLine(CodeSymbolType::Default,ref,m_sourceFileName,anchor,lineNumber,QCString(),writeLineAnchor);
     }
     if (!fileName.isEmpty())
     {
       writeCodeLink(CodeSymbolType::Default,ref,fileName,anchor,lineNumber,QCString());
     }
     else
     {
       codify(lineNumber);
     }
     m_t << " ";
   }
   else
   {
     m_t << l << " ";
   }
   m_col=0;
 }

引用了 codify(), Config_getBool, Default, Docbook_DB, QCString::isEmpty(), m_col, m_insideCodeLine, m_sourceFileName, m_t, QCString::sprintf(), TRUE, writeCodeLink() , 以及 writeCodeLinkLine().

被这些函数引用 DocbookGenerator::writeLineNumber().

◆ writeTooltip()

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

virtual

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.

在文件 docbookgen.cpp 第 182 行定义.

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

引用了 Docbook_DB.

被这些函数引用 DocbookGenerator::writeTooltip().

类成员变量说明

◆ m_col

int DocbookCodeGenerator::m_col = 0

private

在文件 docbookgen.h 第 74 行定义.

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

◆ m_external

QCString DocbookCodeGenerator::m_external

private

在文件 docbookgen.h 第 72 行定义.

被这些函数引用 endCodeLine().

◆ m_insideCodeLine

bool DocbookCodeGenerator::m_insideCodeLine = false

private

在文件 docbookgen.h 第 75 行定义.

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

◆ m_insideSpecialHL

bool DocbookCodeGenerator::m_insideSpecialHL = false

private

在文件 docbookgen.h 第 76 行定义.

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

◆ m_lineNumber

int DocbookCodeGenerator::m_lineNumber = -1

private

在文件 docbookgen.h 第 73 行定义.

被这些函数引用 endCodeLine().

◆ m_refId

QCString DocbookCodeGenerator::m_refId

private

在文件 docbookgen.h 第 71 行定义.

被这些函数引用 endCodeLine().

◆ m_relPath

QCString DocbookCodeGenerator::m_relPath

private

在文件 docbookgen.h 第 77 行定义.

◆ m_sourceFileName

QCString DocbookCodeGenerator::m_sourceFileName

private

在文件 docbookgen.h 第 78 行定义.

被这些函数引用 writeLineNumber().

◆ m_t

TextStream& DocbookCodeGenerator::m_t

private

在文件 docbookgen.h 第 70 行定义.

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

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

src/docbookgen.h
src/docbookgen.cpp

Public 成员函数

Private 属性

详细描述

构造及析构函数说明

◆ DocbookCodeGenerator()

◆ ~DocbookCodeGenerator()

成员函数说明

◆ addWord()

◆ codify()

◆ endCodeFragment()

◆ endCodeLine()

◆ endFontClass()

◆ finish()

◆ setCurrentDoc()

◆ setRelativePath()

◆ setSourceFileName()

◆ sourceFileName()

◆ startCodeFragment()

◆ startCodeLine()

◆ startFontClass()

◆ writeCodeAnchor()

◆ writeCodeLink()

◆ writeCodeLinkLine()

◆ writeLineNumber()

◆ writeTooltip()

类成员变量说明

◆ m_col

◆ m_external

◆ m_insideCodeLine

◆ m_insideSpecialHL

◆ m_lineNumber

◆ m_refId

◆ m_relPath

◆ m_sourceFileName

◆ m_t