SQL scanner. More...

#include <sqlscanner.h>

Inheritance diagram for SQLScanner:

Public Member Functions
void	startTranslationUnit (const char *)
	Starts processing a translation unit (source files + headers). More...

void	finishTranslationUnit ()
	Called after all files in a translation unit have been processed.

void	parseInput (const char , const char , Entry *, bool, QStrList &)
	Parses a single input file with the goal to build an Entry tree. More...

bool	needsPreprocessing (const QCString &)
	Returns TRUE if the language identified by extension needs the C preprocessor to be run before feed the result to the input parser. More...

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

void	resetCodeParserState ()
	Resets the state of the code parser. More...

void	parsePrototype (const char *)
	Callback function called by the comment block scanner. More...

Detailed Description

SQL scanner.

Only support syntax highlighting of code at the moment.

Member Function Documentation

§ needsPreprocessing()

bool SQLScanner::needsPreprocessing ( const QCString & extension )

inlinevirtual

Returns TRUE if the language identified by extension needs the C preprocessor to be run before feed the result to the input parser.

See also: parseInput()

Implements ParserInterface.

§ parseCode()

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

inlinevirtual

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

Parameters

[in]	codeOutIntf	Abstract interface for writing the result.
[in]	lang	The programming language of the code fragment.
[in]	scopeName	Name of scope to which the code belongs.
[in]	input	Actual code in the form of a string
[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 fragement
[in]	searchCtx	context under which search data has to be stored.
[in]	collectXRefs	collect cross-reference relations.

Implements ParserInterface.

§ parseInput()

void SQLScanner::parseInput	(	const char *	fileName,
		const char *	fileBuf,
		Entry *	root,
		bool	sameTranslationUnit,
		QStrList &	filesInSameTranslationUnit
	)

inlinevirtual

Parses a single input file with the goal to build an Entry tree.

Parameters

[in]	fileName	The full name of the file.
[in]	fileBuf	The contents of the file (zero terminated).
[in,out]	root	The root of the tree of Entry *nodes representing the information extracted from the file.
[in]	sameTranslationUnit	TRUE if this file was found in the same translation unit (in the filesInSameTranslationUnit list returned for another file).
[in,out]	filesInSameTranslationUnit	other files expected to be found in the same translation unit (used for libclang)

Implements ParserInterface.

§ parsePrototype()

void SQLScanner::parsePrototype ( const char * text )

inlinevirtual

Callback function called by the comment block scanner.

It provides a string text containing the prototype of a function or variable. The parser should parse this and store the information in the Entry node that corresponds with the node for which the comment block parser was invoked.

Implements ParserInterface.

§ resetCodeParserState()

void SQLScanner::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.

See also: parseCode()

Implements ParserInterface.

§ startTranslationUnit()

void SQLScanner::startTranslationUnit ( const char * fileName )

inlinevirtual

Starts processing a translation unit (source files + headers).

After this call parseInput() is called with sameTranslationUnit set to FALSE. If parseInput() returns additional include files, these are also processed using parseInput() with sameTranslationUnit set to TRUE. After that finishTranslationUnit() is called.

Implements ParserInterface.

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

src/sqlscanner.h

Public Member Functions

Detailed Description

Member Function Documentation

§ needsPreprocessing()

§ parseCode()

§ parseInput()

§ parsePrototype()

§ resetCodeParserState()

§ startTranslationUnit()