CodeFragmentManager::Private::FragmentInfo Struct Reference

Collaboration diagram for CodeFragmentManager::Private::FragmentInfo:

Public Member Functions
	FragmentInfo ()
void	findBlockMarkers ()

Public Attributes
QCString	fileContents
QCString	fileContentsTrimLeft
OutputCodeList	recorderCodeList
std::map< int, BlockMarker >	blocks
std::map< std::string, const BlockMarker * >	blocksById
std::mutex	mutex

Detailed Description

Definition at line 41 of file codefragment.cpp.

Constructor & Destructor Documentation

FragmentInfo()

CodeFragmentManager::Private::FragmentInfo::FragmentInfo ( )

inline

Definition at line 45 of file codefragment.cpp.

{ recorderCodeList.add<OutputCodeRecorder>(); }

References recorderCodeList.

Member Function Documentation

findBlockMarkers()

void CodeFragmentManager::Private::FragmentInfo::findBlockMarkers

(

)

Definition at line 57 of file codefragment.cpp.

{
  AUTO_TRACE("findBlockMarkers() size={}",fileContents.size());
  // give fileContents and a list of candidate [XYZ] labels with/without trim left flag (from commentscan?)
  if (fileContents.length()==0) return;
 
  // find the potential snippet blocks (can also be other array like stuff in the file)
  const char *s=fileContents.data();
  int lineNr=1;
  char c=0;
  const char *foundOpen=nullptr;
  std::unordered_map<std::string,BlockMarker> candidates;
  while ((c=*s))
  {
    if (c=='[')
    {
      foundOpen=s;
    }
    else if (foundOpen && c==']' && foundOpen+1<s) // non-empty [...] section
    {
      std::string key(foundOpen+1,s-foundOpen-1);
      candidates[key].lines.push_back(lineNr);
    }
    else if (c=='\n')
    {
      foundOpen=nullptr;
      lineNr++;
    }
    s++;
  }
 
  // Sort the valid snippet blocks by line number, Look for blocks that appears twice,
  // where candidate has block id as key and the start and end line as value.
  // Store the key in marker.key
  for (auto &kv : candidates)
  {
    auto &marker = kv.second;
    if (marker.lines.size()==2 && marker.lines[0]+1<=marker.lines[1]-1)
    {
      marker.key = kv.first;
      int startLine = marker.lines[0];
      blocks[startLine] = marker;
      blocksById["["+kv.first+"]"] = &blocks[startLine];
    }
  }
 
  // determine the shared indentation for each line in each block, and store it in marker.indent
  s=fileContents.data();
  static auto gotoLine = [](const char *startBuf, const char *startPos, int startLine, int targetLine) -> const char *
  {
    char cc=0;
    if (targetLine<startLine)
    {
      //printf("gotoLine(pos=%p,start=%d,target=%d) backward\n",(void*)startPos,startLine,targetLine);
      while (startLine>=targetLine && startPos>=startBuf && (cc=*startPos--)) { if (cc=='\n') startLine--; }
      if (startPos>startBuf)
      {
        // given fragment:
        //         line1\n
        //         line2\n
        //         line3
        // and targetLine==2 then startPos ends at character '1' of line 1 before we detect that startLine<targetLine,
        // so we need to advance startPos with 2 to be at the start of line2, unless we are already at the first line.
        startPos+=2;
      }
      //printf("result=[%s]\n",qPrint(QCString(startPos).left(20)));
    }
    else
    {
      //printf("gotoLine(pos=%p,start=%d,target=%d) forward\n",(void*)startPos,startLine,targetLine);
      while (startLine<targetLine && (cc=*startPos++)) { if (cc=='\n') startLine++; }
      //printf("result=[%s]\n",qPrint(QCString(startPos).left(20)));
    }
    return startPos;
  };
  static auto lineIndent = [](const char *&ss) -> int
  {
    int tabSize=Config_getInt(TAB_SIZE);
    int col = 0;
    char cc = 0;
    while ((cc=*ss++))
    {
      if (cc==' ') col++;
      else if (cc=='\t') col+=tabSize-(col%tabSize);
      else
      {
        // goto end of the line
        while ((cc=*ss++) && cc!='\n');
        break;
      }
    }
    return col;
  };
  lineNr=1;
  const char *startBuf = s;
  for (auto &kv : blocks)
  {
    auto &marker = kv.second;
    s = gotoLine(startBuf,s,lineNr,marker.lines[0]+1);
    lineNr=marker.lines[1];
    const char *e = gotoLine(startBuf,s,marker.lines[0]+1,lineNr);
 
    const char *ss = s;
    int minIndent=100000;
    while (ss<e)
    {
      int indent = lineIndent(ss);
      if (indent<minIndent)
      {
        minIndent=indent;
        if (minIndent==0) break;
      }
    }
    marker.indent = minIndent;
 
    AUTO_TRACE_ADD("found snippet key='{}' range=[{}..{}] indent={}",
        marker.key,
        marker.lines[0]+1,
        marker.lines[1]-1,
        marker.indent);
    s=e;
  }
}

References AUTO_TRACE, AUTO_TRACE_ADD, blocks, blocksById, Config_getInt, and fileContents.

Member Data Documentation

blocks

std::map<int,BlockMarker> CodeFragmentManager::Private::FragmentInfo::blocks

Definition at line 48 of file codefragment.cpp.

Referenced by findBlockMarkers().

blocksById

std::map<std::string,const BlockMarker*> CodeFragmentManager::Private::FragmentInfo::blocksById

Definition at line 49 of file codefragment.cpp.

Referenced by findBlockMarkers().

fileContents

QCString CodeFragmentManager::Private::FragmentInfo::fileContents

Definition at line 43 of file codefragment.cpp.

Referenced by findBlockMarkers().

fileContentsTrimLeft

QCString CodeFragmentManager::Private::FragmentInfo::fileContentsTrimLeft

Definition at line 44 of file codefragment.cpp.

mutex

std::mutex CodeFragmentManager::Private::FragmentInfo::mutex

Definition at line 50 of file codefragment.cpp.

recorderCodeList

OutputCodeList CodeFragmentManager::Private::FragmentInfo::recorderCodeList

Definition at line 47 of file codefragment.cpp.

Referenced by FragmentInfo().

---

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

• src/codefragment.cpp