OutputCodeRecorder Class Reference

Implementation that allows capturing calls made to the code interface to later invoke them on a OutputCodeList via replay(). More...

#include <src/outputlist.h>

Inheritance diagram for OutputCodeRecorder:

Collaboration diagram for OutputCodeRecorder:

Classes
struct	CallInfo

Public Member Functions
OutputType	type () const override
void	codify (const QCString &s) override
void	stripCodeComments (bool) override
void	startSpecialComment () override
void	endSpecialComment () override
void	setStripIndentAmount (size_t) override
std::unique_ptr< OutputCodeIntf >	clone () override
void	writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip) override
void	writeLineNumber (const QCString &ref, const QCString &file, const QCString &anchor, int lineNumber, bool writeLineAnchor) override
void	writeTooltip (const QCString &id, const DocLinkInfo &docInfo, const QCString &decl, const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo) override
void	startCodeLine (int) override
void	endCodeLine () override
void	startFontClass (const QCString &c) override
void	endFontClass () override
void	writeCodeAnchor (const QCString &name) override
void	startCodeFragment (const QCString &style) override
void	endCodeFragment (const QCString &style) override
void	startFold (int lineNr, const QCString &startMarker, const QCString &endMarker) override
void	endFold () override
void	replay (OutputCodeList &ol, int startLine, int endLine, bool showLineNumbers, bool stripComment, size_t stripIndentAmount)
Public Member Functions inherited from OutputCodeIntf
	OutputCodeIntf ()=default

Private Member Functions
void	startNewLine (int lineNr)

Private Attributes
std::vector< CallInfo >	m_calls
std::vector< size_t >	m_lineOffset
bool	m_showLineNumbers = false
bool	m_insideSpecialComment = false

Detailed Description

Implementation that allows capturing calls made to the code interface to later invoke them on a OutputCodeList via replay().

Definition at line 111 of file outputlist.h.

Member Function Documentation

clone()

std::unique_ptr< OutputCodeIntf > OutputCodeRecorder::clone ( )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 120 of file outputlist.h.

{ return std::make_unique<OutputCodeRecorder>(*this); }

codify()

void OutputCodeRecorder::codify ( const QCString & s )

overridevirtual

Implements OutputCodeIntf.

Definition at line 231 of file outputlist.cpp.

{
  m_calls.emplace_back([]() { return true; },
                       [=](OutputCodeList *ol) { ol->codify(s); },
                       m_insideSpecialComment
                      );
}

References m_calls, and m_insideSpecialComment.

endCodeFragment()

void OutputCodeRecorder::endCodeFragment ( const QCString & style )

overridevirtual

Implements OutputCodeIntf.

Definition at line 332 of file outputlist.cpp.

{
}

endCodeLine()

void OutputCodeRecorder::endCodeLine ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 296 of file outputlist.cpp.

{
  m_calls.emplace_back([](){ return true; },
                       [=](OutputCodeList *ol) { ol->endCodeLine(); },
                       m_insideSpecialComment
                      );
}

References m_calls, and m_insideSpecialComment.

endFold()

void OutputCodeRecorder::endFold ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 344 of file outputlist.cpp.

{
  m_calls.emplace_back([]() { return true; },
                       [=](OutputCodeList *ol) { ol->endFold(); },
                       m_insideSpecialComment
                      );
}

References m_calls, and m_insideSpecialComment.

endFontClass()

void OutputCodeRecorder::endFontClass ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 312 of file outputlist.cpp.

{
  m_calls.emplace_back([]() { return true; },
                       [=](OutputCodeList *ol){ ol->endFontClass(); },
                       m_insideSpecialComment
                      );
}

References m_calls, and m_insideSpecialComment.

endSpecialComment()

void OutputCodeRecorder::endSpecialComment ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 248 of file outputlist.cpp.

{
  m_calls.emplace_back([]() { return true; },
                       [=](OutputCodeList *ol) { ol->endSpecialComment(); },
                       true
                      );
  m_insideSpecialComment=false;
}

References m_calls, and m_insideSpecialComment.

replay()

void OutputCodeRecorder::replay	(	OutputCodeList &	ol,
		int	startLine,
		int	endLine,
		bool	showLineNumbers,
		bool	stripComment,
		size_t	stripIndentAmount )

Definition at line 352 of file outputlist.cpp.

