XMLScanner Class Reference

#include <xmlscanner.h>

Inheritance diagram for XMLScanner:

Public Member Functions
	XMLScanner ()
virtual	~XMLScanner ()
void	startTranslationUnit (const char *)
void	finishTranslationUnit ()
void	parseInput (const char *, const char *, Entry *, bool, QStrList &)
bool	needsPreprocessing (const QCString &)
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)
void	resetCodeParserState ()
void	parsePrototype (const char *)
Public Member Functions inherited from ParserInterface
virtual	~ParserInterface ()

Detailed Description

XML scanner. Only support syntax highlighting of code at the moment.

Definition at line 24 of file xmlscanner.h.

Constructor & Destructor Documentation

XMLScanner::XMLScanner ( )

inline

Definition at line 27 of file xmlscanner.h.

{}

virtual XMLScanner::~XMLScanner ( )

inlinevirtual

Definition at line 28 of file xmlscanner.h.

{}

Member Function Documentation

void XMLScanner::finishTranslationUnit ( )

inlinevirtual

Called after all files in a translation unit have been processed.

Implements ParserInterface.

Definition at line 30 of file xmlscanner.h.

{}

bool XMLScanner::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.

Definition at line 32 of file xmlscanner.h.

{ return FALSE; }

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

Definition at line 34 of file xmlscanner.h.

    {
      parseXmlCode(codeOutIntf,scopeName,input,isExampleBlock,exampleName,
                    fileDef,startLine,endLine,inlineFragment,memberDef,
                    showLineNumbers,searchCtx,collectXRefs);
    }

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

Definition at line 31 of file xmlscanner.h.

{}

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

Definition at line 60 of file xmlscanner.h.

{}

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

Definition at line 55 of file xmlscanner.h.

    {
      resetXmlCodeParserState();
    }

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

Definition at line 29 of file xmlscanner.h.

{}

---

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

• doxygen-1.8.11/src/xmlscanner.h