r266803 - Fixed a bug in AnnotatedLine::startsWith when there are comments in the line.

[Eric Liu via cfe-commits]

Author: ioeric
Date: Tue Apr 19 14:25:33 2016
New Revision: 266803

URL: http://llvm.org/viewvc/llvm-project?rev=266803&view=rev
Log:
Fixed a bug in AnnotatedLine::startsWith when there are comments in the line.

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

Reviewers: mprobst, djasper

Subscribers: ioeric, cfe-commits, klimek

Differential Revision: http://reviews.llvm.org/D19106

Modified:
    cfe/trunk/lib/Format/TokenAnnotator.h

Modified: cfe/trunk/lib/Format/TokenAnnotator.h
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/lib/Format/TokenAnnotator.h?rev=266803&r1=266802&r2=266803&view=diff
==============================================================================
--- cfe/trunk/lib/Format/TokenAnnotator.h (original)
+++ cfe/trunk/lib/Format/TokenAnnotator.h Tue Apr 19 14:25:33 2016
@@ -83,7 +83,7 @@ public:
   /// \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 @@ private:
   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 outer `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 Tok && startsWithInternal(Tok, K1) &&
+           startsWithInternal(Tok->Next, Tokens...);
   }
 };