{
  size_t startIndex = startLine>0 && startLine<=(int)m_lineOffset.size() ? m_lineOffset[startLine-1] : 0;
  size_t endIndex   = endLine>0   && endLine  <=(int)m_lineOffset.size() ? m_lineOffset[  endLine-1] : m_calls.size();
  //printf("startIndex=%zu endIndex=%zu\n",startIndex,endIndex);
 
  // configure run time properties of the rendering
  ol.stripCodeComments(stripCodeComments);
  ol.setStripIndentAmount(stripIndentAmount);
  m_showLineNumbers = showLineNumbers;
 
  bool insideSpecialComment = false;
  // in case the start of the special comment marker is outside of the fragment, start it here
  if (startIndex<endIndex && m_calls[startIndex].insideSpecialComment)
  {
    ol.startSpecialComment();
    insideSpecialComment = true;
  }
 
  // render the requested fragment of the pre-recorded output
  for (size_t i=startIndex; i<endIndex; i++)
  {
    if (m_calls[i].condition())
    {
      insideSpecialComment = m_calls[i].insideSpecialComment;
      m_calls[i].function(&ol);
    }
  }
 
  // if we end the fragment inside a special comment, make sure we end it,
  // and also the code line
  if (insideSpecialComment)
  {
    ol.endSpecialComment();
    ol.endCodeLine();
  }
 
  ol.stripCodeComments(false);
  ol.setStripIndentAmount(0);
}

References OutputCodeList::endCodeLine(), OutputCodeList::endSpecialComment(), m_calls, m_lineOffset, m_showLineNumbers, OutputCodeList::setStripIndentAmount(), OutputCodeList::startSpecialComment(), OutputCodeList::stripCodeComments(), and stripCodeComments().

Referenced by CodeFragmentManager::parseCodeFragment().

setStripIndentAmount()

void OutputCodeRecorder::setStripIndentAmount ( size_t )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 119 of file outputlist.h.

{}

startCodeFragment()

void OutputCodeRecorder::startCodeFragment ( const QCString & style )

overridevirtual

Implements OutputCodeIntf.

Definition at line 328 of file outputlist.cpp.

{
}

startCodeLine()

void OutputCodeRecorder::startCodeLine ( int lineNr )

overridevirtual

Implements OutputCodeIntf.

Definition at line 287 of file outputlist.cpp.

{
  startNewLine(lineNr);
  m_calls.emplace_back([](){ return true; },
                       [=](OutputCodeList *ol) { ol->startCodeLine(lineNr); },
                       m_insideSpecialComment
                      );
}

References m_calls, m_insideSpecialComment, and startNewLine().

startFold()

void OutputCodeRecorder::startFold ( int lineNr, const QCString & startMarker, const QCString & endMarker )

overridevirtual

Implements OutputCodeIntf.

Definition at line 336 of file outputlist.cpp.

{
  m_calls.emplace_back([]() { return true; },
                       [=](OutputCodeList *ol) { ol->startFold(lineNr,startMarker,endMarker); },
                       m_insideSpecialComment
                      );
}

References m_calls, and m_insideSpecialComment.

startFontClass()

void OutputCodeRecorder::startFontClass ( const QCString & c )

overridevirtual

Implements OutputCodeIntf.

Definition at line 304 of file outputlist.cpp.

{
  m_calls.emplace_back([]() { return true; },
                       [=](OutputCodeList *ol) { ol->startFontClass(c); },
                       m_insideSpecialComment
                      );
}

References m_calls, and m_insideSpecialComment.

startNewLine()

void OutputCodeRecorder::startNewLine ( int lineNr )

private

Definition at line 217 of file outputlist.cpp.

{
  int orgSize = static_cast<int>(m_lineOffset.size());
  if (orgSize<lineNr)
  {
    m_lineOffset.resize(lineNr);
    for (int i=orgSize;i<lineNr;i++) // output lines can be skipped due to hidden comments so fill in the gap
    {
      //printf("%p: startCodeLine(%d) offset=%zu\n",(void*)this,i,m_calls.size());
      m_lineOffset[i]=m_calls.size();
    }
  }
}

References m_calls, and m_lineOffset.

Referenced by startCodeLine(), and writeLineNumber().

startSpecialComment()

void OutputCodeRecorder::startSpecialComment ( )

