[PATCH] D19106: Fixed a bug in AnnotatedLine::startsWith when there are comments in the line.

[Eric Liu via cfe-commits]

ioeric created this revision.
ioeric added reviewers: djasper, mprobst.
ioeric added a subscriber: cfe-commits.
Herald added a subscriber: klimek.

When there are comments in the line, one token may be checked multiple times.

http://reviews.llvm.org/D19106

Files:
  lib/Format/TokenAnnotator.h

Index: lib/Format/TokenAnnotator.h
===================================================================
--- lib/Format/TokenAnnotator.h
+++ lib/Format/TokenAnnotator.h
@@ -83,7 +83,7 @@
   /// \c true if this line starts with the given tokens in order, ignoring
   /// comments.
   template <typename... Ts> bool startsWith(Ts... Tokens) const {
-    return startsWith(First, Tokens...);
+    return startsWithInternal(First, Tokens...);
   }
 
   /// \c true if this line looks like a function definition instead of a
@@ -124,15 +124,24 @@
   void operator=(const AnnotatedLine &) = delete;
 
   template <typename A, typename... Ts>
-  bool startsWith(FormatToken *Tok, A K1) const {
+  bool startsWithInternal(const FormatToken *Tok, A K1) const {
+    // Even though we skip comments in the outter `startWithInternal` function,
+    // this loop is still necessary if it is invoked by the public interface
+    // `startsWith`.
     while (Tok && Tok->is(tok::comment))
       Tok = Tok->Next;
     return Tok && Tok->is(K1);
   }
 
   template <typename A, typename... Ts>
-  bool startsWith(FormatToken *Tok, A K1, Ts... Tokens) const {
-    return startsWith(Tok, K1) && startsWith(Tok->Next, Tokens...);
+  bool startsWithInternal(const FormatToken *Tok, A K1, Ts... Tokens) const {
+    // Skip comments before calling `startsWithInternal(Tok, K1)` so that  the
+    // second call to `startsWithInternal` takes the correct `Tok->Next`, which
+    // should be the next token of the token checked in the first call.
+    while (Tok && Tok->is(tok::comment))
+      Tok = Tok->Next;
+    return startsWithInternal(Tok, K1) &&
+           startsWithInternal(Tok->Next, Tokens...);
   }
 };
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D19106.53689.patch
Type: text/x-patch
Size: 1698 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20160414/c501b08d/attachment.bin>