TclLanguageScanner Class Reference

Tcl language parser using state-based lexical scanning. More...

#include <tclscanner.h>

Inheritance diagram for TclLanguageScanner:

Public Member Functions
virtual	~TclLanguageScanner ()
void	startTranslationUnit (const char *)
void	finishTranslationUnit ()
void	parseInput (const char *fileName, const char *fileBuf, Entry *root, bool sameTranslationUnit, QStrList &filesInSameTranslationUnit)
	Parse text file and build up entry tree. More...
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)
	Parse file and codify. More...
void	resetCodeParserState ()
void	parsePrototype (const char *text)
Public Member Functions inherited from ParserInterface
virtual	~ParserInterface ()

Detailed Description

Tcl language parser using state-based lexical scanning.

This is the Tcl language parser for doxygen.

Definition at line 28 of file tclscanner.h.

Constructor & Destructor Documentation

virtual TclLanguageScanner::~TclLanguageScanner ( )

inlinevirtual

Definition at line 31 of file tclscanner.h.

{}

Member Function Documentation

void TclLanguageScanner::finishTranslationUnit ( )

inlinevirtual

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

Implements ParserInterface.

Definition at line 33 of file tclscanner.h.

{}

bool TclLanguageScanner::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 5353 of file tclscanner.cpp.

{
  (void)extension;
  return FALSE;
}

void TclLanguageScanner::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

Parse file and codify.

Implements ParserInterface.

Definition at line 5250 of file tclscanner.cpp.

{
  (void)scopeName;
  (void)lang;
  (void)exampleName;
  (void)fileDef;
  (void)endLine;
  (void)inlineFragment;
  (void)searchCtx;
  (void)collectXRefs;

  if (input.length()<1) return;
  printlex(tclscannerYY_flex_debug, TRUE, __FILE__, fileDef ? fileDef->fileName().data(): NULL);
  tcl.input_string = input;

  QCString myNs="";
  QCString myCls="";
  if (memberDef)
  {
    if (memberDef->getClassDef())
    {
      myCls = memberDef->getClassDef()->displayName();
      myNs = myCls;
    }
    else if (memberDef->getNamespaceDef())
    {
      myNs = memberDef->getNamespaceDef()->displayName();
    }
  }

  QString myStr="Codifying..";
  if (scopeName)
  {
    myStr +=" scope=";
    myStr+=scopeName;
  }
  if (exampleName)
  {
    myStr+=" example=";
    myStr+=exampleName;
  }
  if (memberDef)
  {
    myStr+=" member=";
    myStr+=memberDef->memberTypeName();
    myStr+=" ";
    myStr+=memberDef->qualifiedName();
  }
  if (fileDef)
  {
    myStr+=" file=";
    myStr+=fileDef->fileName();
  }
tcl_inf("%s (%d,%d) %d %d\n",myStr.ascii(),startLine,endLine,isExampleBlock,inlineFragment);
//tcl_inf("%s\n"input.data());
  if (isExampleBlock)
  {
    tcl_codify(NULL,input);
    return;
  }
  tcl_init();
  tcl.collectXRefs = collectXRefs;
  tcl.memberdef = memberDef;
  tcl.code = &codeOutIntf;
  if (startLine<0) 
  {
    startLine=1;
  }
  tclscannerYYlineno=startLine;
  tcl.code_linenumbers = showLineNumbers;
  tcl.code_line=tclscannerYYlineno;
  tcl.code->startCodeLine(tcl.code_linenumbers);
  if (tcl.code_linenumbers) 
  {
    tcl.code->writeLineNumber(0,0,0,tcl.code_line);
  }
  tcl.file_name = "";
  tcl.this_parser = NULL;
  tcl.entry_main = tcl_entry_new();
  tcl_parse(myNs,myCls);
  tcl.code->endCodeLine();
  tcl.scan.clear();
  tcl.ns.clear();
  tcl.cl.clear();
  tcl.fn.clear();
  tcl.entry.clear();
  printlex(tclscannerYY_flex_debug, FALSE, __FILE__, fileDef ? fileDef->fileName().data(): NULL);
}

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

virtual

Parse text file and build up entry tree.

Implements ParserInterface.

Definition at line 5218 of file tclscanner.cpp.

{
  QFile            myFile;
tcl_inf("%s\n",fileName);
  myFile.setName(fileName);
  if (!myFile.open(IO_ReadOnly)) return;
  if (strlen(input)<1) return;

  tcl.input_string = input;
  if (tcl.input_string.length()<1) return;
  printlex(tclscannerYY_flex_debug, TRUE, __FILE__, fileName);

  msg("Parsing %s...\n",fileName);
  groupEnterFile(fileName,tclscannerYYlineno);

  tcl_init();
  tcl.code = NULL;
  tcl.file_name = fileName;
  tcl.this_parser = this;
  tcl.entry_main          = root; /* toplevel entry */
  tcl_parse("","");
  groupLeaveFile(tcl.file_name,tclscannerYYlineno);
  root->program.resize(0);
  myFile.close();
  printlex(tclscannerYY_flex_debug, FALSE, __FILE__, fileName);
}

void TclLanguageScanner::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 5363 of file tclscanner.cpp.

{
  (void)text;
}

void TclLanguageScanner::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 5359 of file tclscanner.cpp.

{
}

void TclLanguageScanner::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 32 of file tclscanner.h.

{}

---

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

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