CCodeParser Class Reference

#include <src/code.h>

Inheritance diagram for CCodeParser:

Collaboration diagram for CCodeParser:

Classes
struct	Private

Public Member Functions
	CCodeParser ()
	~CCodeParser () override
void	parseCode (OutputCodeList &codeOutIntf, const QCString &scopeName, const QCString &input, SrcLangExt lang, bool stripCodeComments, const CodeParserOptions &options) override
	Parses a source file or fragment with the goal to produce highlighted and cross-referenced output.
void	resetCodeParserState () override
	Resets the state of the code parser.
void	setInsideCodeLine (bool inp)
bool	insideCodeLine () const

Private Attributes
std::unique_ptr< Private >	p

Detailed Description

Definition at line 29 of file code.h.

Constructor & Destructor Documentation

CCodeParser()

CCodeParser::CCodeParser

(

)

Definition at line 4053 of file code.l.

                         : p(std::make_unique<CCodeParser::Private>())
{
  codeYYlex_init_extra(&p->state,&p->yyscanner);
#ifdef FLEX_DEBUG
  codeYYset_debug(Debug::isFlagSet(Debug::Lex_code)?1:0,p->yyscanner);
#endif
  resetCodeParserState();
}

References Debug::isFlagSet(), Debug::Lex_code, and p.

~CCodeParser()

CCodeParser::~CCodeParser ( )

override

Definition at line 4062 of file code.l.

{
  codeYYlex_destroy(p->yyscanner);
}

References p.

Member Function Documentation

insideCodeLine()

bool CCodeParser::insideCodeLine

(

)

const

Definition at line 4085 of file code.l.

{
  struct yyguts_t *yyg = (struct yyguts_t*)p->yyscanner;
  return yyextra->insideCodeLine;
}

References p.

parseCode()

void CCodeParser::parseCode ( OutputCodeList & codeOutList, const QCString & scopeName, const QCString & input, SrcLangExt lang, bool stripCodeComments, const CodeParserOptions & options )

overridevirtual

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

Parameters

[in]	codeOutList	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]	stripCodeComments	signals whether or not for the code block the doxygen comments should be stripped.
[in]	options	Additional options to configure the parser.

Implements CodeParserInterface.

Definition at line 4091 of file code.l.

