CLanguageScanner Class Reference

C-like language parser using state-based lexical scanning. More...

#include <scanner.h>

Inheritance diagram for CLanguageScanner:

Public Member Functions
virtual	~CLanguageScanner ()
void	startTranslationUnit (const char *fileName)
void	finishTranslationUnit ()
void	parseInput (const char *fileName, const char *fileBuf, Entry *root, bool sameTranslationUnit, QStrList &filesInSameTranslationUnit)
bool	needsPreprocessing (const QCString &extension)
void	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)
void	resetCodeParserState ()
void	parsePrototype (const char *text)
Public Member Functions inherited from ParserInterface
virtual	~ParserInterface ()

Detailed Description

C-like language parser using state-based lexical scanning.

This is the language parser for doxygen. It is somewhat fuzzy and supports C++ and various languages that are closely related to C++, such as C, C#, Objective-C, Java, PHP, and IDL.

Definition at line 29 of file scanner.h.

Constructor & Destructor Documentation

virtual CLanguageScanner::~CLanguageScanner ( )

inlinevirtual

Definition at line 32 of file scanner.h.

{}

Member Function Documentation

void CLanguageScanner::finishTranslationUnit ( )

virtual

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

Implements ParserInterface.

Definition at line 22538 of file scanner.cpp.

{
  bool processWithClang = insideCpp || insideObjC;
  if (processWithClang)
  {
    ClangParser::instance()->finish();
  }
}

bool CLanguageScanner::needsPreprocessing ( const QCString &  extension )

virtual

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 22584 of file scanner.cpp.

{
  QCString fe=extension.lower();
  SrcLangExt lang = getLanguageFromFileName(extension);
  return (SrcLangExt_Cpp == lang) ||
   !( fe==".java" || fe==".as"  || fe==".d"    || fe==".php" || 
      fe==".php4" || fe==".inc" || fe==".phtml" 
    );
}

void CLanguageScanner::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  )

virtual

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 22563 of file scanner.cpp.

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

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

virtual

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 22547 of file scanner.cpp.

{
  g_thisParser = this;

  printlex(scannerYY_flex_debug, TRUE, __FILE__, fileName);

  ::parseMain(fileName,fileBuf,root,
              sameTranslationUnit,filesInSameTranslationUnit);

  printlex(scannerYY_flex_debug, FALSE, __FILE__, fileName);
}

void CLanguageScanner::parsePrototype ( const char *  text )

virtual

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 22599 of file scanner.cpp.

{
  ::parsePrototype(text);
}

void CLanguageScanner::resetCodeParserState ( )

virtual

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 22594 of file scanner.cpp.

{
  ::resetCCodeParserState();
}

void CLanguageScanner::startTranslationUnit ( const char *  fileName )

virtual

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 22534 of file scanner.cpp.

{
}

---

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

• doxygen-1.8.11/src/scanner.h
• doxygen-1.8.11/build/generated_src/scanner.cpp