<div dir="ltr"><div>Hi,<br></div><div><br></div><div>> <em>Ok, this also helps, but the problem is that I need to print something when all the nodes have been matched. So, is there a way I can check within onStartOfTranslationUnit() method if we have reached the end? I have just found this:</em></div>
<div><em><br></em></div><div>onStartOfTranslationUnit() is - obviously - called at the start of each TU. I.e. this will be called after the previous TU has been completed, i.e. all nodes in it have been matched.<em><br></em></div>
<div><br></div><div>> <em>clang::ast_matchers::MatchFinder::ParsingDoneTestCallback</em></div><div><em><br></em></div><div>This is for testing purposes only, it's not recommended to use it.<em><br></em></div><div>
<br>
</div><div>> <em>So, what you are saying is that I can't control the order the nodes are matched?</em></div><div><em><br></em></div><div>No, you can't. You'll have to implement a RecursiveASTVisitor manually if you need this fine control.<em><br>
</em></div><div><br></div><div>> <em>What I'm trying to explain is that I need all the nodes bound with Matcher1 are treated before the execution of nodes bound with Matcher2 starts.</em></div><div><em><br></em></div>
<div>You can execute Matcher1 first, and when it returns, you start executing Matcher2. I'm not sure what your problem is exactly. (Of course, this will also mean that you will traverse the whole AST twice, which can potentially be very expensive.)</div>
<div><em><br></em></div><div>Gabor<em><br></em></div></div><div class="gmail_extra"><br><br><div class="gmail_quote">2013/5/8 Pedro Delgado Perez <span dir="ltr"><<a href="mailto:pedro.delgadoperez@mail.uca.es" target="_blank">pedro.delgadoperez@mail.uca.es</a>></span><br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div>
<p>Hi,</p><div class="im">
<blockquote style="border-left:2px solid #000083;margin:0pt 0pt 0pt 0.8ex;padding-left:1ex"><div>You collect information about the matches into e.g. a vector, and you can use the MatchCallback's onStartOfTranslationUnit to process the previous TU's matches.<em><br>
</em></div></blockquote></div><p>Ok, this also helps, but the problem is that I need to print something when <strong>all the nodes</strong> have been matched. So, is there a way I can check within onStartOfTranslationUnit() method if we have reached the end? I have just found this:</p>
<p>clang::ast_matchers::MatchFinder::ParsingDoneTestCallback</p>
<p>This is the implementation of the class:</p>
<p><span>class </span><a title="Called when parsing is finished. Intended for testing only." href="http://fossies.org/dox/clang-3.2.src/classclang_1_1ast__matchers_1_1MatchFinder_1_1ParsingDoneTestCallback.html" target="_blank">ParsingDoneTestCallback</a> {</p>
<div><a name="13e835036b2d5d74_l00100"></a> <span>public</span>:</div><div><a name="13e835036b2d5d74_l00101"></a><span> </span> <span>virtual</span> <a href="http://fossies.org/dox/clang-3.2.src/classclang_1_1ast__matchers_1_1MatchFinder_1_1ParsingDoneTestCallback.html#ab6018406e1835b0dcc7fa982e0836a55" target="_blank">~ParsingDoneTestCallback</a>();</div>
<div><a name="13e835036b2d5d74_l00102"></a><span> </span> <span>virtual</span> <span>void</span> <a href="http://fossies.org/dox/clang-3.2.src/classclang_1_1ast__matchers_1_1MatchFinder_1_1ParsingDoneTestCallback.html#a818b643aaad117bb86bcda80bba32ceb" target="_blank">run</a>() = 0;</div>
<div><a name="13e835036b2d5d74_l00103"></a>};</div><br>
<p>Maybe I could redefine the run method. Do you think this may be my solution?</p><div class="im">
<blockquote style="border-left:2px solid #000083;margin:0pt 0pt 0pt 0.8ex;padding-left:1ex"><div>So the matchers run regardless of whether you ever access the bound nodes. What this means is that your run() method will be called for every match, with the appropriate nodes bound to the names you defined. So a MatchResult only contains information about one single match (i.e. a subtree of the AST, if you will). Hope this clears things up.</div>
</blockquote></div><p>Um... I'm a bit mixed up at this moment. So, what you are saying is that I can't control the order the nodes are matched? For me that would be a problem because I need to keep an order in the execution. What I'm trying to explain is that I need all the nodes bound with Matcher1 are treated before the execution of nodes bound with Matcher2 starts.</p>
<p>Thanks,</p>
<p>Pedro.</p>
<div><em>El dia 07 may 2013 22:10, Gábor Kozár <<a href="mailto:kozargabor@gmail.com" target="_blank">kozargabor@gmail.com</a>> escribió:</em></div><div><div class="h5"><blockquote style="border-left:2px solid #000083;margin:0pt 0pt 0pt 0.8ex;padding-left:1ex">
<div dir="ltr"><div>Hi,</div><div>><em>1. Imagine that I need to print something after all the nodes have been matched. For example, the number of nodes matched. How can I do that? </em></div><div><em><br> </em></div>
<div>
You collect information about the matches into e.g. a vector, and you can use the MatchCallback's onStartOfTranslationUnit to process the previous TU's matches.<em><br></em></div><div>> <em>How does the 'run' method behave in this case? I mean that I don't know if it retrieves, one by one, all the nodes in applyMatch1 and ,after that, all the nodes in applyMatch2 or it matches one in applyMatch1 and then other in applyMatch2 in each iteration.</em></div>
<div><em><br></em></div><div>So the matchers run regardless of whether you ever access the bound nodes. What this means is that your run() method will be called for every match, with the appropriate nodes bound to the names you defined. So a MatchResult only contains information about one single match (i.e. a subtree of the AST, if you will). Hope this clears things up.</div>
<div>Gabor</div></div><div class="gmail_extra"><br><br><div class="gmail_quote">2013/5/7 Pedro Delgado Perez <span dir="ltr"><<a href="mailto:pedro.delgadoperez@mail.uca.es" target="_blank">pedro.delgadoperez@mail.uca.es</a>></span><br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div><p>Hi again,</p>
<p>Sorry to make so much questions, but I hope a good structure of my tool will save me a lot of time in future.</p>
<p>I'm using something like this in <a href="http://clang.llvm.org/docs/LibASTMatchersTutorial.html" target="_blank">http://clang.llvm.org/docs/LibASTMatchersTutorial.html</a>:</p>
<br>
<pre style="overflow-x:auto;overflow-y:hidden;border:thin dotted #0c3762;margin:0px 0px 12px;padding:0.8em;background-color:#f0f0f0;color:#333333"><span style="color:#007020;font-weight:bold">class</span> <span style="color:#0e84b5;font-weight:bold">LoopPrinter</span> <span style="color:#666666">:</span> <span style="color:#007020;font-weight:bold">public</span> <span>MatchFinder</span><span style="color:#666666">::</span><span>MatchCallback</span> <span>{</span><span style="color:#007020;font-weight:bold">public</span> <span style="color:#666666">:</span> <span style="color:#007020;font-weight:bold">virtual</span> <span style="color:#902000">void</span> <span>run</span><span>(</span><span style="color:#007020;font-weight:bold">const</span> <span>MatchFinder</span><span style="color:#666666">::</span><span>MatchResult</span> <span style="color:#666666">&</span><span>Result</span><span>)</span> <span>{</span> <span style="color:#007020;font-weight:bold">if</span> <span>(</span><span style="color:#007020;font-weight:bold">const</span> <span>ForStmt</span> <span style="color:#666666">*</span><span>FS</span> <span style="color:#666666">=</span> <span>Result</span><span>.</span><span>Nodes</span><span>.</span><span>getNodeAs</span><span style="color:#666666"><</span><span>clang</span><span style="color:#666666">::</span><span>ForStmt</span><span style="color:#666666">></span><span>(</span><span style="color:#4070a0">"forLoop"</span><span>))</span> <span>FS</span><span style="color:#666666">-></span><span>dump</span><span>();</span> <span>}</span><span>};</span></pre>
<br>
<p>So, now I have two questions:</p>
<p>1. Imagine that I need to print something after <strong>all</strong> the nodes have been matched. For example, the number of nodes matched. How can I do that? </p>
<p>2. Imagine that I have two methods within the run method to separate two kind of nodes I want to bind. Something like this:</p>
<br>
<br>
<pre style="color:#333333;font-size:11.818181991577148px;margin:0px 0px 12px;overflow-x:auto;overflow-y:hidden;border:thin dotted #0c3762;padding:0.8em;background-color:#f0f0f0"><span style="color:#007020;font-weight:bold"><br>
class</span> <span style="color:#0e84b5;font-weight:bold">LoopPrinter</span> <span style="color:#666666">:</span> <span style="color:#007020;font-weight:bold">public</span> <span>MatchFinder</span><span style="color:#666666">::</span><span>MatchCallback</span> <span>{</span><span style="color:#007020;font-weight:bold">public</span> <span style="color:#666666">:</span> <span style="color:#007020;font-weight:bold">virtual</span> <span style="color:#902000">void</span> <span>run</span><span>(</span><span style="color:#007020;font-weight:bold">const</span> <span>MatchFinder</span><span style="color:#666666">::</span><span>MatchResult</span> <span style="color:#666666">&</span><span>Result</span><span>)</span> <span>{</span> <span>applyMatch1();<br>
</span> applyMatch2(); <span>}<br><br></span>void <span style="color:#000000">applyMatch1(){<br> <span style="color:#007020;font-weight:bold">if</span> <span>(</span><span style="color:#007020;font-weight:bold">const</span> <span>ForStmt</span> <span style="color:#666666">*</span><span>FS</span> <span style="color:#666666">=</span> <span>Result</span><span>.</span><span>Nodes</span><span>.</span><span>getNodeAs</span><span style="color:#666666"><</span><span>clang</span><span style="color:#666666">::</span><span>ForStmt</span><span style="color:#666666">></span><span>(</span><span style="color:#4070a0">"forLoop__1"</span><span>))</span><span style="white-space:pre-wrap"><br>
</span></span>}<br><br>void apply2(){</pre><pre style="color:#333333;font-size:11.818181991577148px;margin:0px 0px 12px;overflow-x:auto;overflow-y:hidden;border:thin dotted #0c3762;padding:0.8em"><span style="color:#000000"><span style="color:#007020;font-weight:bold">if</span> <span>(</span><span style="color:#007020;font-weight:bold">const</span> <span>ForStmt</span> <span style="color:#666666">*</span><span>FS</span> <span style="color:#666666">=</span> <span>Result</span><span>.</span><span>Nodes</span><span>.</span><span>getNodeAs</span><span style="color:#666666"><</span><span>clang</span><span style="color:#666666">::</span><span>ForStmt</span><span style="color:#666666">></span><span>(</span><span style="color:#4070a0">"forLoop_2"</span><span>))</span></span></pre>
<pre style="color:#333333;font-size:11.818181991577148px;margin:0px 0px 12px;overflow-x:auto;overflow-y:hidden;border:thin dotted #0c3762;padding:0.8em;background-color:#f0f0f0">}<br><span>};</span></pre><br>
<br>
<p>How does the 'run' method behave in this case? I mean that I don't know if it retrieves, one by one, all the nodes in applyMatch1 and ,after that, all the nodes in applyMatch2 or it matches one in applyMatch1 and then other in applyMatch2 in each iteration. I hope you can understand me because this is very important in my case.</p>
<p>Thanks in advance.</p>
<p>Pedro</p>
<div><div><br><br><div><em>El dia 06 may 2013 22:32, "Vane, Edwin" <<a href="mailto:edwin.vane@intel.com" target="_blank">edwin.vane@intel.com</a>> escribió:</em></div><blockquote style="border-left:2px solid #000083;margin:0pt 0pt 0pt 0.8ex;padding-left:1ex">
<p>Given your description, I'm not sure matchers are what you want. If you just want to print information on certain types of nodes, you could use a RecursiveASTVisitor for that.</p>
<p>However, if what you're looking for is a little more complex then matchers may be what you want after all.</p>
<p>As for the two classes, you want to use tooling::MatchFinder as shown in the tutorial. The other is just an implementation detail of the match finding code.</p>
<p>newASTConsumer() is a function that's required to be defined for objects passed to newFrontendActionFactory(). You don't need to implement it. It's implemented by MatchFinder. Again, it's an implementation detail you don't need to worry about at this point.</p>
<p>The use of ASTConsumers is not necessary if you're using MatchFinder and ClangTool as described in the tutorial. MatchFinder is an abstraction around RecursiveASTVisitor so all that stuff in RecursiveASTVisitor you'd normally have to use is actually hidden away.</p>
<p>I think you should first decide which route you want to go: MatchFinder or RecursiveASTVisitor. The first question I'd ask is: how hard is it to find the nodes I want to print info on in the AST. If all I want is every for loop that's easy. If I want for loops within member functions of a specific class, that's hard and an excellent use case for ASTMatchers.</p>
<blockquote style="border-left:2px solid #000083;margin:0pt 0pt 0pt 0.8ex;padding-left:1ex"><p>-----Original Message-----<br>From: <a href="mailto:cfe-dev-bounces@cs.uiuc.edu" target="_blank">cfe-dev-bounces@cs.uiuc.edu</a> [<a href="mailto:cfe-dev-bounces@cs.uiuc.edu" target="_blank">mailto:cfe-dev-bounces@cs.uiuc.edu</a>] On<br>
Behalf Of Pedro Delgado Perez<br>Sent: Monday, May 06, 2013 12:58 PM<br>To: <a href="mailto:klimek@google.com" target="_blank">klimek@google.com</a>; <a href="mailto:kozargabor@gmail.com" target="_blank">kozargabor@gmail.com</a><br>
Cc: <a href="mailto:cfe-dev@cs.uiuc.edu" target="_blank">cfe-dev@cs.uiuc.edu</a><br>Subject: Re: [cfe-dev] ASTMatchers: isVirtual and isOverride</p>
<p>Hi,</p>
<p>I need your help again. Look, in my tool I was trying to use the syntax that's<br>shown here:</p>
<p><a href="http://clang.llvm.org/docs/LibASTMatchersTutorial.html" target="_blank">http://clang.llvm.org/docs/LibASTMatchersTutorial.html</a></p>
<p>Namely I'm referring to this part:</p>
<p>int main(int argc, const char **argv) {<br>CommonOptionsParser OptionsParser(argc, argv);<br>ClangTool Tool(OptionsParser.getCompilations(),<br>OptionsParser.getSourcePathList());</p>
<p>LoopPrinter Printer;<br>MatchFinder Finder;<br>Finder.addMatcher(LoopMatcher, &Printer);</p>
<p>return Tool.run(newFrontendActionFactory(&Finder));<br>}</p>
<p>However, now I want to create a object "Printer" with different features<br>depending on the arguments provided in command line. So I was thinking on<br>implement a factory method pattern to create a different LoopPrinter object:<br>
class OptionsFactory {<br>public:<br>LoopPrinter getOption() {<br>if(...)<br>return LoopPrinter(attribute1, attribute2);<br>else<br>return LoopPrinter(attribute1);<br>}<br>};</p>
<p>I was searching for a better solution and there are some things that I can't<br>completely understand.</p>
<p>- Why are there two classes MatchFinder:<br><a href="http://clang.llvm.org/doxygen/classclang_1_1tooling_1_1MatchFinder.html" target="_blank">http://clang.llvm.org/doxygen/classclang_1_1tooling_1_1MatchFinder.html</a><br>
<a href="http://clang.llvm.org/doxygen/classclang_1_1ast__matchers_1_1MatchFinder" target="_blank">http://clang.llvm.org/doxygen/classclang_1_1ast__matchers_1_1MatchFinder</a>.<br>html</p>
<p>- What the method in ast_matchers:MatchFinder</p>
<p>clang::ASTConsumer<br><<a href="http://clang.llvm.org/doxygen/classclang_1_1ASTConsumer.html%3E" target="_blank">http://clang.llvm.org/doxygen/classclang_1_1ASTConsumer.html></a> *</p>
<p>newASTConsumer<br><<a href="http://clang.llvm.org/doxygen/classclang_1_1ast__matchers_1_1MatchFinder" target="_blank">http://clang.llvm.org/doxygen/classclang_1_1ast__matchers_1_1MatchFinder</a><br>.html#a4807049e6e39572d19ff127406df3d81> ()</p>
<p>is used for? I see we can 'associate' an ASTConsumer to the Frontend as in:<br><a href="http://clang.llvm.org/docs/RAVFrontendAction.html" target="_blank">http://clang.llvm.org/docs/RAVFrontendAction.html</a></p>
<p>but, is this possible using Matchers? Would it have any sense to create an<br>ASTConsumer in my class OptionsFactory?</p>
<p>I have improved a lot since you last helped me, but clang is too big!</p>
<p>By the way, do you know how to use CommandLine? I posted a new thread</p>
<p><a href="http://lists.cs.uiuc.edu/pipermail/cfe-dev/2013-May/029473.html" target="_blank">http://lists.cs.uiuc.edu/pipermail/cfe-dev/2013-May/029473.html</a></p>
<p>If you know how to solve that problem, please, let me know.</p>
<p>Thanks in advance,</p>
<p>Pedro.</p>
<br>
<p>El dia 27 abr 2013 18:39, Manuel Klimek <<a href="mailto:klimek@google.com" target="_blank">klimek@google.com</a>> escribió:</p>
<p>On Sat, Apr 27, 2013 at 6:36 PM, Gábor Kozár<br><<a href="mailto:kozargabor@gmail.com" target="_blank">kozargabor@gmail.com</a>> wrote:</p>
<br>
<br>
<p>2013/4/27 Manuel Klimek <<a href="mailto:klimek@google.com" target="_blank">klimek@google.com</a>></p>
<br>
<p>Just use the empty string for binding and getNodeAs :)</p>
<br>
<p>That would potentially lead to confusion when there are more<br>nodes bound, but the programmer forgot to supply the proper name. In my<br>suggestion, the parameterless getNodeAs would have an assert to check there is<br>
exactly one node bound (and whose name is the default name).</p>
<p>If you put everything behind constants, I think it'll be easy enough to see<br>what's happening - and that's a generally good strategy anyway, as you get a<br>compile error if you mistype...<br>Thus, I think it'd not add enough value to special case the interface.</p>
<br>
<br>
<br>
<p>2013/4/27 Manuel Klimek <<a href="mailto:klimek@google.com" target="_blank">klimek@google.com</a>></p>
<br>
<p>On Sat, Apr 27, 2013 at 6:28 PM, Gábor Kozár<br><<a href="mailto:kozargabor@gmail.com" target="_blank">kozargabor@gmail.com</a>> wrote:</p>
<p>Hi,<br>2013/4/26 Pedro Delgado Perez<br><<a href="mailto:pedro.delgadoperez@mail.uca.es" target="_blank">pedro.delgadoperez@mail.uca.es</a>></p>
<br>
<p>Hehehe... I found the problem with<br>this. I was binding wrongly the matcher! I used a id in the matcher thas was<br>different from the id in the function that retrieves the nodes... I think this will be<br>a typical mistake for newbies...</p>
<p>Ah, yes, that happens a lot to me as well. Now<br>that I think about it, it might be worthwhile adding a parameterless .bind() and<br>.getNodeAs<T>() for situations where only one node is bound. Should be fairly<br>
trivial, but also not all that useful...</p>
<p>Just use the empty string for binding and getNodeAs :)</p>
<br>
<br>
<p>2013/4/26 Pedro Delgado Perez<br><<a href="mailto:pedro.delgadoperez@mail.uca.es" target="_blank">pedro.delgadoperez@mail.uca.es</a>></p>
<br>
<p>Thanks both! Now I can see all this<br>much clearer and I have the enough knowledge to start out with clang.</p>
<br>
<p>You're welcome. Good luck!</p>
<br>
<p>2013/4/25 Manuel Klimek <<a href="mailto:klimek@google.com" target="_blank">klimek@google.com</a>></p>
<br>
<p>And btw thanks a lot for all the great user support you're giving<br>here!</p>
<br>
<p>Thank you, I'm happy to help. Clang is a great project!</p>
<p>As soon as the university term is over, I'm also planning on trying to<br>contribute code-wise, mainly to the Static Analyzer but I guess also on just about<br>anything that catches my attention. :) I'm quite excited - this is going to be the<br>
first open source project I contribute to.<br>Gabor</p>
</blockquote></blockquote></div></div></div></blockquote></div><br>
</div></blockquote>
</div></div></div>
</blockquote></div><br></div>