overridevirtual

Implements OutputCodeIntf.

Definition at line 239 of file outputlist.cpp.

{
  m_insideSpecialComment=true;
  m_calls.emplace_back([]() { return true; },
                       [=](OutputCodeList *ol) { ol->startSpecialComment(); },
                       true
                      );
}

References m_calls, and m_insideSpecialComment.

stripCodeComments()

void OutputCodeRecorder::stripCodeComments ( bool )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 116 of file outputlist.h.

{}

Referenced by replay().

type()

OutputType OutputCodeRecorder::type ( ) const

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 114 of file outputlist.h.

{ return OutputType::Recorder; }

References Recorder.

Referenced by writeCodeLink().

writeCodeAnchor()

void OutputCodeRecorder::writeCodeAnchor ( const QCString & name )

overridevirtual

Implements OutputCodeIntf.

Definition at line 320 of file outputlist.cpp.

{
  m_calls.emplace_back([]() { return true; },
                       [=](OutputCodeList *ol){ ol->writeCodeAnchor(name); },
                       m_insideSpecialComment
                      );
}

References m_calls, and m_insideSpecialComment.

writeCodeLink()

void OutputCodeRecorder::writeCodeLink ( CodeSymbolType type, const QCString & ref, const QCString & file, const QCString & anchor, const QCString & name, const QCString & tooltip )

overridevirtual

Implements OutputCodeIntf.

Definition at line 257 of file outputlist.cpp.

{
  m_calls.emplace_back([](){ return true; },
                       [=](OutputCodeList *ol) { ol->writeCodeLink(type,ref,file,anchor,name,tooltip); },
                       m_insideSpecialComment
                      );
}

References m_calls, m_insideSpecialComment, and type().

writeLineNumber()

void OutputCodeRecorder::writeLineNumber ( const QCString & ref, const QCString & file, const QCString & anchor, int lineNumber, bool writeLineAnchor )

overridevirtual

Implements OutputCodeIntf.

Definition at line 268 of file outputlist.cpp.

{
  startNewLine(lineNumber);
  m_calls.emplace_back([&]() { return m_showLineNumbers; },
                       [=](OutputCodeList *ol) { ol->writeLineNumber(ref,file,anchor,lineNumber,writeLineAnchor); },
                       m_insideSpecialComment
                      );
}

References m_calls, m_insideSpecialComment, m_showLineNumbers, and startNewLine().

writeTooltip()

void OutputCodeRecorder::writeTooltip ( const QCString & id, const DocLinkInfo & docInfo, const QCString & decl, const QCString & desc, const SourceLinkInfo & defInfo, const SourceLinkInfo & declInfo )

overridevirtual

Implements OutputCodeIntf.

Definition at line 278 of file outputlist.cpp.

{
  m_calls.emplace_back([](){ return true; },
                       [=](OutputCodeList *ol) { ol->writeTooltip(id,docInfo,decl,desc,defInfo,declInfo); },
                       m_insideSpecialComment
                      );
}

References m_calls, and m_insideSpecialComment.

Member Data Documentation

m_calls

std::vector<CallInfo> OutputCodeRecorder::m_calls

private

Definition at line 152 of file outputlist.h.

Referenced by codify(), endCodeLine(), endFold(), endFontClass(), endSpecialComment(), replay(), startCodeLine(), startFold(), startFontClass(), startNewLine(), startSpecialComment(), writeCodeAnchor(), writeCodeLink(), writeLineNumber(), and writeTooltip().

m_insideSpecialComment

bool OutputCodeRecorder::m_insideSpecialComment = false

private

Definition at line 155 of file outputlist.h.

Referenced by codify(), endCodeLine(), endFold(), endFontClass(), endSpecialComment(), startCodeLine(), startFold(), startFontClass(), startSpecialComment(), writeCodeAnchor(), writeCodeLink(), writeLineNumber(), and writeTooltip().

m_lineOffset

std::vector<size_t> OutputCodeRecorder::m_lineOffset

private

Definition at line 153 of file outputlist.h.

Referenced by replay(), and startNewLine().

m_showLineNumbers

bool OutputCodeRecorder::m_showLineNumbers = false

private

Definition at line 154 of file outputlist.h.

Referenced by replay(), and writeLineNumber().

---

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

• src/outputlist.h
• src/outputlist.cpp