Generic code parser 更多...

#include <fileparser.h>

类 FileCodeParser 继承关系图:

FileCodeParser 的协作图:

Public 成员函数
virtual	~FileCodeParser ()

void	parseCode (CodeOutputInterface &codeOutIntf, const QCString &scopeName, const QCString &input, SrcLangExt lang, bool isExampleBlock, const QCString &exampleName=QCString(), const FileDef fileDef=0, int startLine=-1, int endLine=-1, bool inlineFragment=FALSE, const MemberDef memberDef=0, bool showLineNumbers=TRUE, const Definition *searchCtx=0, bool collectXRefs=TRUE)
	Parses a source file or fragment with the goal to produce highlighted and cross-referenced output. 更多...

void	resetCodeParserState ()
	Resets the state of the code parser. 更多...

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

详细描述

Generic code parser

在文件 fileparser.h 第 22 行定义.

构造及析构函数说明

◆ ~FileCodeParser()

virtual FileCodeParser::~FileCodeParser ( )

inlinevirtual

在文件 fileparser.h 第 38 行定义.

41 {}

成员函数说明

◆ parseCode()

void FileCodeParser::parseCode	(	CodeOutputInterface &	codeOutIntf,
		const QCString &	scopeName,
		const QCString &	input,
		SrcLangExt	lang,
		bool	isExampleBlock,
		const QCString &	exampleName = `QCString()`,
		const FileDef *	fileDef = `0`,
		int	startLine = `-1`,
		int	endLine = `-1`,
		bool	inlineFragment = `FALSE`,
		const MemberDef *	memberDef = `0`,
		bool	showLineNumbers = `TRUE`,
		const Definition *	searchCtx = `0`,
		bool	collectXRefs = `TRUE`
	)

virtual

Parses a source file or fragment with the goal to produce highlighted and cross-referenced output.

参数

[in]	codeOutIntf	Abstract interface for writing the result.
[in]	scopeName	Name of scope to which the code belongs.
[in]	input	Actual code in the form of a string
[in]	lang	The programming language of the code fragment.
[in]	isExampleBlock	TRUE iff the code is part of an example.
[in]	exampleName	Name of the example.
[in]	fileDef	File definition to which the code is associated.
[in]	startLine	Starting line in case of a code fragment.
[in]	endLine	Ending line of the code fragment.
[in]	inlineFragment	Code fragment that is to be shown inline as part of the documentation.
[in]	memberDef	Member definition to which the code is associated (non null in case of an inline fragment for a member).
[in]	showLineNumbers	if set to TRUE and also fileDef is not 0, line numbers will be added to the source fragment
[in]	searchCtx	context under which search data has to be stored.
[in]	collectXRefs	collect cross-reference relations.

实现了 CodeParserInterface.

在文件 fileparser.cpp 第 19 行定义.

 {
   int lineNr = startLine!=-1 ? startLine : 1;
   int length = input.length();
   int i=0;
   while (i<length && (endLine==-1 || lineNr<=endLine))
   {
     int j=i;
     while (j<length && input[j]!='\n') j++;
     QCString lineStr = input.mid(i,j-i);
     codeOutIntf.startCodeLine(fileDef != 0 && showLineNumbers);
     if (fileDef != 0 && showLineNumbers)
     {
       codeOutIntf.writeLineNumber(QCString(),QCString(),QCString(),lineNr,!inlineFragment);
     }
     if (!lineStr.isEmpty()) codeOutIntf.codify(lineStr.data());
     codeOutIntf.endCodeLine();
     lineNr++;
     i=j+1;
   }
 }

引用了 CodeOutputInterface::codify(), QCString::data(), CodeOutputInterface::endCodeLine(), QCString::isEmpty(), QCString::length(), QCString::mid(), CodeOutputInterface::startCodeLine() , 以及 CodeOutputInterface::writeLineNumber().

◆ resetCodeParserState()

void FileCodeParser::resetCodeParserState ( )

inlinevirtual

Resets the state of the code parser.

Since multiple code fragments can together form a single example, an explicit function is used to reset the code parser state.

参见: parseCode()