Skip to main content

The FragmentInfo Struct Reference

Declaration​

struct CodeFragmentManager::Private::FragmentInfo { ... }

Public Constructors Index​

FragmentInfo ()

Public Member Functions Index​

voidfindBlockMarkers ()

Public Member Attributes Index​

QCStringfileContents
QCStringfileContentsTrimLeft
OutputCodeListrecorderCodeList
std::map< int, BlockMarker >blocks
std::map< std::string, const BlockMarker * >blocksById
std::mutexmutex

Definition at line 41 of file codefragment.cpp.

Public Constructors​

FragmentInfo()​

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

Definition at line 45 of file codefragment.cpp.

45 FragmentInfo() { recorderCodeList.add<OutputCodeRecorder>(); }

Reference recorderCodeList.

Public Member Functions​

findBlockMarkers()​

void CodeFragmentManager::Private::FragmentInfo::findBlockMarkers ()

Definition at line 46 of file codefragment.cpp.

57void CodeFragmentManager::Private::FragmentInfo::findBlockMarkers()
58{
59 AUTO_TRACE("findBlockMarkers() size={}",fileContents.size());
60 // give fileContents and a list of candidate [XYZ] labels with/without trim left flag (from commentscan?)
61 if (fileContents.length()==0) return;
62
63 // find the potential snippet blocks (can also be other array like stuff in the file)
64 const char *s=fileContents.data();
65 int lineNr=1;
66 char c=0;
67 const char *foundOpen=nullptr;
68 std::unordered_map<std::string,BlockMarker> candidates;
69 while ((c=*s))
70 {
71 if (c=='[')
72 {
73 foundOpen=s;
74 }
75 else if (foundOpen && c==']' && foundOpen+1<s) // non-empty [...] section
76 {
77 std::string key(foundOpen+1,s-foundOpen-1);
78 candidates[key].lines.push_back(lineNr);
79 }
80 else if (c=='\n')
81 {
82 foundOpen=nullptr;
83 lineNr++;
84 }
85 s++;
86 }
87
88 // Sort the valid snippet blocks by line number, Look for blocks that appears twice,
89 // where candidate has block id as key and the start and end line as value.
90 // Store the key in marker.key
91 for (auto &kv : candidates)
92 {
93 auto &marker = kv.second;
94 if (marker.lines.size()==2 && marker.lines[0]+1<=marker.lines[1]-1)
95 {
96 marker.key = kv.first;
97 int startLine = marker.lines[0];
98 blocks[startLine] = marker;
99 blocksById["["+kv.first+"]"] = &blocks[startLine];
100 }
101 }
102
103 // determine the shared indentation for each line in each block, and store it in marker.indent
104 s=fileContents.data();
105 static auto gotoLine = [](const char *startBuf, const char *startPos, int startLine, int targetLine) -> const char *
106 {
107 char cc=0;
108 if (targetLine<startLine)
109 {
110 //printf("gotoLine(pos=%p,start=%d,target=%d) backward\n",(void*)startPos,startLine,targetLine);
111 while (startLine>=targetLine && startPos>=startBuf && (cc=*startPos--)) { if (cc=='\n') startLine--; }
112 if (startPos>startBuf)
113 {
114 // given fragment:
115 // line1\n
116 // line2\n
117 // line3
118 // and targetLine==2 then startPos ends at character '1' of line 1 before we detect that startLine<targetLine,
119 // so we need to advance startPos with 2 to be at the start of line2, unless we are already at the first line.
120 startPos+=2;
121 }
122 //printf("result=[%s]\n",qPrint(QCString(startPos).left(20)));
123 }
124 else
125 {
126 //printf("gotoLine(pos=%p,start=%d,target=%d) forward\n",(void*)startPos,startLine,targetLine);
127 while (startLine<targetLine && (cc=*startPos++)) { if (cc=='\n') startLine++; }
128 //printf("result=[%s]\n",qPrint(QCString(startPos).left(20)));
129 }
130 return startPos;
131 };
132 static auto lineIndent = [](const char *&ss, int orgCol) -> int
133 {
134 int tabSize=Config_getInt(TAB_SIZE);
135 int col = 0;
136 char cc = 0;
137 while ((cc=*ss++))
138 {
139 if (cc==' ') col++;
140 else if (cc=='\t') col+=tabSize-(col%tabSize);
141 else if (cc=='\n') return orgCol;
142 else
143 {
144 // goto end of the line
145 while ((cc=*ss++) && cc!='\n');
146 return col;
147 }
148 }
149 return orgCol;
150 };
151 lineNr=1;
152 const char *startBuf = s;
153 for (auto &kv : blocks)
154 {
155 auto &marker = kv.second;
156 s = gotoLine(startBuf,s,lineNr,marker.lines[0]+1);
157 lineNr=marker.lines[1];
158 const char *e = gotoLine(startBuf,s,marker.lines[0]+1,lineNr);
159
160 const char *ss = s;
161 int minIndent=100000;
162 int indent = minIndent;
163 while (ss<e)
164 {
165 indent = lineIndent(ss, indent);
166 if (indent<minIndent)
167 {
168 minIndent=indent;
169 if (minIndent==0) break;
170 }
171 }
172 marker.indent = minIndent;
173
174 AUTO_TRACE_ADD("found snippet key='{}' range=[{}..{}] indent={}",
175 marker.key,
176 marker.lines[0]+1,
177 marker.lines[1]-1,
178 marker.indent);
179 s=e;
180 }
181}

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

Public Member Attributes​

blocks​

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

Definition at line 48 of file codefragment.cpp.

48 std::map<int,BlockMarker> blocks;

Referenced by findBlockMarkers.

blocksById​

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

Definition at line 49 of file codefragment.cpp.

49 std::map<std::string,const BlockMarker*> blocksById;

Referenced by findBlockMarkers.

fileContents​

QCString CodeFragmentManager::Private::FragmentInfo::fileContents

Definition at line 43 of file codefragment.cpp.

43 QCString fileContents;

Referenced by findBlockMarkers.

fileContentsTrimLeft​

QCString CodeFragmentManager::Private::FragmentInfo::fileContentsTrimLeft

Definition at line 44 of file codefragment.cpp.

44 QCString fileContentsTrimLeft;

mutex​

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

Definition at line 50 of file codefragment.cpp.

50 std::mutex mutex;

recorderCodeList​

OutputCodeList CodeFragmentManager::Private::FragmentInfo::recorderCodeList

Definition at line 47 of file codefragment.cpp.

47 OutputCodeList recorderCodeList;

Referenced by FragmentInfo.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.