Output interface for code parser. More...

#include <outputgen.h>

Inheritance diagram for CodeOutputInterface:

Public Member Functions
	CodeOutputInterface (const CodeOutputInterface &)=delete

CodeOutputInterface &	operator= (const CodeOutputInterface &)=delete

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

virtual void	codify (const QCString &s)=0

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

virtual void	writeLineNumber (const QCString &ref, const QCString &file, const QCString &anchor, int lineNumber, bool writeLineAnchor)=0

virtual void	writeTooltip (const QCString &id, const DocLinkInfo &docInfo, const QCString &decl, const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)=0

virtual void	startCodeLine (bool hasLineNumbers)=0

virtual void	endCodeLine ()=0

virtual void	startFontClass (const QCString &clsName)=0

virtual void	endFontClass ()=0

virtual void	writeCodeAnchor (const QCString &name)=0

virtual void	setCurrentDoc (const Definition *context, const QCString &anchor, bool isSourceFile)

virtual void	addWord (const QCString &word, bool hiPriority)

virtual void	startCodeFragment (const QCString &style)=0

virtual void	endCodeFragment (const QCString &style)=0

Detailed Description

Output interface for code parser.

Member Function Documentation

◆ codify()

virtual void CodeOutputInterface::codify ( const QCString & s )

pure 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.

Implemented in DevNullCodeDocInterface, OutputList, DocbookGenerator, LatexGenerator, HtmlGenerator, RTFGenerator, ManGenerator, LatexCodeGenerator, DocbookCodeGenerator, HtmlCodeGenerator, and XMLCodeGenerator.

◆ endCodeFragment()

virtual void CodeOutputInterface::endCodeFragment ( const QCString & style )

pure virtual

Ends a block of code

Implemented in OutputList, DevNullCodeDocInterface, DocbookGenerator, RTFGenerator, ManGenerator, LatexGenerator, HtmlGenerator, LatexCodeGenerator, DocbookCodeGenerator, HtmlCodeGenerator, and XMLCodeGenerator.

◆ endCodeLine()

virtual void CodeOutputInterface::endCodeLine ( )

pure virtual

Ends a line of code started with startCodeLine()

Implemented in OutputList, DevNullCodeDocInterface, RTFGenerator, ManGenerator, DocbookGenerator, LatexGenerator, HtmlGenerator, LatexCodeGenerator, DocbookCodeGenerator, HtmlCodeGenerator, and XMLCodeGenerator.

◆ endFontClass()

virtual void CodeOutputInterface::endFontClass ( )

pure virtual

Ends a block started with startFontClass()

Implemented in OutputList, RTFGenerator, ManGenerator, DevNullCodeDocInterface, DocbookGenerator, LatexGenerator, HtmlGenerator, LatexCodeGenerator, DocbookCodeGenerator, HtmlCodeGenerator, and XMLCodeGenerator.

◆ startCodeFragment()

virtual void CodeOutputInterface::startCodeFragment ( const QCString & style )

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

Parameters

style The kind of code fragment.

Implemented in OutputList, DevNullCodeDocInterface, DocbookGenerator, RTFGenerator, ManGenerator, LatexGenerator, HtmlGenerator, LatexCodeGenerator, DocbookCodeGenerator, HtmlCodeGenerator, and XMLCodeGenerator.

◆ startFontClass()

virtual void CodeOutputInterface::startFontClass ( const QCString & clsName )

pure 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'.

Parameters

clsName The category name.

Implemented in OutputList, RTFGenerator, ManGenerator, DevNullCodeDocInterface, DocbookGenerator, LatexGenerator, HtmlGenerator, LatexCodeGenerator, DocbookCodeGenerator, HtmlCodeGenerator, and XMLCodeGenerator.

◆ writeCodeAnchor()

virtual void CodeOutputInterface::writeCodeAnchor ( const QCString & name )

pure virtual

Write an anchor to a source listing.

Parameters

name	The name of the anchor.

Implemented in OutputList, RTFGenerator, ManGenerator, DevNullCodeDocInterface, DocbookGenerator, LatexGenerator, HtmlGenerator, LatexCodeGenerator, DocbookCodeGenerator, HtmlCodeGenerator, and XMLCodeGenerator.

◆ writeCodeLink()

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

pure virtual

Writes a link to an object in a code fragment.

Parameters

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.

Implemented in DevNullCodeDocInterface, OutputList, DocbookGenerator, LatexGenerator, HtmlGenerator, RTFGenerator, ManGenerator, LatexCodeGenerator, DocbookCodeGenerator, HtmlCodeGenerator, and XMLCodeGenerator.

◆ writeLineNumber()

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

pure virtual

Writes the line number of a source listing

Parameters

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

Implemented in OutputList, DevNullCodeDocInterface, RTFGenerator, ManGenerator, DocbookGenerator, LatexGenerator, HtmlGenerator, DocbookCodeGenerator, LatexCodeGenerator, HtmlCodeGenerator, and XMLCodeGenerator.

◆ writeTooltip()

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

pure virtual

Writes a tool tip definition

Parameters

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

Implemented in DevNullCodeDocInterface, OutputList, DocbookGenerator, LatexGenerator, HtmlGenerator, RTFGenerator, ManGenerator, DocbookCodeGenerator, LatexCodeGenerator, HtmlCodeGenerator, and XMLCodeGenerator.

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

src/outputgen.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ codify()

◆ endCodeFragment()

◆ endCodeLine()

◆ endFontClass()

◆ startCodeFragment()

◆ startFontClass()

◆ writeCodeAnchor()

◆ writeCodeLink()

◆ writeLineNumber()

◆ writeTooltip()