{
  yyscan_t yyscanner = p->yyscanner;
  struct yyguts_t *yyg = (struct yyguts_t*)yyscanner;
  DBG_CTX((stderr,"***parseCode() exBlock=%d exName=%s fd=%p scopeName=%s searchCtx=%s\n",
           options.isExample(),qPrint(options.exampleName()),(void*)options.fileDef(),
           qPrint(scopeName),options.searchCtx()?qPrint(options.searchCtx()->name()):"<none>"));
 
  if (s.isEmpty()) return;
 
  DebugLex debugLex(Debug::Lex_code, __FILE__, options.fileDef() ? qPrint(options.fileDef()->fileName()) :
                 !options.exampleName().isEmpty() ? qPrint(options.exampleName()) : nullptr);
 
  od.stripCodeComments(stripCodeComments);
  yyextra->code = &od;
  yyextra->inputString   = s.data();
  yyextra->fileName      = options.fileDef() ? options.fileDef()->fileName():"";
  yyextra->absFileName   = options.fileDef() ? options.fileDef()->absFilePath():"";
  yyextra->inputPosition = 0;
  codeYYrestart(nullptr,yyscanner);
  yyextra->currentFontClass = nullptr;
  yyextra->searchCtx = options.searchCtx();
  yyextra->collectXRefs = options.collectXRefs();
  yyextra->inFunctionTryBlock = FALSE;
  yyextra->symbolResolver.setFileScope(options.fileDef());
  yyextra->foldStack.clear();
  yyextra->insideSpecialComment = false;
  yyextra->yyLineNr    = options.startLine()!=-1 ? options.startLine() : 1;
  yyextra->inputLines  = options.endLine()!=-1   ? options.endLine()+1 : yyextra->yyLineNr + countLines(yyscanner) - 1;
  yyextra->curlyCount    = 0;
  yyextra->bodyCurlyCount = 0;
  yyextra->bracketCount  = 0;
  yyextra->sharpCount    = 0;
  yyextra->insideTemplate = FALSE;
  yyextra->theCallContext.clear();
  while (!yyextra->scopeStack.empty()) yyextra->scopeStack.pop();
  yyextra->scopeName     = scopeName;
  DBG_CTX((stderr,"parseCCode %s\n",qPrint(scopeName)));
  yyextra->exampleBlock  = options.isExample();
  yyextra->exampleName   = options.exampleName();
  yyextra->sourceFileDef = options.fileDef();
  yyextra->lineNumbers   = options.fileDef() && options.showLineNumbers();
  if (options.fileDef()==nullptr)
  {
    // create a dummy filedef for the example
    yyextra->exampleFileDef = createFileDef(QCString(),(!options.exampleName().isEmpty()?options.exampleName():"generated"));
    yyextra->sourceFileDef  = yyextra->exampleFileDef.get();
  }
  yyextra->lang        = lang;
  yyextra->insideObjC  = lang==SrcLangExt::ObjC;
  if (yyextra->sourceFileDef)
  {
    setCurrentDoc(yyscanner,"l00001");
  }
  yyextra->currentDefinition = options.searchCtx() ? options.searchCtx() : getResolvedNamespace(scopeName);
  yyextra->currentMemberDef = nullptr;
  yyextra->searchingForBody = options.isExample();
  yyextra->insideBody = FALSE;
  yyextra->bracketCount = 0;
  if (!yyextra->exampleName.isEmpty())
  {
    yyextra->exampleFile = convertNameToFile(yyextra->exampleName+"-example",FALSE,TRUE);
    DBG_CTX((stderr,"yyextra->exampleFile=%s\n",qPrint(yyextra->exampleFile)));
  }
  yyextra->includeCodeFragment = options.inlineFragment();
  DBG_CTX((stderr,"** exBlock=%d exName=%s include=%d\n",options.isExample(),qPrint(options.exampleName()),options.inlineFragment()));
  if (!yyextra->insideCodeLine)
  {
    startCodeLine(yyscanner);
  }
  yyextra->type.clear();
  yyextra->name.clear();
  yyextra->args.clear();
  yyextra->parmName.clear();
  yyextra->parmType.clear();
  if (options.memberDef()) setParameterList(yyscanner,options.memberDef());
  BEGIN( Body );
  codeYYlex(yyscanner);
  yyextra->lexInit=TRUE;
  if (yyextra->insideCodeLine)
  {
    endCodeLine(yyscanner);
  }
  if (Config_getBool(HTML_CODE_FOLDING))
  {
    while (!yyextra->foldStack.empty())
    {
      yyextra->code->endFold();
      yyextra->foldStack.pop_back();
    }
  }
  if (yyextra->exampleFileDef)
  {
    // delete the temporary file definition used for this example
    yyextra->exampleFileDef.reset();
    yyextra->sourceFileDef=nullptr;
  }
  // write the tooltips
  yyextra->tooltipManager.writeTooltips(od);
}

References FileDef::absFilePath(), CodeParserOptions::collectXRefs(), Config_getBool, convertNameToFile(), countLines(), createFileDef(), QCString::data(), DBG_CTX, endCodeLine(), CodeParserOptions::endLine(), CodeParserOptions::exampleName(), FALSE, CodeParserOptions::fileDef(), FileDef::fileName(), getResolvedNamespace(), CodeParserOptions::inlineFragment(), QCString::isEmpty(), CodeParserOptions::isExample(), Debug::Lex_code, CodeParserOptions::memberDef(), Definition::name(), p, qPrint(), CodeParserOptions::searchCtx(), setCurrentDoc(), setParameterList(), CodeParserOptions::showLineNumbers(), startCodeLine(), CodeParserOptions::startLine(), OutputCodeList::stripCodeComments(), and TRUE.

resetCodeParserState()

void CCodeParser::resetCodeParserState ( )

overridevirtual

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 CodeParserInterface.

Definition at line 4067 of file code.l.

{
  struct yyguts_t *yyg = (struct yyguts_t*)p->yyscanner;
  DBG_CTX((stderr,"***CodeParser::reset()\n"));
  yyextra->theVarContext.clear();
  while (!yyextra->scopeNameLengthStack.empty()) yyextra->scopeNameLengthStack.pop_back();
  yyextra->codeClassMap.clear();
  yyextra->curClassBases.clear();
  yyextra->anchorCount = 0;
  yyextra->insideCodeLine = false;
}

References p.

setInsideCodeLine()

void CCodeParser::setInsideCodeLine

(

bool

inp

)

Definition at line 4079 of file code.l.

{
  struct yyguts_t *yyg = (struct yyguts_t*)p->yyscanner;
  yyextra->insideCodeLine = inp;
}

References p.

Member Data Documentation

p

std::unique_ptr<Private> CCodeParser::p

private

Definition at line 47 of file code.h.

Referenced by CCodeParser(), insideCodeLine(), parseCode(), resetCodeParserState(), setInsideCodeLine(), and ~CCodeParser().

---

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

• src/code.h
• src/code.l